* fix(k8s_cp): wait for remote tar to finish before closing the stream
The module closed the exec connection right after writing the last chunk,
killing tar mid-extract, and never checked its exit status, so a partial
or failed copy was reported as success (#776).
The v4 exec protocol cannot half-close stdin, and busybox tar blocks for
EOF rather than stopping at the end-of-archive marker, so bound the stream
with `head -c N | tar ...`. tar then gets a clean EOF, exits on its own,
and its status is read from the error channel. Containers without /bin/sh
and head keep the previous behaviour and get a warning.
Also add copy_timeout (default 300s, #621) and stream the archive from the
temp file instead of buffering every chunk in memory.
* test(k8s_cp): split combined assert into separate statements
Addresses review feedback on #1217.
* chore(changelog): link the PR and use single-line fragment entries
* fix(linter): reformat with black
* fix(linter): sort imports in test_copy.py
isort --profile black puts ansible_collections in the same third-party
section as pytest, so the blank line between them is a failure.
* fix(k8s_cp): report what tar said when the copy fails early
An early close or a stall is the symptom; tar has usually already
written the cause (a read-only mount, a missing directory) to stderr,
and drain() has it. Discarding it left only the generic truncation or
timeout message.
* refactor(k8s_cp): move the stderr suffix into _fail
The nested fail() helper added a branch inside a closure, which counts
double for nesting and took _stream_tar_to_pod over Sonar's cognitive
complexity limit (14 -> 16). _fail already had the response; give it
the stderr too.
* test(k8s_cp): tempfile for the repeated-copy test directory
---------
(cherry picked from commit 8a9dd54fe7)
Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>
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.
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 |
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_registry_auth | Helm registry authentication module |
| 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 |
| kubernetes.core.kubeconfig | Generate, update, and optionally write Kubernetes kubeconfig files |
Requirements
Ansible version compatibility
This collection has been tested against the following Ansible versions: >=2.16.0.
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.
Helm Version Compatibility
This collection supports Helm v3.x and newer. Please note that specific modules or certain parameters may have additional version requirements.
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.
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: 6.5.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
Deprecated: Ansible Turbo mode (
ENABLE_TURBO_MODE) is deprecated and will be removed in a future major release (planned for 8.0.0), since it depends on thecloud.commoncollection, which is being retired. SettingENABLE_TURBO_MODEwill keep emitting a deprecation warning until support is removed, at which point the variable will have no effect.
Note: Ansible Turbo mode is supported only with
ansible-coreversions lower than 2.19. Starting fromansible-core2.19, thecloud.commoncollection is no longer supported, and therefore Ansible Turbo mode is also not supported inkubernetes.core. IfENABLE_TURBO_MODEis set to1(or any truthy value) withansible-core >= 2.19.0, Turbo mode is ignored and a warning is emitted; modules run without it.
The kubernetes.core collection supports Ansible Turbo mode as a tech preview via the cloud.common collection (requires ansible-core < 2.19). 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
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 set up a local cluster using KinD and run Molecule:
kind create cluster
make test-molecule
Contributing to this Collection
If you want to develop new content for this collection or improve what is already here, clone the Git repository into one of the configured COLLECTIONS_PATHS and work on it there.
See Contributing to kubernetes.core.
Join the Ansible community:
The Ansible Bullhorn newsletter announces releases and important changes. For more information, see the Ansible communication guide.
Code of Conduct
This project follows the Ansible Code of Conduct. If you encounter abusive behavior, see the policy violations section for how to raise a complaint.
Support
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 be community help available on the Ansible Forum.
Note: The
stable-4branch (all4.x.yreleases) is no longer supported. No backports or releases are performed onstable-4.
We announce releases and important changes through Ansible's The Bullhorn newsletter. Subscribe via this link.
We take part in the global quarterly Ansible Contributor Summit. Track The Bullhorn and join when announced.
For the latest supported versions, see Release Notes and Roadmap.
Report bugs, request features, or ask questions by opening an issue in the GitHub repository.
Release Notes and Roadmap
Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
- Update the version in the following places:
- The
versioningalaxy.yml - This README's
requirements.ymlexample - The
VERSIONinMakefile
- The
- Update the CHANGELOG:
- Make sure you have
antsibull-changeloginstalled. - Make sure there are fragments for all known changes in
changelogs/fragments. - Run
antsibull-changelog release.
- Make sure you have
- Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
- 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.
Related Information
- Using Ansible collections
- Ansible communication guide
- Continuous integration (CI) overview
- SonarCloud integration
- Ansible Turbo mode (tech preview)
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 Information
GNU General Public License v3.0 or later
See LICENSE to see the full text.