Automation hub
Automation hub stores Ansible collections and container images of execution and decision
environments. In Koios Automation Platform, open Automation Content in the navigation menu.
Its API is under /api/galaxy/ through the platform gateway.
Automation hub is deployed unless hub.disabled: true
(Configure). Organizations, teams and users come from the
platform. Hub permissions determine which namespaces, repositories and images a user can manage.
Collections
A collection packages modules, plugins, roles and other Ansible content. Its identity combines a
namespace, name and version, for example example.hello:1.0.0. The built archive is named
example-hello-1.0.0.tar.gz.
Collections belong to namespaces, which identify their publishers. Create one in Automation Content > Namespaces before uploading content. A successful upload starts an import that checks the collection’s metadata and content; it does not necessarily make the version available to clients of the published repository.
Publish your first collection follows the complete path: create a namespace, build an archive with the required runtime metadata, upload it, inspect the import, approve the version and install it from the published endpoint.
Repositories and distributions
A repository contains a set of collection versions. A distribution exposes repository content to clients at an API URL. These are different resources: creating or naming a repository does not by itself define which URL a client should use.
The documentation test platform has the following repositories:
Repository |
Purpose / scope |
|---|---|
staging |
Imported uploads waiting for review in the configured approval pipeline. |
published |
Approved content made available to consumers of the published distribution. |
rejected |
Content rejected during review; not content approved for installation from published. |
validated |
A separate content repository. Its name is not a guarantee that Koios tested every collection it contains. |
community |
Content synchronized from the community remote when a sync is configured and run. |
rh-certified |
Destination for content from the corresponding remote when synchronization succeeds, subject to upstream access. Its name does not certify Koios Automation Platform. |
The repositories’ content and policy can differ between deployments. Inspect **Automation Content
Repositories**, their Distributions, and the selected repository when browsing a collection. See Remotes and repositories for the distinction between local imports and remote synchronization.
Remotes and approvals
A remote describes where to fetch content and how to authenticate to the upstream server. The test platform has community and rh-certified remotes. They are configuration objects, not proof that a synchronization completed. Use a requirements file to restrict community synchronization rather than attempting to mirror all of Ansible Galaxy.
Automation Content > Collection Approvals controls the local upload approval workflow. In the validated example, the imported version was in staging and could not be installed from published until it was approved. Import validation, approval and cryptographic signatures are separate checks; do not infer one from another.
Tokens and clients
All clients connect through the platform gateway. Use a platform username/password when gateway Basic authentication is enabled, or an API token of a platform user with the necessary permissions (Tokens). A token issued by a standalone hub is not interchangeable with a gateway token for this deployment.
Use https://<platform>/api/galaxy/ for publishing and
https://<platform>/api/galaxy/content/published/ for installing approved content. The
first collection tutorial shows
ansible.cfg and password/token environment variables, without storing credentials in the
collection archive.
Using collections from automation controller
Automation controller project updates install the collections listed in
collections/requirements.yml using the Galaxy credentials of the project’s organization,
in order. To use the platform hub:
Create a gateway token for a platform user with read access to the published content.
Under Automation Execution > Infrastructure > Credentials, create an Ansible Galaxy/Automation Hub API Token credential with URL
https://<platform>/api/galaxy/content/published/and that token. For an appropriate in-cluster connection, an administrator can usehttp://<platform>-gateway/api/galaxy/content/published/.Under Access Management > Organizations, open the organization and add the credential to Galaxy credentials, before Ansible Galaxy if this hub should be tried first.
Add the required collection/version to the project’s
collections/requirements.ymland sync the project. Inspect the update result before launching jobs.
This consumption pattern was validated with a test collection and a controller project/job on the
Koios test platform. The new example.hello tutorial separately validates command-line install;
it does not claim a controller job was run with that particular collection. See
Projects and Configuration as code for the
controller and CasC workflows.
Event-Driven Ansible also uses collections inside its decision environment. Publishing a collection to the hub does not add it to existing decision environment images. Include the required collections when building a custom image, and configure its access to the hub during that build. See Decision environments.
Container registry
Automation hub also serves a container registry through the platform address (/v2/). Clients
such as podman or skopeo push and pull images using platform users; the gateway issues the
registry tokens. Collection namespaces and container image repository paths are different resources.
podman login <platform-host>
podman push <platform-host>/<namespace>/<image>:<tag>
Note
For automation controller or Event-Driven Ansible to run execution or decision environments from this registry, the container runtime of the cluster nodes must resolve, reach and trust the platform address. This use of hub-hosted EE/DE images is not validated in Koios Automation Platform; it remains blocked pending the required public hostname and TLS setup. Successful push/pull with a client does not demonstrate a successful image pull by a cluster node.
Backup and restore
The hub uses a ReadWriteMany content volume by default; see
Automation hub storage. A single-node installation
without RWX storage can select the documented ReadWriteOnce configuration; it is not an HA
storage design.
Backups include the hub database, content files and keys. Keep them together when planning restore and protect copies that contain credentials and keys.