Skip to content

Commit 444e702

Browse files
authored
Add permissions and prerequisites in Flatpak docs (#4123)
1 parent 422f504 commit 444e702

5 files changed

+26
-8
lines changed

guides/common/modules/proc_creating-a-flatpak-remote.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@
55

66
You can create a Flatpak remote to access and manage Flatpak repositories in {Project}.
77

8+
.Prerequisites
9+
* Your {Project} account has a role that grants the `create_flatpak_remotes` permission.
10+
811
.Procedure
912
. In the {ProjectWebUI}, navigate to *Content* > *Flatpak Remotes*.
1013
. Click *Create new*.
1114
. In the *Name* field, enter a name for the Flatpak remote.
1215
. In the *URL* field, enter the URL of the Flatpak remote.
1316
For example, to use the Red{nbsp}Hat Flatpak index, enter: `https://flatpaks.redhat.io/rhel/`.
1417
. If the Flatpak remote requires authentication, enter the required credentials.
15-
For example, synchronizing Red{nbsp}Hat Flatpaks from `registry.redhat.io` requires authentication.
18+
For example, synchronizing Red{nbsp}Hat Flatpaks from `registry.redhat.io` requires authentication.
1619
For more information, see https://access.redhat.com/articles/RegistryAuthentication#creating-registry-service-accounts-6[Creating Registry Service Accounts].
1720
. Click *Create*.

guides/common/modules/proc_installing-flatpak-applications-on-project-hosts.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ Use the command line to install selected applications from the enabled Flatpak r
77

88
.Prerequisites
99
* Flatpak is installed on the host.
10+
* Set up Flatpak on the content host that consumes applications from {ProjectServer}.
11+
For more information, 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#setting-up-flatpak_assembly_installing-applications-using-flatpak[Setting up Flatpak].
12+
* Ensure that Flatpak runtime repositories are available to hosts alongside application repositories.
13+
Flatpak applications, such as `rhel9/firefox-flatpak`, depend on the runtime for installation.
1014
ifdef::satellite[]
1115
* The {Team} Flatpak remote is enabled.
1216
endif::[]

guides/common/modules/proc_mirroring-remote-flatpak-repositories-to-project-products.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,22 @@
55

66
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.
77

8-
This action creates a new repository inside the product you selected.
9-
You can now synchronize the repository to pull down its content.
8+
This action creates a new repository inside the product you selected.
9+
You can now synchronize the repository to pull down its content.
1010
Flatpak repositories are container repositories and you can add them to content views like other container repositories.
1111

12-
Flatpak applications require a corresponding runtime environment, which the Flatpak remote also provides.
12+
Flatpak applications require a corresponding runtime environment, which the Flatpak remote also provides.
1313
To make the {EL} 10 Mozilla Firefox Flatpak available to a host, ensure that the host can access the matching `rhel10/flatpak-runtime` repository.
1414

15+
.Prerequisites
16+
* Your {Project} account has a role that grants the `view_flatpak_remotes` and `edit_flatpak_remotes` permissions.
17+
* Ensure that Flatpak runtime repositories are available to hosts alongside application repositories.
18+
Flatpak applications, such as `rhel9/firefox-flatpak`, depend on the runtime for installation.
19+
1520
.Procedure
1621
. In the {ProjectWebUI}, navigate to *Content* > *Flatpak Remotes*.
1722
. In the list of Flatpak Remotes, click the name of the remote you want to mirror.
1823
. In the list of remote repositories, locate the repository you want to mirror.
1924
. Select the *Mirror Action* menu on the row of the repository.
2025
. In the *Mirror* window, select the existing product where you want to create the new repository.
21-
. Click *Mirror*.
26+
. Click *Mirror*.

guides/common/modules/proc_scanning-a-flatpak-remote.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@
44
= Scanning a Flatpak remote
55

66
You can scan a Flatpak remote to fetch metadata about the repositories it provides.
7-
Scanning a Flatpak remote creates remote repository artifacts for the repositories hosted by the Flatpak remote.
8-
If new repositories are added to the Flatpak remote, scan it again to pull in the changes.
7+
Scanning a Flatpak remote creates remote repository artifacts for the repositories hosted by the Flatpak remote.
8+
If new repositories are added to the Flatpak remote, scan it again to pull in the changes.
9+
10+
.Prerequisites
11+
* Your {Project} account has a role that grants the `view_flatpak_remotes` and `edit_flatpak_remotes` permissions.
912

1013
.Procedure
1114
. In the {ProjectWebUI}, navigate to *Content* > *Flatpak Remotes*.

guides/common/modules/proc_viewing-flatpak-remote-details.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55

66
You can view a list of the repositories a scanned Flatpak remote provides.
77

8+
.Prerequisites
9+
* Your {Project} account has a role that grants the `view_flatpak_remotes` permission.
10+
811
.Procedure
912
. In the {ProjectWebUI}, navigate to *Content* > *Flatpak Remotes*.
1013
. Click the name of the Flatpak remote you want to view.
11-
. The page displays a list of repositories available from the scanned Flatpak remote.
14+
. The page displays a list of repositories available from the scanned Flatpak remote.

0 commit comments

Comments
 (0)