1. Manuals
  2. Leap-15.6
  3. scc-hypervisor-collector
  4. scc-hypervisor-collector.service(8)

Scroll to navigation

scc-hypervisor-collector.service(8) scc-hypervisor-collector systemd integration scc-hypervisor-collector.service(8)

NAME

scc-hypervisor-collector.service, scc-hypervisor-collector.timer - systemd(1) integration for scc-hypervisor-collector(1)

SYNOPSIS

scc-hypervisor-collector.service

scc-hypervisor-collector.timer

DESCRIPTION

The scc-hypervisor-collector.service systemd(1) unit will run the scc-hypervisor-collector(1) command as the scchvc user (see below) when triggered, if a valid configuration has been specified in the /var/lib/scchvc/.config/scc-hypervisor-collector.

The scc-hypervisor-collector.timer systemd(1) unit, once enabled, will trigger the scc-hypervisor-collector.service on a daily basis, randomly skewed by up to 15 minutes.

RESTRICTED SERVICE ACCOUNT

Installation of the scc-hypervisor-collector package automatically creates the scchvc user as a restricted service account, if it doesn't already exist, with a home directory of /var/lib/scchvc.

CONFIGURATION

To take advantage of the scc-hypervisor-collector.service, a valid set of configuration settings must be created under the /var/lib/scchvc/.config/scc-hypervisor-collector directory, as documented in scc-hypervisor-collector(5).

Run scc-hypervisor-collector --check as the scchvc user to validate that the settings are correct.

Ensure that the scc-hypervisor-collector.timer is enabled.

TLS/SSL CERTIFICATES

The virtual-host-gatherer(1) framework only supports certs that are registered with the system certificate stores. See update-ca-certificates(8) for details.

SSH KEYS

For any Libvirt hypervisors that are specified with a qemu+ssh type URI, appropriate SSH keys that support passwordless SSH access to the target hypervisor node, must be available in the /var/lib/scchvc/.ssh/ directory.

See ssh-keygen(1) for more details on how to generate appropriate SSH keys if needed, and ssh(1) for the appropriate permissions for the /var/lib/scchvc/.ssh/ directory and any keys stored there.

CUSTOMIZATION

The systemctl edit mechanism can be used to customize either of the scc-hypervisor-collector.service and scc-hypervisor-collector.timer units.

CHANGING WHICH USER THE SERVICE RUNS AS

To change the user that the scc-hypervisor-collector.service runs the scc-hypervisor-collector(1) command as from the scchvc user to someuser (with group membership somegroup), create a drop-in snippet with the following content:

[Service]
User=someuser
Group=somegroup

CHANGING WHEN THE TIMER TRIGGERS

To change the timer trigger from a daily cadence to a weekly cadence, with a randomised skew of up to 6 hours rather than 15 minutes, create a drop-in snippet with the following content:

[Timer]
OnCalendar=weekly
RandomizedDelaySec=6h

FILES AND DIRECTORIES

/var/lib/scchvc/.config/scc-hypervisor-collector/
Configuration directory that the scc-hypervisor-collector.service(8) checks for configuration settings. Directory and files must be owned by, and only accessible by, the scchvc user.
/var/lib/scchvc/scc-hypervisor-collector.log
The log file used by the scc-hypervisor-collector.service(8). Log files must be owned by, and only accessible by, the scchvc user. Will be created with appropriate permissions if no log file exists.
/var/lib/scchvc/.ssh/ (optional)
Directory holding any SSH keys (ssh-keygen) needed to access Libvirt with qemu+ssh URIs.

AUTHORS

Originally developed by Fergal Mc Carthy (fmccarthy@suse.com) and Meera Belur (mbelur@suse.com) for the SCC at SUSE LLC (scc-feedback@suse.de)

LINKS

SUSE Customer Center: https://scc.suse.com

scc-hypervisor-collector on GitHub: https://github.com/SUSE/scc-hypervisor-collector

virtual-host-gatherer on GitHub: https://github.com/uyuni-project/virtual-host-gatherer

SEE ALSO

scc-hypervisor-collector(1), scc-hypervisor-collector(5), systemd(1), ssh(1), ssh-keygen(1)

June 2022