manifest: override insights-client-boot.service (HMS-4827)

[loadtheaccumulator]

Enable insights client.service to collect at boot to fix issue with rpm-ostree updates not being collected and reported via insights client at reboot.

Fixes: HMS: 4827

[achilleas-k]

Thanks! This LGTM but there's a couple of small issues below.

[loadtheaccumulator]

@achilleas-k It looks like the service override file is written on condition of serviceOptions.InsightsOnBoot being true in subscription.go. I'm not sure the preferred way to pull that check in here so it only writes to the kickstart. Could also just write a bash check in the kickstart to check for the service, but the check is cleaner.

images/pkg/manifest/subscription.go

Lines 125 to 131 in e8310ec

	if insightsOnBoot {
	icDir, icFile, err := runInsightsClientOnBoot()
	if err != nil {
	return nil, nil, nil, nil, err
	}
	dirs = append(dirs, icDir)
	files = append(files, icFile)

[thozza]

Wouldn't it make more sense to conditionally add Wants=insights-client.service if insightsOnBoot with the proper ordering, to the osbuild-subscription-register.service unit

images/pkg/manifest/subscription.go

Line 163 in e8310ec

Wants: []string{"network-online.target"},

?

[loadtheaccumulator]

Wouldn't it make more sense to conditionally add Wants=insights-client.service if insightsOnBoot with the proper ordering, to the osbuild-subscription-register.service unit

I tried this out with an override and the insights client does run at boot even when the ConditionPathExists condition is false, but execution at first boot errors. I haven't chased the root cause down yet, but assuming it's because it's running before registration and needs to be added to the After in the insights client service. I haven't tested it, but with the After, I would expect collection to happen twice on first boot. Once with the Wants and once with the registration.

The insights-client.service status does reflect it is disabled, so wondering if it running could cause confusion. Disabling will require overriding the Wants in the register unit or removing the insights client override file.

[loadtheaccumulator]

The registration service needs to be added to the insights-client After directive anyway. I added an if insights-client override file exists conditional to the kickstart post and everything worked as expected.

[thozza]

@loadtheaccumulator Wants= just ensures the unit is pulled into the transaction, and After= ensures the proper order. Even if multiple units Wants the same unit, it is still started only once at boot.

[thozza]

Could you describe the problem and the expected behavior in more detail? The solution seems too messy to me. Since our code creates the override drop-in and the registration unit, I have difficulty understanding why this can't be solved in the units themselves. Adding a %post script to the KS to enable the unit does not look ideal.

[loadtheaccumulator]

Hey @thozza .For Edge OS upgrades to reflect in Insights, they have to collect at boot. Insights normally collects periodically, so insights-client.service handles the collection at boot. The kickstart file was originally injected into the ISO by Edge API three years or so ago, and we both configured and enabled the service there because we didn't have access to the ostree image at that time. When we moved that functionality to Image Builder last year, the service was configured, but wasn't enabled.

For me, the problem with the Wants is that it doesn't reflect the actual status of the service, and the registration service is designed for first boot. Maybe we just need to document it in the override.conf file, but if collection errors on boot at some point, my first step is to check the service. It will reflect disabled even though it runs via the Wants in another service.

The first boot registration service is also enabled via the kickstart.

EDIT: another issue is around disabling the insights-client service, due to ostree being immutable, requires either deleting/renaming the override.conf file or overriding the registration service Wants.

[loadtheaccumulator]

I just ran across an insights-client-boot.service that is enabled by default. Testing overriding it now instead of insights-client.service.

[loadtheaccumulator]

Overriding insights-client-boot.service works, and I updated this PR to reflect the change.

• service is already enabled by default (so no need for additional enable step in ks file or other)
• runs and collects at every boot

[loadtheaccumulator]

I updated the title and description accordingly.