diff options
| -rw-r--r-- | docs/collections.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/collections.md b/docs/collections.md index 23d805b74c..93d99889ed 100644 --- a/docs/collections.md +++ b/docs/collections.md @@ -52,3 +52,31 @@ Example of `tmp` directory where job is running: └── tmp_6wod58k ``` + +### Galaxy Server Selection + +Ansible core default settings will download collections from the public +Galaxy server at `https://galaxy.ansible.com`. For details on +how Galaxy servers are configured in Ansible in general see: + +https://docs.ansible.com/ansible/devel/user_guide/collections_using.html +(if "devel" link goes stale in the future, it is for Ansible 2.9) + +You can set a different server to be the primary Galaxy server to download +roles and collections from in AWX project updates. +This is done via the setting `PRIMARY_GALAXY_URL` and similar +`PRIMARY_GALAXY_xxxx` settings for authentication. + +If the `PRIMARY_GALAXY_URL` setting is not blank, then the server list is defined +to be `primary_galaxy,galaxy`. The `primary_galaxy` server definition uses the URL +from those settings, as well as username, password, and/or token if applicable. +the `galaxy` server definition uses public Galaxy (`https://galaxy.ansible.com`) +with no authentication. + +This configuration causes requirements to be downloaded from the user-specified +primary galaxy server if they are available there. If a requirement is +not available from the primary galaxy server, then it will fallback to +downloading it from the public Galaxy server. + +Even when these settings are enabled, this can still be bypassed for a specific +requirement by using the `source:` option, as described in Ansible documentation. |