Fixes #38109 - As a user, I want to install flatpaks on remote hosts via REX #11264

sjha4 · 2024-12-17T14:33:17Z

What are the changes introduced in this pull request?

Adds a new job template to setup flatpak remote, authentication and possibly install a flatpak repo on a host

Considerations taken when implementing this change?

We are not installing flatpak/podman. Admin/Client will need to do that on their own.
This will need to be run with sudo or as root on the host

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

Run the job template on a host.
Monitor the execution output and make sure you are able to see the flatpak installation on the host.

jeremylenz

Thanks @sjha4

I did not test this yet, but left some annoying nitpicks etc. below. Sorry!

jeremylenz · 2024-12-19T18:59:04Z

app/views/foreman/job_templates/flatpak_setup.erb

@@ -0,0 +1,37 @@
+<%#
+kind: job_template
+name: Install Flatpak and Firefox


I'm assuming you're changing this so it's an input and not hard-coded to Firefox, right? Why have a template specifically for Firefox?

No..This was bait for you to take a look and drive the PR from here on.. <3

You know how to trick me!

jeremylenz · 2024-12-19T18:59:25Z

app/views/foreman/job_templates/flatpak_setup.erb

+kind: job_template
+name: Install Flatpak and Firefox
+job_category: Katello
+description_format: 'Install Flatpak and Firefox'


description_format can use wildcards and incorporate the input.

jeremylenz · 2024-12-19T19:00:16Z

app/views/foreman/job_templates/flatpak_setup.erb

+- name: Password
+  description: Password for container registry login


This is where we're meant to use the personal auth token, right? Maybe the input or description should call that out.

jeremylenz · 2024-12-19T19:02:29Z

app/views/foreman/job_templates/flatpak_setup.erb

+flatpak remote-add --authenticator-name=org.flatpak.Authenticator.Oci <%= remote_name %> oci+<%= server_url %>/
+podman login <%= server_url %> --username <%= username %> --password <%= password %>
+cp /run/containers/0/auth.json /etc/flatpak/oci-auth.json
+flatpak install firefox --assumeyes


The actual install could probably be split into a second template, and then called here with render_template. Then you could do flatpak installs separately assuming your installations and logins are already in place.

jeremylenz · 2024-12-19T19:03:40Z

app/views/foreman/job_templates/flatpak_setup.erb

+name: Install Flatpak and Firefox
+job_category: Katello
+description_format: 'Install Flatpak and Firefox'
+feature: katello_host_flatpak_install


If you're introducing a new REX feature, you'll have to register the feature (in plugin.rb I think?)

You don't have to use a feature, if you don't need easy access from Hammer or web UI..

sjha4 · 2024-12-20T19:31:53Z

@jeremylenz Thanks for the reviews..Working on them. This is kind of an early draft to make sure the flow makes sense..I'll split this into 2 templates : 1 for remote-add/authentication and another for the flatpak install.

app/views/foreman/job_templates/flatpak_install.erb

jeremylenz

On second thought, I think it actually is a good idea to introduce and register new REX Features. The reason is that it makes it much easier to invoke REX jobs from the web UI. (sorry, I don't think I remembered this fully before)

Per the job_invocations API docs, in order to invoke a new REX job via API you need to either send the feature name, or the job template ID. Job template ID will be different for every database, so if we ever want to invoke one of these templates via web UI, we would need to have a feature.

jeremylenz · 2025-01-13T18:58:20Z

app/views/foreman/job_templates/flatpak_install.erb

+kind: job_template
+name: Install Flatpak application on host
+job_category: Katello
+description_format: 'Install Flatpak application on host'


Suggested change

description_format: 'Install Flatpak application on host'

description_format: 'Install Flatpak application %{Application name} on host'

Would be nice to include the application name here, as this will probably be displayed in the UI as a toast.

jeremylenz · 2025-01-13T18:59:35Z

app/views/foreman/job_templates/flatpak_setup.erb

+kind: job_template
+name: Setup Flatpak remote on host
+job_category: Katello
+description_format: 'Setup Flatpak remote on host'


Suggested change

description_format: 'Setup Flatpak remote on host'

description_format: 'Set up Flatpak remote on host'

jeremylenz · 2025-01-13T19:00:35Z

app/views/foreman/job_templates/flatpak_setup.erb

@@ -0,0 +1,35 @@
+<%#
+kind: job_template
+name: Setup Flatpak remote on host


Suggested change

name: Setup Flatpak remote on host

name: Set up Flatpak remote on host

jeremylenz

I didn't actually install podman or flatpak, but templates do render correctly and fail as expected. 👍 LGTM

vsedmik

Looks good to me.
packit/PRT passed at SatelliteQE/robottelo#17207

sjha4 · 2025-01-15T14:31:00Z

There is one pipeline failing. db:seed with ruby 2.7..Re-running suite to see if it's transient.. 😕

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

sjha4 changed the title ~~Fixes #38109 - As a user, I want to install flatpaks on remote hosts~~ Fixes #38109 - As a user, I want to install flatpaks on remote hosts via REX Dec 17, 2024

jeremylenz reviewed Dec 19, 2024

View reviewed changes

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

sjha4 force-pushed the flatpak_template branch from ed3d6d9 to fc0a938 Compare December 20, 2024 21:15

sjha4 force-pushed the flatpak_template branch from fc0a938 to 1cff036 Compare January 3, 2025 16:24

sjha4 commented Jan 6, 2025

View reviewed changes

app/views/foreman/job_templates/flatpak_install.erb Show resolved Hide resolved

jeremylenz reviewed Jan 13, 2025

View reviewed changes

sjha4 force-pushed the flatpak_template branch from 1cff036 to 45d509f Compare January 13, 2025 20:03

jeremylenz approved these changes Jan 13, 2025

View reviewed changes

sjha4 force-pushed the flatpak_template branch from 45d509f to 0ed0288 Compare January 14, 2025 15:37

vsedmik mentioned this pull request Jan 15, 2025

Add e2e test case for flatpak SatelliteQE/robottelo#17207

Merged

vsedmik approved these changes Jan 15, 2025

View reviewed changes

sjha4 force-pushed the flatpak_template branch from 0ed0288 to 8cc049c Compare January 15, 2025 14:29

sjha4 force-pushed the flatpak_template branch from 8cc049c to f766daa Compare January 15, 2025 16:34

Fixes #38109 - As a user, I want to install flatpaks on remote hosts

360cbe9

sjha4 force-pushed the flatpak_template branch from f766daa to 360cbe9 Compare January 15, 2025 18:17

sjha4 merged commit ea0409b into Katello:master Jan 15, 2025
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #38109 - As a user, I want to install flatpaks on remote hosts via REX #11264

Fixes #38109 - As a user, I want to install flatpaks on remote hosts via REX #11264

sjha4 commented Dec 17, 2024 •

edited

Loading

jeremylenz left a comment

jeremylenz Dec 19, 2024

sjha4 Dec 20, 2024

jeremylenz Dec 20, 2024

jeremylenz Dec 19, 2024

jeremylenz Dec 19, 2024

jeremylenz Dec 19, 2024

jeremylenz Dec 19, 2024

sjha4 commented Dec 20, 2024

jeremylenz left a comment

jeremylenz Jan 13, 2025

jeremylenz Jan 13, 2025

jeremylenz Jan 13, 2025

jeremylenz left a comment

vsedmik left a comment

sjha4 commented Jan 15, 2025

		- name: Password
		description: Password for container registry login

	description_format: 'Install Flatpak application on host'
	description_format: 'Install Flatpak application %{Application name} on host'

	description_format: 'Setup Flatpak remote on host'
	description_format: 'Set up Flatpak remote on host'

	name: Setup Flatpak remote on host
	name: Set up Flatpak remote on host

Fixes #38109 - As a user, I want to install flatpaks on remote hosts via REX #11264

Fixes #38109 - As a user, I want to install flatpaks on remote hosts via REX #11264

Conversation

sjha4 commented Dec 17, 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?

jeremylenz left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sjha4 commented Dec 20, 2024

jeremylenz left a 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

jeremylenz left a comment

Choose a reason for hiding this comment

vsedmik left a comment

Choose a reason for hiding this comment

sjha4 commented Jan 15, 2025

sjha4 commented Dec 17, 2024 •

edited

Loading