Kubernetes Collection for Ansible

This repository hosts the kubernetes.core (formerly known as community.kubernetes) Ansible Collection.

The collection includes a variety of Ansible content to help automate the management of applications in Kubernetes and OpenShift clusters, as well as the provisioning and maintenance of clusters themselves.

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.14.0.

For collections that support Ansible 2.9, please ensure you update your network_os to use the fully qualified collection name (for example, cisco.ios.ios). Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

Python Support

• Collection supports 3.9+

Note: Python2 is deprecated from 1st January 2020. Please switch to Python3.

Kubernetes Version Support

This collection supports Kubernetes versions >= 1.24.

Included content

Click on the name of a plugin or module to view that content's documentation:

Connection plugins

Name	Description
kubernetes.core.kubectl	Execute tasks in pods running on Kubernetes.

K8s filter plugins

Name	Description
kubernetes.core.k8s_config_resource_name	Generate resource name for the given resource of type ConfigMap, Secret

Inventory plugins

Name	Description
kubernetes.core.k8s	Kubernetes (K8s) inventory source

Lookup plugins

Name	Description
kubernetes.core.k8s	Query the K8s API
kubernetes.core.kustomize	Build a set of kubernetes resources using a 'kustomization.yaml' file.

Modules

Name	Description
kubernetes.core.helm	Manages Kubernetes packages with the Helm package manager
kubernetes.core.helm_info	Get information from Helm package deployed inside the cluster
kubernetes.core.helm_plugin	Manage Helm plugins
kubernetes.core.helm_plugin_info	Gather information about Helm plugins
kubernetes.core.helm_pull	download a chart from a repository and (optionally) unpack it in local directory.
kubernetes.core.helm_repository	Manage Helm repositories.
kubernetes.core.helm_template	Render chart templates
kubernetes.core.k8s	Manage Kubernetes (K8s) objects
kubernetes.core.k8s_cluster_info	Describe Kubernetes (K8s) cluster, APIs available and their respective versions
kubernetes.core.k8s_cp	Copy files and directories to and from pod.
kubernetes.core.k8s_drain	Drain, Cordon, or Uncordon node in k8s cluster
kubernetes.core.k8s_exec	Execute command in Pod
kubernetes.core.k8s_info	Describe Kubernetes (K8s) objects
kubernetes.core.k8s_json_patch	Apply JSON patch operations to existing objects
kubernetes.core.k8s_log	Fetch logs from Kubernetes resources
kubernetes.core.k8s_rollback	Rollback Kubernetes (K8S) Deployments and DaemonSets
kubernetes.core.k8s_scale	Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
kubernetes.core.k8s_service	Manage Services on Kubernetes
kubernetes.core.k8s_taint	Taint a node in a Kubernetes/OpenShift cluster

Installation and Usage

Installing the Collection from Ansible Galaxy

Before using the Kubernetes collection, you need to install it with the Ansible Galaxy CLI:

ansible-galaxy collection install kubernetes.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: kubernetes.core
    version: 3.0.0

Installing the Kubernetes Python Library

Content in this collection requires the Kubernetes Python client to interact with Kubernetes' APIs. You can install it with:

pip3 install kubernetes

Using modules from the Kubernetes Collection in your playbooks

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

---
- hosts: localhost
  gather_facts: false
  connection: local

  tasks:
    - name: Ensure the myapp Namespace exists.
      kubernetes.core.k8s:
        api_version: v1
        kind: Namespace
        name: myapp
        state: present

    - name: Ensure the myapp Service exists in the myapp Namespace.
      kubernetes.core.k8s:
        state: present
        definition:
          apiVersion: v1
          kind: Service
          metadata:
            name: myapp
            namespace: myapp
          spec:
            type: LoadBalancer
            ports:
            - port: 8080
              targetPort: 8080
            selector:
              app: myapp

    - name: Get a list of all Services in the myapp namespace.
      kubernetes.core.k8s_info:
        kind: Service
        namespace: myapp
      register: myapp_services

    - name: Display number of Services in the myapp namespace.
      debug:
        var: myapp_services.resources | count

If upgrading older playbooks which were built prior to Ansible 2.10 and this collection's existence, you can also define collections in your play and refer to this collection's modules as you did in Ansible 2.9 and below, as in this example:

---
- hosts: localhost
  gather_facts: false
  connection: local

  collections:
    - kubernetes.core

  tasks:
    - name: Ensure the myapp Namespace exists.
      k8s:
        api_version: v1
        kind: Namespace
        name: myapp
        state: present

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.

Ansible Turbo mode Tech Preview

The kubernetes.core collection supports Ansible Turbo mode as a tech preview via the cloud.common collection. By default, this feature is disabled. To enable Turbo mode for modules, set the environment variable ENABLE_TURBO_MODE=1 on the managed node. For example:

---
- hosts: remote
  environment:
    ENABLE_TURBO_MODE: 1
  tasks:
    ...

To enable Turbo mode for k8s lookup plugin, set the environment variable ENABLE_TURBO_MODE=1 on the managed node. This is not working when defined in the playbook using environment keyword as above, you must set it using export ENABLE_TURBO_MODE=1.

Please read more about Ansible Turbo mode - here.

Testing and Development

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.

See Contributing to kubernetes.core.

Testing with ansible-test

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

You can run the collection's test suites with the commands:

make test-sanity
make test-integration
make test-unit

Testing with molecule

There are also integration tests in the molecule directory which are meant to be run against a local Kubernetes cluster, e.g. using KinD or Minikube. To setup a local cluster using KinD and run Molecule:

kind create cluster
make test-molecule

Publishing New Versions

Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:

1. Update the version in the following places:
   1. The version in galaxy.yml
   2. This README's requirements.yml example
   3. The VERSION in Makefile
2. Update the CHANGELOG:
   1. Make sure you have antsibull-changelog installed.
   2. Make sure there are fragments for all known changes in changelogs/fragments.
   3. Run antsibull-changelog release.
3. Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
4. Tag the version in Git and push to GitHub.

After the version is published, verify it exists on the Kubernetes Collection Galaxy page.

The process for uploading a supported release to Automation Hub is documented separately.

More Information

For more information about Ansible's Kubernetes integration, join the #ansible-kubernetes channel on libera.chat IRC, and browse the resources in the Kubernetes Working Group Community wiki page.

License

GNU General Public License v3.0 or later

See LICENCE to see the full text.