Kubernetes Collection for Ansible

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

Description

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.

Communication

• Join the Ansible forum:

  • Get Help: get help or help others.
  • Posts tagged with 'kubernetes': subscribe to participate in collection-related conversations.
  • Social Spaces: gather and interact with fellow enthusiasts.
  • News & Announcements: track project-wide announcements including social events.

• The Ansible Bullhorn newsletter: used to announce releases and important changes.

For more information about communication, see the Ansible communication guide.

Requirements

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.15.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

K8s filter plugins

Inventory plugins

Lookup plugins

Modules

Installation

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: 5.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

Use Cases

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.

Contributing to this collection

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

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.

Support

We announce releases and important changes through Ansible's The Bullhorn newsletter. Be sure you are subscribed.

We take part in the global quarterly Ansible Contributor Summit virtually or in-person. Track The Bullhorn newsletter and join us.

For more information about communication, refer to the Ansible Communication guide.

For the latest supported versions, refer to the release notes below.

If you encounter issues or have questions, you can submit a support request through the following channels:

• GitHub Issues: Report bugs, request features, or ask questions by opening an issue in the [GitHub repository]((https://github.com/ansible-collections/kubernetes.core/).

Release notes

See the raw generated changelog.

Code of Conduct

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.

License

GNU General Public License v3.0 or later

See LICENCE to see the full text.