Ansible Collection for Automation Hub Configuration

Description

This Ansible collection allows for easy interaction with an Ansible Automation Hub server via Ansible playbooks. It provides modules and plugins to manage collections, users, groups, and other Automation Hub resources, enabling automation administrators to configure and maintain their Hub instances efficiently.

Installation

Before using this collection, install it from Automation Hub with the ansible-galaxy command-line tool:

ansible-galaxy collection install ansible.hub

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml:

---
collections:
  - name: ansible.hub

To upgrade to the latest available version:

ansible-galaxy collection install ansible.hub --upgrade

To install a specific version:

ansible-galaxy collection install ansible.hub:==1.0.1

See Managing automation content for more details.

Use Cases

1. Collection Management

Automate the upload, approval, and management of collections in your Automation Hub:

- name: Create namespace
  ansible.hub.ah_namespace:
    name: "organization"
    description: "Collections for my organization"
    state: present

- name: Upload collection to Hub
  ansible.hub.ah_collection:
    namespace: "organization"
    name: "collection"
    path: "/path/to/organization-collection.tar.gz"
    state: present

2. User and Group Administration

Manage users and groups across your Automation Hub instance:

- name: Create group
  ansible.hub.ah_group:
    name: "developers"
    state: present

3. Namespace Configuration

Configure and manage namespaces for collection organization:

- name: Create namespace
  ansible.hub.ah_namespace:
    name: "my_organization"
    description: "Collections for my organization"
    state: present

4. Token Management

Manage API tokens for automation workflows:

- name: Create API token
  ansible.hub.ah_token:
    ah_username: "admin"
    ah_password: "admin"
    state: present
  register: ah_token
  no_log: false

Contributing

The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.

We are actively accepting new contributors and all types of contributions are very welcome.

Don't know how to start? Refer to the Ansible community guide!

Want to submit code changes? Take a look at the Quick-start development guide.

We also use the following guidelines:

• Collection review checklist
• Ansible development guide
• Ansible collection development guide

The current maintainers are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.

Support

This collection is maintained by the Red Hat Ansible team.

As Red Hat Ansible Certified Content, this collection is entitled to support through the Ansible Automation Platform (AAP) using the Create issue button on the top right corner. If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there may community help available on the Ansible Forum.

Release Notes

See the changelog for release notes and version history.

Related Information

• Ansible Automation Hub Documentation
• Ansible user guide
• Ansible developer guide
• Ansible collections requirements
• Ansible community Code of Conduct
• The Bullhorn (the Ansible contributor newsletter)
• Important announcements for maintainers

License Information

GNU General Public License v3.0 or later.

See LICENSE to see the full text.