Skip to content

Commit

Permalink
Cleaned up content and added new modules
Browse files Browse the repository at this point in the history
  • Loading branch information
bangelic committed Jan 29, 2025
1 parent 94abefd commit fbf2385
Show file tree
Hide file tree
Showing 9 changed files with 81 additions and 72 deletions.
12 changes: 8 additions & 4 deletions guides/common/assembly_managing-flatpak-using-project.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
include::modules/con_managing-flatpak-using-project.adoc[]
include::modules/con_the-flatpak-technology.adoc[]

include::modules/proc_using-hammer-cli-for-flatpak-management.adoc[leveloffset=+1]
include::modules/proc_setting-up-flatpak.adoc[leveloffset=+1]

include::modules/proc_flatpak-remote-for-client-setup.adoc[leveloffset=+1]
include::modules/proc_enabling-the-red-hat-flatpak-remote.adoc[leveloffset=+1]

include::modules/proc_installing-flatpak-applications.adoc[leveloffset=+1]

include::modules/proc_flatpak-remote-for-smartproxy-setup.adoc[leveloffset=+1]

include::modules/proc_importing-and-exporting-content-to-project-server-for-flatpak.adoc[leveloffset=+1]
include::modules/proc_importing-and-exporting-content-to-project-server-for-flatpak.adoc[leveloffset=+1]

include::modules/proc_updating-flatpak-applications.adoc[leveloffset=+1]
4 changes: 0 additions & 4 deletions guides/common/modules/con_managing-flatpak-using-project.adoc

This file was deleted.

12 changes: 12 additions & 0 deletions guides/common/modules/con_the-flatpak-technology.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[id="the-flatpak-technology_{context}"]
= The Flatpak technology

Flatpak provides a sandbox environment for application building, deployment, distribution, and installation.

Applications that you launch using Flatpak have minimum access to the host system, which protects the system installation against third-party applications.
Flatpak provides application stability regardless of the versions of libraries installed on the host system.

Flatpak applications are distributed from repositories called remotes.
Red Hat provides a remote with {Project} applications.
Additionally, third-party remotes are available as well.
Red Hat does not support applications from third-party remotes.
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
[id="Using_Hammer_CLI_for_Flatpak_Management_{context}"]
= Using Hammer CLI for Flatpak management
[id="enabling-the-red-hat-flatpak-remote_{context}"]
= Enabling the Red Hat Flatpak remote

Use this Hammer CLI procedure to set up and manage Flatpak repositories.
This Hammer CLI procedure enables and manages Flatpak repositories.

.CLI procedure
. Run the following command on the {ProjectServer} to create a Flatpak remote using either standalone {EL} systems or {ProjectName}:
. Enable a Flatpak remote on the {ProjectServer} using either standalone {EL} systems or {ProjectName}:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote create --name=$name --url=$url
----
* Note that you can include authentication details during creation using the options `--username=$username --token=$token`.
* Red Hat official token can be generated at: https://access.redhat.com/terms-based-registry.
. Use the following command to update the Flatpak remote with authentication credentials:
. Update the Flatpak remote with authentication credentials:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote update --username=$username --token=$token
----
. Use these commands to display details:
. List and view information about the Flatpak remote:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote list
$ hammer flatpak-remote info
----
. Fetch repositories in the Flatpak remote by scanning it:
. Scan the Flatpak remote:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote scan --id=$ID
----
. Display a list of repositories in the remote:
. List repositories in the Flatpak remote:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote repository list --flatpak-remote-id=$ID
----
. Mirror a repository to a {Project} product:
. Mirror a Flatbak remote repository to a {Project} product:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote remote-repository mirror --id=$remote_repo_id --product-id=$satellite_product
----
After this step, you can view the repository under the selected product in Satellite. Ensure the *Include Tags* field is set to *latest*.
. Synchronize the product repository using the following command:
You can view the repository under the selected product in Satellite. Ensure the *Include Tags* field is set to *latest*.
. Synchronize the {Project} repository using the following command:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[id="Flatpak_Remote_for_Smartproxy_{context}"]
= Flatpak remote for {SmartProxy} setup

Use this procedure to configure {SmartProxy} servers to synchronize and distribute Flatpak repositories to managed hosts.
This procedure configures {SmartProxy} servers to synchronize and distribute Flatpak repositories to managed hosts.

.Prerequisites
* Ensure the Flatpak repositories are synced to the {SmartProxy} as they are for any other repository.

.Procedure
. Ensure the Flatpak repositories are synced to the {SmartProxy} as they are for any other repository.
. Run the following command on the managed host to add the {SmartProxy} as a Flatpak remote:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,55 +1,10 @@
[id="Importing_and_Exporting_Content_to_Project_Server_for_Flatpak_{context}"]
= Importing and exporting content to {ProjectServer} for Flatpak

Use this Hammer CLI procedure to set up and manage Flatpak repositories.
This Hammer CLI procedure imports and exports content to {ProjectServer} for Flatpak.

.CLI procedure
. Run the following command on the {ProjectServer} to create a Flatpak remote using either standalone {EL} systems or {ProjectName}:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote create --name=$name --url=$url
----
* Note that you can include authentication details during creation using the options `--username=$username --token=$token`.
* Red Hat official token can be generated at: https://access.redhat.com/terms-based-registry.
. Use the following command to update the Flatpak remote with authentication credentials:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote update --username=$username --token=$token
----
. Use these commands to display details:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote list
$ hammer flatpak-remote info
----
. Fetch repositories in the Flatpak remote by scanning it:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote scan --id=$ID
----
. Display a list of repositories in the remote:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote repository list --flatpak-remote-id=$ID
----
. Mirror a repository to a {Project} product:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer flatpak-remote remote-repository mirror --id=$remote_repo_id --product-id=$satellite_product
----
After this step, you can view the repository under the selected product in Satellite. Ensure the *Include Tags* field is set to *latest*.
. Synchronize the product repository using the following command:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
$ hammer repository sync --id=$repo_id
----
. Follow the steps in xref:enabling-the-red-hat-flatpak-remote_{context}[].
. Use the following command to export content from the connected {ProjectServer}:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
[id="Flatpak_Remote_for_Client_Setup_{context}"]
= Flatpak remote for client setup
[id="installing-flatpak-applications_{context}"]
= Installing Flatpak applications

Use this procedure to configure managed hosts to access and use Flatpak repositories for application installation.
This procedure installs selected applications from the enabled Flatpak remotes on the command line.

.Prerequisites
* Flatpak is installed.
* The Red Hat Flatpak remote is enabled.

.Procedure
. Run the following command on the managed host to add the {Project} as a Flatpak remote:
Expand All @@ -16,7 +20,7 @@ $ flatpak --user remote-add --authenticator-name=org.flatpak.Authenticator.Oci k
----
$ podman login
----
. Install the Firefox Flatpak:
. Install the Mozilla Firefox Flatpak:
+
[options="nowrap", subs="+quotes,verbatim,attributes"]
----
Expand Down
12 changes: 12 additions & 0 deletions guides/common/modules/proc_setting-up-flatpak.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[id="setting-up-flatpak_{context}"]
= Setting up Flatpak

This procedure installs the Flatpak package manager.

.Procedure
* Install the `flatpak` package:
+
[subs="+attributes"]
----
# {client-content-type} install flatpak
----
24 changes: 24 additions & 0 deletions guides/common/modules/proc_updating-flatpak-applications.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[id="updating-flatpak-applications_{context}"]
= Updating Flatpak applications

This procedure updates one or more installed Flatpak applications to the most recent version in the corresponding Flatpak remote.

.Prerequisites
* Flatpak is installed.
* A Flatpak remote is enabled.

.Procedure
* Update one or more Flatpak applications:

** To update a specific Flatpak application, specify the application ID:
+
[subs=+quotes]
----
$ flatpak update __application-id__
----

** To update all Flatpak applications, specify no application ID:
+
----
$ flatpak update
----

0 comments on commit fbf2385

Please sign in to comment.