Skip to content

Commit

Permalink
Point to AH docs (#77200)
Browse files Browse the repository at this point in the history
  • Loading branch information
samccann committed Mar 4, 2022
1 parent af2b136 commit 7d234a4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 14 deletions.
15 changes: 3 additions & 12 deletions docs/docsite/rst/shared_snippets/galaxy_server_list.txt
Expand Up @@ -2,7 +2,7 @@

By default, ``ansible-galaxy`` uses https://galaxy.ansible.com as the Galaxy server (as listed in the :file:`ansible.cfg` file under :ref:`galaxy_server`).

You can use either option below to configure ``ansible-galaxy collection`` to use other servers (such as Red Hat Automation Hub or a custom Galaxy server):
You can use either option below to configure ``ansible-galaxy collection`` to use other servers (such as a custom Galaxy server):

* Set the server list in the :ref:`galaxy_server_list` configuration option in :ref:`ansible_configuration_settings_locations`.
* Use the ``--server`` command line argument to limit to an individual server.
Expand All @@ -18,22 +18,13 @@ To configure a Galaxy server list in ``ansible.cfg``:
.. note::
The ``url`` option for each server name must end with a forward slash ``/``. If you do not set the API token in your Galaxy server list, use the ``--api-key`` argument to pass in the token to the ``ansible-galaxy collection publish`` command.

For Automation Hub, you additionally need to:

#. Set the ``auth_url`` option for each server name.
#. Set the API token for each server name. Go to https://cloud.redhat.com/ansible/automation-hub/token/ and click ::guilabel:`Get API token` from the version dropdown to copy your API token.

The following example shows how to configure multiple servers:

.. code-block:: ini

[galaxy]
server_list = automation_hub, my_org_hub, release_galaxy, test_galaxy, my_galaxy_ng

[galaxy_server.automation_hub]
url=https://cloud.redhat.com/api/automation-hub/
auth_url=https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token
token=my_ah_token
server_list = my_org_hub, release_galaxy, test_galaxy, my_galaxy_ng

[galaxy_server.my_org_hub]
url=https://automation.my_org/
Expand Down Expand Up @@ -71,7 +62,7 @@ define the following keys:
* ``token``: An API token key to use for authentication against the Galaxy instance. Mutually exclusive with ``username``.
* ``username``: The username to use for basic authentication against the Galaxy instance. Mutually exclusive with ``token``.
* ``password``: The password to use, in conjunction with ``username``, for basic authentication.
* ``auth_url``: The URL of a Keycloak server 'token_endpoint' if using SSO authentication (for example, Automation Hub). Mutually exclusive with ``username``. Requires ``token``.
* ``auth_url``: The URL of a Keycloak server 'token_endpoint' if using SSO authentication (for example, galaxyNG). Mutually exclusive with ``username``. Requires ``token``.
* ``validate_certs``: Whether or not to verify TLS certificates for the Galaxy server. This defaults to True unless the ``--ignore-certs`` option is provided or ``GALAXY_IGNORE_CERTS`` is configured to True.
* ``client_id``: The Keycloak token's client_id to use for authentication. Requires ``auth_url`` and ``token``. The default ``client_id`` is cloud-services to work with Red Hat SSO.

Expand Down
5 changes: 3 additions & 2 deletions docs/docsite/rst/user_guide/collections_using.rst
Expand Up @@ -137,7 +137,7 @@ All the collections are downloaded by default to the ``./collections`` folder bu
Once you have downloaded the collections, the folder contains the collections specified, their dependencies, and a
``requirements.yml`` file. You can use this folder as is with ``ansible-galaxy collection install`` to install the
collections on a host without access to a Galaxy or Automation Hub server.
collections on a host without access to a Galaxy server.

.. code-block:: bash
Expand Down Expand Up @@ -432,4 +432,5 @@ This will have an implied entry in the ``collections:`` keyword of ``my_namespac
The development mailing list
:ref:`communication_irc`
How to join Ansible chat channels

`Automation Hub <https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/>`_
Learn how to use collections with Red Hat Automation Hub

0 comments on commit 7d234a4

Please sign in to comment.