mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-03-26 21:33:02 +00:00
ba586a8ed8
* Rename from community.kubernetes to kubernetes.core This goes through and renames community.kubernetes to kubernetes.core. Most of this was generated from the downstream build script that was used on the community repository, plus whatever hand edits I could find that were needed. The downstream build and test process has also been removed as this repository is now the downstream repository. * Fix CONTRIBUTING.md
179 lines
7.8 KiB
Markdown
179 lines
7.8 KiB
Markdown
# Kubernetes Collection for Ansible
|
|
|
|
[](https://github.com/ansible-collections/kubernetes.core/actions) [](https://codecov.io/gh/ansible-collections/kubernetes.core)
|
|
|
|
This repo 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.
|
|
|
|
## Included content
|
|
|
|
Click on the name of a plugin or module to view that content's documentation:
|
|
|
|
- **Connection Plugins**:
|
|
- [kubectl](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/kubectl_connection.html)
|
|
- **Filter Plugins**:
|
|
- [k8s_config_resource_name](https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html#kubernetes-filters)
|
|
- **Inventory Source**:
|
|
- [k8s](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_inventory.html)
|
|
- [openshift](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/openshift_inventory.html)
|
|
- **Lookup Plugins**:
|
|
- [k8s](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_lookup.html)
|
|
- **Modules**:
|
|
- [k8s](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_module.html)
|
|
- [k8s_cluster_info](https://github.com/ansible-collections/kubernetes.core/blob/main/plugins/modules/k8s_cluster_info.py)
|
|
- [k8s_exec](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_exec_module.html)
|
|
- [k8s_info](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_info_module.html)
|
|
- [k8s_log](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_log_module.html)
|
|
- [k8s_scale](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_scale_module.html)
|
|
- [k8s_service](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_service_module.html)
|
|
- [helm](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/helm_module.html)
|
|
- [helm_info](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/helm_info_module.html)
|
|
- [helm_plugin](https://github.com/ansible-collections/kubernetes.core/blob/main/plugins/modules/helm_plugin.py)
|
|
- [helm_plugin_info](https://github.com/ansible-collections/kubernetes.core/blob/main/plugins/modules/helm_plugin_info.py)
|
|
- [helm_repository](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/helm_repository_module.html)
|
|
- [helm_template](https://github.com/ansible-collections/kubernetes.core/blob/main/plugins/modules/helm_template.py)
|
|
|
|
## 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:
|
|
|
|
```yaml
|
|
---
|
|
collections:
|
|
- name: kubernetes.core
|
|
version: 1.2.0
|
|
```
|
|
|
|
### Installing the OpenShift Python Library
|
|
|
|
Content in this collection requires the [OpenShift Python client](https://pypi.org/project/openshift/) to interact with Kubernetes' APIs. You can install it with:
|
|
|
|
pip3 install openshift
|
|
|
|
### 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`:
|
|
|
|
```yaml
|
|
---
|
|
- 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:
|
|
|
|
```yaml
|
|
---
|
|
- 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.
|
|
|
|
## 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`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
|
|
|
|
See [Contributing to kubernetes.core](CONTRIBUTING.md).
|
|
|
|
### Testing with `ansible-test`
|
|
|
|
The `tests` directory contains configuration for running sanity and integration tests using [`ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html).
|
|
|
|
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](https://kind.sigs.k8s.io) or [Minikube](https://minikube.sigs.k8s.io). 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`](https://pypi.org/project/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](https://galaxy.ansible.com/community/kubernetes).
|
|
|
|
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 Freenode IRC, and browse the resources in the [Kubernetes Working Group](https://github.com/ansible/community/wiki/Kubernetes) Community wiki page.
|
|
|
|
## License
|
|
|
|
GNU General Public License v3.0 or later
|
|
|
|
See LICENCE to see the full text.
|