Fixes #38084 - Add new REX job templates for bootc upgrade/switch/rollback #11256

lfu · 2024-12-12T15:15:28Z

What are the changes introduced in this pull request?

New REX feature katello_bootc_upgrade
New REX feature katello_bootc_switch
New REX feature katello_bootc_rollback
New REX feature katello_bootc_status

Considerations taken when implementing this change?

What are the testing steps for this pull request?

To import the new job template:

# in Rails console
ForemanInternal.all.first.delete

Then run

bundle exec rails db:seed

In Hosts > Tempaltes > Job Templates, you'll see new added templates.
Select one of the new bootc job templates and run it.

ianballou

I got the following error when trying the Bootc status template:

2024-12-12T19:16:51 [E|bac|db1af636] Failed rendering template: error during rendering: ERF90-0026 [TemplateInput::UnsatisfiedRequiredInput]: Value for required input 'target' was not specified (RuntimeError)

Edit: same thing for the Bootc rollback command.

ianballou · 2024-12-12T19:22:52Z

app/views/foreman/job_templates/bootc_action.erb

+  required: true
+%>
+
+bootc <%= input('action') %> <%= input('options') %> <%= input('target') %>


When I selected the bootc rollback command, I noticed that target was still marked as a required option, even though bootc rollback takes no arguments.

The same goes for bootc upgrade. In fact, switch is the only action that has a required target.

Looks like this is only an issue for the top-level action that has a dropdown with the action you pick.

Edit: I verified that I also get the "no target" error for the upgrade task.

adamruzicka · 2024-12-13T10:20:35Z

app/views/foreman/job_templates/bootc_action.erb

+job_category: Katello
+description_format: 'bootc %{action} %{options}'
+provider_type: script
+template_inputs:


A sort of common thing is to include an option to reboot the machine once the action is done, maybe that could be used here as well https://github.com/theforeman/foreman_leapp/blob/master/app/views/foreman_leapp/job_templates/leapp_upgrade.erb#L16 ?

Thanks for your review and the comment @adamruzicka.

From bootc document:

However, in the future this is likely to change such that reboots outside of a `bootc upgrade --apply` do *not* automatically apply the update in addition.

With that information, maybe we just allow users decide if a reboot is necessary with --apply option. What is your opinion, @ianballou?

@lfu I'm asking around about if there is more information about that change. I do like the reboot strategy that Adam mentioned, it seems pretty straight-forward. I'll update here when I hear more from the bootc team.

The future of this command is still a bit unclear, so I think we can leave the scripts as-is and update them as bootc changes in the future.

ianballou

The actions are working a lot better now!

I did notice that the target input is available still for the bootc rollback command on the main bootc action template, but I suspect there isn't much we can do there since it's a global page.

Just one comment:

ianballou · 2024-12-13T16:38:05Z

lib/katello/plugin.rb

@@ -696,6 +696,9 @@ def katello_template_setting_values(name)
  RemoteExecutionFeature.register(:katello_module_stream_action, N_("Katello: Module Stream Actions"),
                                  :description => N_("Perform a module stream action via Katello interface"),
                                  :provided_inputs => ['action', 'module_spec', 'options'])
+  RemoteExecutionFeature.register(:katello_bootc_upgrade, N_("Katello: Bootc Upgrade"), :description => N_("Bootc upgrade via Katello interface"), :provided_inputs => ['options'])
+  RemoteExecutionFeature.register(:katello_bootc_switch, N_("Katello: Bootc Switch"), :description => N_("Bootc switch via Katello interface"), :provided_inputs => ['options,target'])
+  RemoteExecutionFeature.register(:katello_bootc_rollback, N_("Katello: Bootc Rollback"), :description => N_("Bootc rollback via Katello interface"), :provided_inputs => [])


Do we need one for Bootc status too?

ianballou · 2024-12-16T16:20:15Z

Looks like the DB seeder broke in the latest test run

lfu · 2024-12-16T16:59:42Z

Local db:seed worked fine. Is there a way to check on the PR environment?

ianballou · 2024-12-16T19:04:28Z

Local db:seed worked fine. Is there a way to check on the PR environment?

One thing worth checking might be a fresh environment, I wonder if one of the newer changes broke something but it only shows up if the templates aren't already present.

ianballou

I'm not sure what changed, but the action is now below the options input:

ianballou

I wonder if it makes sense to throw a subscription-manager facts --update at the end of the commands. It won't help of course if a reboot happens, but for most other cases it would trigger the UI to show the new status.

ianballou · 2024-12-18T17:45:21Z

Besides my two comments above, everything seems to be working great!

lfu · 2024-12-18T18:00:24Z

Mine looks just fine. Could you check other templates? Like Package action.

ianballou · 2024-12-18T21:55:46Z

Strangely, the old Katello / Bootc action has the inputs in the right order, it's only the new Bootc / Bootc action that has the order wrong. I don't see what could be causing it, so maybe it's just an issue on my box?

ianballou · 2024-12-18T22:35:50Z

This is looking good to me, although I want to double check that the action / options ordering isn't reproducible. Perhaps it's worth installing to a production machine via the packit RPM and double checking.

ianballou · 2024-12-18T22:40:35Z

app/views/foreman/job_templates/bootc_action.erb

+name: Bootc Action - Script Default
+model: JobTemplate
+job_category: Bootc
+description_format: 'bootc %{action} %{options}'


Suggested change

description_format: 'bootc %{action} %{options}'

description_format: 'bootc %{action} %{target} %{options}'

ianballou · 2024-12-18T22:42:35Z

Took a closer look -- I can't tell why the arguments would be out of order just based on the templates here.

…lback

lfu · 2024-12-19T16:11:47Z

I spinned up a new devel box where it is still looking good.

ianballou

Looking good to me now!

ianballou · 2024-12-19T18:32:27Z

Failing tests are indeed unrelated.

pr-processor bot added the Not yet reviewed label Dec 12, 2024

ianballou reviewed Dec 12, 2024

View reviewed changes

pr-processor bot removed the Not yet reviewed label Dec 12, 2024

ianballou reviewed Dec 12, 2024

View reviewed changes

lfu force-pushed the 28995_job_templates_bootc branch 2 times, most recently from dbdc89e to 6cf6b9a Compare December 12, 2024 21:02

adamruzicka reviewed Dec 13, 2024

View reviewed changes

ianballou reviewed Dec 13, 2024

View reviewed changes

lfu force-pushed the 28995_job_templates_bootc branch from 6cf6b9a to 7de8ce8 Compare December 16, 2024 14:39

lfu force-pushed the 28995_job_templates_bootc branch 10 times, most recently from df83381 to 9901f1d Compare December 17, 2024 22:11

ianballou reviewed Dec 18, 2024

View reviewed changes

lfu force-pushed the 28995_job_templates_bootc branch from 9901f1d to 7d322c0 Compare December 18, 2024 18:02

ianballou reviewed Dec 18, 2024

View reviewed changes

Fixes #38084 - Add new REX job templates for bootc upgrade/switch/rol…

3c7ae1f

…lback

lfu force-pushed the 28995_job_templates_bootc branch from 7d322c0 to 3c7ae1f Compare December 19, 2024 15:55

ianballou approved these changes Dec 19, 2024

View reviewed changes

lfu merged commit 916e702 into Katello:master Dec 19, 2024
24 of 26 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #38084 - Add new REX job templates for bootc upgrade/switch/rollback #11256

Fixes #38084 - Add new REX job templates for bootc upgrade/switch/rollback #11256

lfu commented Dec 12, 2024 •

edited

Loading

ianballou left a comment •

edited

Loading

ianballou Dec 12, 2024

ianballou Dec 12, 2024

ianballou Dec 12, 2024

ianballou Dec 12, 2024

adamruzicka Dec 13, 2024

lfu Dec 13, 2024 •

edited

Loading

ianballou Dec 13, 2024

ianballou Dec 18, 2024

ianballou left a comment

ianballou Dec 13, 2024

ianballou commented Dec 16, 2024

lfu commented Dec 16, 2024

ianballou commented Dec 16, 2024

ianballou left a comment

ianballou left a comment

ianballou commented Dec 18, 2024

lfu commented Dec 18, 2024

ianballou commented Dec 18, 2024

ianballou commented Dec 18, 2024

ianballou Dec 18, 2024

ianballou commented Dec 18, 2024

lfu commented Dec 19, 2024

ianballou left a comment

ianballou commented Dec 19, 2024

	description_format: 'bootc %{action} %{options}'
	description_format: 'bootc %{action} %{target} %{options}'

Fixes #38084 - Add new REX job templates for bootc upgrade/switch/rollback #11256

Fixes #38084 - Add new REX job templates for bootc upgrade/switch/rollback #11256

Conversation

lfu commented Dec 12, 2024 • edited Loading

What are the changes introduced in this pull request?

Considerations taken when implementing this change?

What are the testing steps for this pull request?

ianballou left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lfu Dec 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ianballou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ianballou commented Dec 16, 2024

lfu commented Dec 16, 2024

ianballou commented Dec 16, 2024

ianballou left a comment

Choose a reason for hiding this comment

ianballou left a comment

Choose a reason for hiding this comment

ianballou commented Dec 18, 2024

lfu commented Dec 18, 2024

ianballou commented Dec 18, 2024

ianballou commented Dec 18, 2024

Choose a reason for hiding this comment

ianballou commented Dec 18, 2024

lfu commented Dec 19, 2024

ianballou left a comment

Choose a reason for hiding this comment

ianballou commented Dec 19, 2024

lfu commented Dec 12, 2024 •

edited

Loading

ianballou left a comment •

edited

Loading

lfu Dec 13, 2024 •

edited

Loading