Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Flatpak workflow procedures for Satellite #3624

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

bangelic
Copy link
Contributor

What changes are you introducing?

Adding Flatpak workflow procedures for Satellite.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

In reference to https://issues.redhat.com/browse/SAT-30544.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • We do not accept PRs for Foreman older than 3.7.

Copy link

github-actions bot commented Jan 29, 2025

@bangelic
Copy link
Contributor Author

@sjha4 Take a look/review and let me know if we captured what we needed from the Google Doc.

@Lennonka Lennonka added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels Jan 29, 2025
@bangelic bangelic marked this pull request as draft January 29, 2025 13:24
@bangelic bangelic force-pushed the bangelic-SAT-30544-Document-flatpak-workflow-in-satellite branch from 6ba1777 to fbf2385 Compare January 29, 2025 20:45

.Procedure using remote execution templates

. Set up Flatpak remote on host:
Copy link
Contributor

@sjha4 sjha4 Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this clear enough to say these 3 are remote templates?

  1. Set up Flatpak remote on host
  2. Install Flatpak application
  3. Log in to Flatpak registry using podman

I'd add a brief description of the 3.

1st runs a REX job on host to add satellite/capsule as a flatpak remote on the host and logs into podman registry and saves the credentials.
2nd runs a REX job to install Flatpak applications on selected host(s)
3rd runs a REX job to login to podman registry and save credentials on the client.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sjha4 The more I try to clarify this with what you want me to add, the more I'm not sure we are telling the user what to do here. Should we keep this section using REX templates?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are 3 templates admins can use to set up the clients. We should keep it for admins to be able to do what we document right above this using flatpak cli commands..We should even move it above the regular procedure in this section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated REX templates to be better grouped for UX and follow convention. These should make it clearer in the documentation.

Flatpak - Set up remote on host
Flatpak - Install application on host
Flatpak - Login to registry via podman

+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ flatpak --user remote-add --authenticator-name=org.flatpak.Authenticator.Oci katello oci+https://satellite.example.com/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets remove --user from here and add a note for context if needed. The --user flag sets up remote and also installs apps in user context on the client. System-wide installs are the default and the REX templates also follow that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs style review Requires a review from docs style/grammar perspective Needs tech review Requires a review from the technical perspective
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants