8000 bp to 2.5:AAP-41334: Updates info on requirements files in Managing automation … by hherbly · Pull Request #3459 · ansible/aap-docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

bp to 2.5:AAP-41334: Updates info on requirements files in Managing automation … #3459

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

Merged
merged 1 commit into from
May 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ You can update these collections manually by downloading their packages.
// Current testing requirements are focused on collections containing modules, and additional resources are currently in progress for testing collections containing only roles.
// Contact ansiblepartners@redhat.com for more information.

You can use {HubNameMain} to distribute the relevant {CertifiedColl}s to your users by creating a requirements file or a synclist. Use a requirements file to install collections to your {HubName}, as synclists can only be managed by users with platform administrator privileges.
You can use {HubNameMain} to distribute the relevant {CertifiedColl}s to your users by creating a requirements file.

Before you can use a requirements file to install content, you must:

Expand Down
7 changes: 0 additions & 7 deletions downstream/assemblies/hub/assembly-syncing-to-cloud-repo.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,6 @@

Use remote configurations to configure your {PrivateHubName} to synchronize with {CertifiedName} hosted on `{Console}` or with your collections in {Galaxy}.

[IMPORTANT]
====
To synchronize content, you can now upload a manually-created requirements file from the rh-certified remote. Remotes are configurations that allow you to synchronize content to your custom repositories from an external collection source.

As of the 2.4 release you can still synchronize content, but synclists are deprecated, and will be removed in a future version.
====

Each remote configuration located in {MenuACAdminRemotes} provides information for both the *community* and *rh-certified* repository about when the repository was *last updated*.
You can add new content to {HubNameMain} at any time using the *Edit* and *Sync* features included on the {MenuACAdminRepositories} page.

Expand Down
7 changes: 1 addition & 6 deletions downstream/assemblies/hub/assembly-synclists.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
[id="assembly-synclists"]
= Synchronizing Ansible Content Collections in {HubName}

[IMPORTANT]
====
To synchronize content, you can now upload a manually-created requirements file from the rh-certified remote.
To synchronize content, create and upload a requirements file to the appropriate remote.
Remotes are configurations that enable you to synchronize content to your custom repositories from an external collection source.

As of the 2.4 release you can still synchronize content, but synclists are deprecated, and will be removed in a future version.
====

// include::hub/con-rh-certified-synclist.adoc[leveloffset=+1]
include::hub/proc-create-synclist.adoc[leveloffset=+1]
24 changes: 7 additions & 17 deletions downstream/modules/hub/proc-create-requirements-file.adoc
8000
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[id="create-requirements-file_{context}"]
= Creating a requirements file

Use a requirements file to add collections to your {HubName}. Requirements files are in YAML format and list the collections that you want to install in your {HubName}. After you create your requirements.yml file listing the collections you want to install, you will then run the install command to add the collections to your hub instance.
Use a requirements file to add collections to your {HubName}. Requirements files are in YAML format and list the collections that you want to install in your {HubName}.

A standard `requirements.yml` file contains the following parameters:

Expand All @@ -14,7 +14,7 @@ A standard `requirements.yml` file contains the following parameters:

.Procedure

. Create your requirements file.
* Create your requirements file.
+
In YAML format, collection information in your requirements file should look like this:
+
Expand All @@ -24,19 +24,9 @@ collections:
name: namespace.collection_name
version: 1.0.0
----
+
. After you have created your requirements file listing information for each collection that you want to install, navigate to the directory where the file is located and run the following command:

[source,bash]
----
$ ansible-galaxy collection install -r requirements.yml
----
[Important]
====
Be sure to specify the collection version number, otherwise you will sync all collection versions. Syncing all versions can require more space than expected.
====

== Installing an individual collection from the command line

To install an individual collection to your {HubName}, run the following command:

[source,bash]
----
$ ansible-galaxy collection install namespace.collection_name
----
To sync the collections in your requirements file, follow the steps in link:{URLHubManagingContent}/managing-cert-valid-content#proc-create-synclist[Syncing Ansible content collections].
23 changes: 9 additions & 14 deletions downstream/modules/hub/proc-create-synclist.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
// obtaining-token/master.adoc
[id="proc-create-synclist"]

= Syncing {CertifiedName}
= Syncing Ansible content collections

You can sync curated {CertifiedCon} in {HubNameMain} on {Console}.
You can sync certified and validated collections in {HubNameMain} on {Console}.
//[ddacosta]This needs to be checked. I don't see a Repositories selection in the console verion. I think the way I've rewritten is correct.
// [hherbly] Looks like there is no synclist info in console or the test instance; commenting out this info for 2.5
// Your synclist repository is located on the {HubName} navigation panel under {MenuACAdminRepositories}, which is updated whenever you manage content within {CertifiedName}.
Expand All @@ -20,6 +20,7 @@ When syncing content, keep in mind that {HubName} does not check other repositor

* You have a valid {PlatformNameShort} subscription.
* You have organization administrator permissions for {Console}.
* You have created a link:{URLHubManagingContent}/managing-cert-valid-content#create-requirements-file_cloud-sync[requirements file].
* The following domain names are part of either the firewall or the proxy's allowlist.
They are required for successful connection and download of collections from {HubName} or Galaxy server:
** `galaxy.ansible.com`
Expand All @@ -34,15 +35,9 @@ The following domain names must be in the allow list:

.Procedure

. Log in to `{Console}`.
. Navigate to menu:Automation Hub[Collections].
. Set the *Sync* toggle switch on each collection to exclude or include it on your synclist.
+
[NOTE]
====
You will only see the *Sync* toggle switch if you have administrator permissions.
====
+
. To initiate the remote repository synchronization, navigate to your {PlatformNameShort} and select {MenuACAdminRepositories}.
. In the row containing the repository you want to sync, click the btn:[More Actions] icon *{MoreActionsIcon}* and select *Sync repository* to initiate the remote repository synchronization to your {PrivateHubName}.
. Optional: If your remote repository is already configured, update the collections content that you made available to local users by manually synchronizing Red Hat {CertifiedName} to your {PrivateHubName}.
. From the navigation panel, select {MenuACAdminRemotes}.
. Find the remote you want to sync from and click the pencil icon image:leftpencil.png[Edit,15,15] to edit.
. Find the field labeled *Requirements file*. There, you can either paste the contents of your requirements file, or upload the file from your hard drive by selecting the upload button.
. Click btn:[Save remote].
. To begin synchronization, from the navigation panel select {MenuACAdminRepositories}.
. In the row containing the repository you want to sync, click the {MoreActionsIcon} icon and select the image:sync.png[Sync repository,15,15] *Sync repository* icon to initiate the remote repository synchronization to your {PrivateHubName}.
2 changes: 1 addition & 1 deletion downstream/modules/hub/proc-set-rhcertified-remote.adoc
Original file line number Diff line number Diff line change
5D32 Expand Up @@ -26,7 +26,7 @@ For more information on permissions, see link:{LinkCentralAuth}.
. In the *Token* field, paste the token you acquired from {Console}.
. Click btn:[Save remote].
+
You can now synchronize collections between your organization synclist on {Console} and your {PrivateHubName}.
You can now synchronize collections from {Console} to your {PrivateHubName}.
+
. From the navigation panel, select {MenuACAdminRepositories}. Next to *rh-certified* click the btn:[More Actions] icon *{MoreActionsIcon}* and select *Sync repository*.
. On the modal that appears, you can toggle the following options:
Expand Down
0