8000 bp to 2.5:AAP-41334: reorganizes syncing procedures for clarity + adds KB on re… by hherbly · Pull Request #3502 · 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: reorganizes syncing procedures for clarity + adds KB on re… #3502

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 19, 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
2 changes: 1 addition & 1 deletion downstream/assemblies/hub/assembly-validated-content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Validated collections are uploaded into the `validated` repository.
You can change the default configuration by using two variables:

* `automationhub_seed_collections` is a boolean that defines whether or not preloading is enabled.
* `automationhub_collection_seed_repository`is a variable that enables you to specify the type of content to upload when it is set to `true`.
* `automationhub_collection_seed_repository` is a variable that enables you to specify the type of content to upload when it is set to `true`.
Possible values are `certified` or `validated`.
If this variable is missing, both content sets will be uploaded.

Expand Down
2 changes: 1 addition & 1 deletion downstream/modules/hub/con-token-management-hub.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before you can interact with {HubName} by uploading or downloading collections,

[NOTE]
====
{HubName} does not support basic authentication or authenticating through service accounts. You must authenticate using token management.
{HubNameStart} does not support basic authentication or authenticating through service accounts. You must authenticate using token management.
====

Your method for creating the API token differs according to the type of {HubName} that you are using:
Expand Down
19 changes: 18 additions & 1 deletion downstream/modules/hub/proc-create-synclist.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,28 @@ The following domain names must be in the allow list:
** `ansible-galaxy.s3.amazonaws.com`
* SSL inspection is disabled either when using self signed certificates or for the Red Hat domains.

[IMPORTANT]

====

Before you begin your content sync, consult the Knowledgebase article link:https://access.redhat.com/articles/7118757[Resource requirements for syncing automation content] to ensure that you have the resources to sync the collections you need.

====

.Procedure

. 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}.
. 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}.
. On the modal that appears, you can toggle the following options:
* *Mirror*: Select if you want your repository content to mirror the remote repository's content.
* *Optimize*: Select if you want to sync only when no changes are reported by the remote server.
. Click btn:[Sync] to complete the sync.

.Verification
The *Sync status* column updates to notify you whether the synchronization is successful.

* Navigate to {MenuACCollections} to confirm that your collections content has synchronized successfully.
13 changes: 2 additions & 11 deletions downstream/modules/hub/proc-set-community-remote.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// obtaining-token/master.adoc
[id="proc-set-community-remote"]
ifndef::operationG[]
= Configuring the community remote repository and syncing {Galaxy} collections
= Configuring the community remote repository to sync {Galaxy} collections

You can edit the *community* remote repository to synchronize chosen collections from {Galaxy} to your {PrivateHubName}.
By default, your {PrivateHubName} community repository directs to `galaxy.ansible.com/api/`.
Expand Down Expand Up @@ -35,18 +35,9 @@ collections:
. In the *Details* tab in the *Community* remote, click btn:[Edit remote].
. In the *YAML requirements* field, paste the contents of your `requirements.yml` file.
. Click btn:[Save remote].
+
You can now synchronize collections identified in your `requirements.yml` file from {Galaxy} to your {PrivateHubName}.

. From the navigation panel, select {MenuACAdminRepositories}. Next to the *community* repository, click the btn:[More Actions] icon *{MoreActionsIcon}* and select *Sync repository* to sync collections between {Galaxy} and {HubNameMain}.
. On the modal that appears, you can toggle the following options:
* *Mirror*: Select if you want your repository content to mirror the remote repository's content.
* *Optimize*: Select if you want to sync only when no changes are reported by the remote server.
. Click btn:[Sync] to complete the sync.
You can now synchronize collections identified in your `requirements.yml` file from {Galaxy} to your {PrivateHubName}. See link:{URLHubManagingContent}/managing-cert-valid-content#assembly-synclists[Synchronizing Ansible content collections in {HubName}] for syncing steps.

.Verification
The *Sync status* column updates to notify you whether the {Galaxy} collections synchronization to your {HubNameMain} is successful.

* Navigate to {MenuACCollections} and select *Community* to confirm successful synchronization.


17 changes: 3 additions & 14 deletions downstream/modules/hub/proc-set-rhcertified-remote.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
// obtaining-token/master.adoc
[id="proc-set-rhcertified-remote_{context}"]
= Configuring the rh-certified remote repository and synchronizing {CertifiedColl}
= Configuring the rh-certified remote repository to sync {CertifiedName}

You can edit the *rh-certified* remote repository to synchronize collections from {HubName} hosted on {Console} to your {PrivateHubName}.
By default, your {PrivateHubName} `rh-certified` repository includes the URL for the entire group of {CertifiedName}.
Expand All @@ -25,16 +25,5 @@ For more information on permissions, see link:{LinkCentralAuth}.
. In the *URL* field, paste the *Sync URL*.
. In the *Token* field, paste the token you acquired from {Console}.
. Click btn:[Save remote].
+
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:
* *Mirror*: Select if you want your repository content to mirror the remote repository's content.
* *Optimize*: Select if you want to sync only when no changes are reported by the remote server.
. Click btn:[Sync] to complete the sync.

.Verification
The *Sync status* column updates to notify you whether the Red Hat Certified Content Collections synchronization is successful.

* Navigate to {MenuACCollections} to confirm that your collections content has synchronized successfully.

You can now synchronize collections from {Console} to your {PrivateHubName}. See link:{URLHubManagingContent}/managing-cert-valid-content#assembly-synclists[Synchronizing Ansible content collections in {HubName}] for syncing steps.
0