You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
SUMMARY
Refer: https://issues.redhat.com/browse/ACA-1749
This PR updates the README doc to match the template
ISSUE TYPE
Bugfix Pull Request
Docs Pull Request
Feature Pull Request
New Module Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION
Reviewed-by: Alina Buzachis
This repository hosts the `kubernetes.core` (formerly known as `community.kubernetes`) Ansible Collection.
6
4
5
+
## Description
6
+
7
7
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.
8
8
9
+
## Requirements
10
+
9
11
<!--start requires_ansible-->
10
-
## Ansible version compatibility
12
+
###Ansible version compatibility
11
13
12
14
This collection has been tested against following Ansible versions: **>=2.15.0**.
13
15
@@ -18,43 +20,43 @@ A collection may contain metadata that identifies these versions.
18
20
PEP440 is the schema used to describe the versions of Ansible.
19
21
<!--end requires_ansible-->
20
22
21
-
## Python Support
23
+
###Python Support
22
24
23
25
* Collection supports 3.9+
24
26
25
27
Note: Python2 is deprecated from [1st January 2020](https://www.python.org/doc/sunset-python-2/). Please switch to Python3.
26
28
27
-
## Kubernetes Version Support
29
+
###Kubernetes Version Support
28
30
29
31
This collection supports Kubernetes versions >= 1.24.
30
32
31
-
## Included content
33
+
###Included content
32
34
33
35
Click on the name of a plugin or module to view that content's documentation:
34
36
35
37
<!--start collection content-->
36
-
### Connection plugins
38
+
####Connection plugins
37
39
Name | Description
38
40
--- | ---
39
41
[kubernetes.core.kubectl](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes.
40
42
41
-
### K8s filter plugins
43
+
####K8s filter plugins
42
44
Name | Description
43
45
--- | ---
44
46
kubernetes.core.k8s_config_resource_name|Generate resource name for the given resource of type ConfigMap, Secret
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API
55
57
[kubernetes.core.kustomize](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kustomize_lookup.rst)|Build a set of kubernetes resources using a 'kustomization.yaml' file.
56
58
57
-
### Modules
59
+
####Modules
58
60
Name | Description
59
61
--- | ---
60
62
[kubernetes.core.helm](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_module.rst)|Manages Kubernetes packages with the Helm package manager
@@ -79,9 +81,7 @@ Name | Description
79
81
80
82
<!--end collection content-->
81
83
82
-
## Installation and Usage
83
-
84
-
### Installing the Collection from Ansible Galaxy
84
+
## Installation
85
85
86
86
Before using the Kubernetes collection, you need to install it with the Ansible Galaxy CLI:
87
87
@@ -102,7 +102,7 @@ Content in this collection requires the [Kubernetes Python client](https://pypi.
102
102
103
103
pip3 install kubernetes
104
104
105
-
### Using modules from the Kubernetes Collection in your playbooks
105
+
## Use Cases
106
106
107
107
It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example `kubernetes.core.k8s_info`:
108
108
@@ -189,12 +189,16 @@ defined in the playbook using `environment` keyword as above, you must set it us
189
189
190
190
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/ansible_turbo_mode.rst).
191
191
192
-
## Testing and Development
192
+
## Contributing to this collection
193
193
194
194
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.
195
195
196
196
See [Contributing to kubernetes.core](CONTRIBUTING.md).
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).
@@ -231,10 +235,36 @@ After the version is published, verify it exists on the [Kubernetes Collection G
231
235
232
236
The process for uploading a supported release to Automation Hub is documented separately.
233
237
238
+
## Support
239
+
240
+
<!--List available communication channels. In addition to channels specific to your collection, we also recommend to use the following ones.-->
241
+
242
+
We announce releases and important changes through Ansible's [The Bullhorn newsletter](https://github.com/ansible/community/wiki/News#the-bullhorn). Be sure you are [subscribed](https://eepurl.com/gZmiEP).
243
+
244
+
We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://eepurl.com/gZmiEP) and join us.
245
+
246
+
For more information about communication, refer to the [Ansible Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
247
+
248
+
For the latest supported versions, refer to the release notes below.
249
+
250
+
If you encounter issues or have questions, you can submit a support request through the following channels:
251
+
- GitHub Issues: Report bugs, request features, or ask questions by opening an issue in the [GitHub repository]((https://github.com/ansible-collections/kubernetes.core/).
252
+
253
+
## Release notes
254
+
255
+
See the [raw generated changelog](https://github.com/ansible-collections/kubernetes.core/blob/main/CHANGELOG.rst).
256
+
234
257
## More Information
235
258
236
259
For more information about Ansible's Kubernetes integration, join the `#ansible-kubernetes` channel on [libera.chat](https://libera.chat/) IRC, and browse the resources in the [Kubernetes Working Group](https://github.com/ansible/community/wiki/Kubernetes) Community wiki page.
237
260
261
+
## Code of Conduct
262
+
263
+
We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project.
264
+
265
+
If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint.
0 commit comments