This collection includes modules and plugins for driving Red Hat Advanced Cluster Management for Kubernetes functionality from Ansible Playbooks.

Before using this collection, install compatible versions of Red Hat Advanced Cluster Management for Kubernetes and Ansible (or Ansible Automation Platform). Review the following documentation for more information.

Tested with Red Hat Advanced Cluster Management for Kubernetes version 2.5. All versions before 2.5 are not supported.

Tested with stable versions of Ansible 2.10, Ansible 2.11, and Ansible 2.12. Ansible versions before 2.10 are not supported.

Tested with Python 3.6, Python 3.7, Python 3.8, and Python 3.9. Python versions before 3.6 are not supported.

Prior to using this collection, include the following configuration updates on your Hub cluster:

• Follow the instructions required for Enabling cluster proxy add-ons.

• Follow the instructions required for configuring your MultiClusterHub custom resource for the ManagedServiceAccount add-on (Technology Preview) .

• Follow the instructions required for Enabling ManagedServiceAccount add-ons (Technical Preview), beginning with Step 2.

Before using the stolostron.core collection, you need to install it with the Ansible Galaxy CLI:

ansible-galaxy collection install stolostron.core

You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: stolostron.core

It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example stolostron.core.cluster_proxy:

---
- hosts: "{{ target_hosts }}"
  connection: local

tasks:
- name: "Get ClusterProxy URL for {{ hostvars[inventory_hostname].cluster_name }}"
  stolostron.core.cluster_proxy:
    hub_kubeconfig: "{{ hostvars['local-cluster'].kubeconfig }}"
    managed_cluster: "{{ hostvars[inventory_hostname].cluster_name }}"
    wait: True
    timeout: 60
  register: cluster_proxy_url

For documentation on how to use individual modules and other content included in this collection, please see the links in the 'Included content' section earlier in this README.

A robust example utilizing the stolostron.core collection is available in the acm-ansible-collection-demo GitHub repository.

If you want to develop new content for this collection or improve what's already here, the easiest way to work on the collection is to clone it into one of the configured COLLECTIONS_PATHS, and work on it there.

The tests directory contains configuration for running sanity, unit, and integration tests using ansible-test.

For more information, see the Testing README.

See Contributing to stolostron.core.

See the changelog.

For more information, join the #forum-acm-devops-wg channel on Slack.

Licensed under the Apache License, Version 2.0.

See LICENSE for full text.