Add UI procedure for Flatpak and remove endpoint in command line (#4014)

bangelic · web-flow · commit 6b6866f5716a · 2025-07-22T11:03:19.000-04:00
* Add UI procedure for Flatpak and remove endpoint in command line

* Address offline suggestions

* Add alternative to Podman in section

* Address suggestions and reword cert config

* Address suggestions

* Rework steps into one step as suggested

* Fix formatting issue

* Address suggestions and fix blank lines

* Address QE suggestions
diff --git a/guides/common/assembly_managing-flatpak-repositories-in-project.adoc b/guides/common/assembly_managing-flatpak-repositories-in-project.adoc
@@ -2,7 +2,15 @@
 
 include::modules/con_managing-flatpak-repositories-in-project.adoc[]
 
-include::modules/proc_enabling-the-flatpak-remote.adoc[leveloffset=+1]
+include::modules/proc_creating-a-flatpak-remote.adoc[leveloffset=+1]
+
+include::modules/proc_scanning-a-flatpak-remote.adoc[leveloffset=+1]
+
+include::modules/proc_viewing-flatpak-remote-details.adoc[leveloffset=+1]
+
+include::modules/proc_mirroring-remote-flatpak-repositories-to-project-products.adoc[leveloffset=+1]
+
+include::modules/proc_enabling-the-flatpak-remote-by-using-hammer-cli.adoc[leveloffset=+1]
 
 include::modules/proc_installing-flatpak-applications-on-project-hosts.adoc[leveloffset=+1]
 
diff --git a/guides/common/modules/proc_creating-a-flatpak-remote.adoc b/guides/common/modules/proc_creating-a-flatpak-remote.adoc
@@ -0,0 +1,17 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="creating-a-flatpak-remote"]
+= Creating a Flatpak remote
+
+You can create a Flatpak remote to access and manage Flatpak repositories in {Project}.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Content* > *Flatpak Remotes*.
+. Click *Create new*.
+. In the *Name* field, enter a name for the Flatpak remote.
+. In the *URL* field, enter the URL of the Flatpak remote.
+  For example, to use the Red{nbsp}Hat Flatpak index, enter: `https://flatpaks.redhat.io/rhel/`.
+. If the Flatpak remote requires authentication, enter the required credentials.
+For example, synchronizing Red{nbsp}Hat Flatpaks from `registry.redhat.io` requires authentication. 
+For more information, see https://access.redhat.com/articles/RegistryAuthentication#creating-registry-service-accounts-6[Creating Registry Service Accounts].
+. Click *Create*.
diff --git a/guides/common/modules/proc_enabling-the-flatpak-remote-by-using-hammer-cli.adoc b/guides/common/modules/proc_enabling-the-flatpak-remote-by-using-hammer-cli.adoc
@@ -1,7 +1,7 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="enabling-the-flatpak-remote"]
-= Enabling the Flatpak remote
+[id="enabling-the-flatpak-remote-by-using-hammer-cli"]
+= Enabling the Flatpak remote by using Hammer CLI
 
 This procedure configures and manages Flatpak repositories by using Hammer CLI.
 
diff --git a/guides/common/modules/proc_importing-and-exporting-content-to-project-server-for-flatpak.adoc b/guides/common/modules/proc_importing-and-exporting-content-to-project-server-for-flatpak.adoc
@@ -7,7 +7,7 @@ Use Hammer CLI to transfer Flatpak content to {ProjectServer} in environments wi
 
 .Prerequisites
 * Enable the Flatpak remote.
-For more information about enabling the Flatpak remote, see xref:enabling-the-flatpak-remote[].
+For more information about enabling the Flatpak remote, see xref:enabling-the-flatpak-remote-by-using-hammer-cli[].
 
 .CLI procedure
 . Export content from the connected {ProjectServer}:
diff --git a/guides/common/modules/proc_installing-flatpak-applications-on-project-hosts.adoc b/guides/common/modules/proc_installing-flatpak-applications-on-project-hosts.adoc
@@ -22,7 +22,13 @@ The token generates automatically when you run `podman login`.
 ----
 $ flatpak remote-add --authenticator-name=org.flatpak.Authenticator.Oci katello oci+https://_{foreman-example-com}_/
 ----
-. Log in using Podman:
+. Log in the host to the container registry using one of the following methods: 
+* Certificate authentication
+** When registering a host to {Project} or {SmartProxy}, select the *Set up container registry certs* checkbox.
+** If the host is already registered, run the *Flatpak - Login to registry via podman* job template on the host.
+Set *Set up certificate authentication* to `true` and enter the URL of the {Project} or {SmartProxy} server as the registry URL.
+* Using Podman
+** Log in using Podman:
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
@@ -35,7 +41,6 @@ For example, to install the Mozilla Firefox Flatpak:
 ----
 $ flatpak install firefox
 ----
-
 .Additional resources
 * For more information about launching Flatpak applications, see {RHELDocsBaseURL}9/html/administering_the_system_using_the_gnome_desktop_environment/assembly_installing-applications-using-flatpak_administering-the-system-using-the-gnome-desktop-environment#launching-flatpak-applications_assembly_installing-applications-using-flatpak[Launching Flatpak applications].
 * For more information about updating Flatpak applications, see {RHELDocsBaseURL}9/html/administering_the_system_using_the_gnome_desktop_environment/assembly_installing-applications-using-flatpak_administering-the-system-using-the-gnome-desktop-environment#updating-flatpak-applications_assembly_installing-applications-using-flatpak[Updating Flatpak applications].
diff --git a/guides/common/modules/proc_mirroring-remote-flatpak-repositories-to-project-products.adoc b/guides/common/modules/proc_mirroring-remote-flatpak-repositories-to-project-products.adoc
@@ -0,0 +1,21 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="mirroring-remote-flatpak-repositories-to-{Project}-products"]
+= Mirroring remote Flatpak repositories to {Project} products
+
+You can mirror a Flatpak repository from a Flatpak remote into an existing product in {Project} to make it available for content management and distribution.
+
+This action creates a new repository inside the product you selected. 
+You can now synchronize the repository to pull down its content. 
+Flatpak repositories are container repositories and you can add them to content views like other container repositories.
+
+Flatpak applications require a corresponding runtime environment, which the Flatpak remote also provides. 
+To make the {EL} 10 Mozilla Firefox Flatpak available to a host, ensure that the host can access the matching `rhel10/flatpak-runtime` repository.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Content* > *Flatpak Remotes*.
+. In the list of Flatpak Remotes, click the name of the remote you want to mirror.
+. In the list of remote repositories, locate the repository you want to mirror.
+. Select the *Mirror Action* menu on the row of the repository.
+. In the *Mirror* window, select the existing product where you want to create the new repository.
+. Click *Mirror*.
diff --git a/guides/common/modules/proc_scanning-a-flatpak-remote.adoc b/guides/common/modules/proc_scanning-a-flatpak-remote.adoc
@@ -0,0 +1,13 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="scanning-a-flatpak-remote"]
+= Scanning a Flatpak remote
+
+You can scan a Flatpak remote to fetch metadata about the repositories it provides.
+Scanning a Flatpak remote creates remote repository artifacts for the repositories hosted by the Flatpak remote. 
+If new repositories are added to the Flatpak remote, scan it again to pull in the changes. 
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Content* > *Flatpak Remotes*.
+. Select the Flatpak remote that you want to scan.
+. Click the vertical ellipsis next to the remote and select *Scan*.
diff --git a/guides/common/modules/proc_setting-up-flatpak-remote-for-smartproxy.adoc b/guides/common/modules/proc_setting-up-flatpak-remote-for-smartproxy.adoc
@@ -20,9 +20,15 @@ For more information, see xref:Synchronizing_Repositories_{context}[].
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
-$ flatpak remote-add --authenticator-name=org.flatpak.Authenticator.Oci katello oci+https://{smartproxy-example-com}/pulpcore_registry/
-----
-. Log in using Podman:
+$ flatpak remote-add --authenticator-name=org.flatpak.Authenticator.Oci katello oci+https://{smartproxy-example-com}/
+----
+. Log in the host to the container registry using one of the following methods: 
+* Certificate authentication
+** When registering a host to {SmartProxy}, select the *Set up container registry certs* checkbox.
+** If the host is already registered, run the *Flatpak - Login to registry via podman* job template on the host.
+Set *Set up certificate authentication* to `true` and enter the URL of the {SmartProxy} server as the registry URL.
+* Using Podman
+** Log in using Podman:
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
@@ -31,7 +37,6 @@ $ podman login _{foreman-example-com}_
 For more information about logging in using Podman, see xref:Configuring_podman_to_trust_the_CA_{context}[].
 +
 You might need to log in to the registry again if you have not saved your credentials.
-
 . Optional: Save your credentials permanently using one of the following options:
 * To save the credentials for the current user:
 +
diff --git a/guides/common/modules/proc_viewing-flatpak-remote-details.adoc b/guides/common/modules/proc_viewing-flatpak-remote-details.adoc
@@ -0,0 +1,11 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="viewing-flatpak-remote-details"]
+= Viewing Flatpak remote details
+
+You can view a list of the repositories a scanned Flatpak remote provides.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Content* > *Flatpak Remotes*.
+. Click the name of the Flatpak remote you want to view.
+. The page displays a list of repositories available from the scanned Flatpak remote.
