Skip to content

Commit fdb8af7

Browse files
Update Readme to match the template (ansible-collections#767)
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
1 parent a89f19b commit fdb8af7

File tree

2 files changed

+49
-16
lines changed

2 files changed

+49
-16
lines changed

README.md

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# Kubernetes Collection for Ansible
22

3-
[![Linters](https://img.shields.io/github/actions/workflow/status/ansible-collections/kubernetes.core/linters.yaml?label=linters)](https://github.com/ansible-collections/kubernetes.core/actions/workflows/linters.yaml) [![Integration tests](https://img.shields.io/github/actions/workflow/status/ansible-collections/kubernetes.core/integration-tests.yaml?label=integration%20tests)](https://github.com/ansible-collections/kubernetes.core/actions/workflows/integration-tests.yaml) [![Sanity tests](https://img.shields.io/github/actions/workflow/status/ansible-collections/kubernetes.core/sanity-tests.yaml?label=sanity%20tests)](https://github.com/ansible-collections/kubernetes.core/actions/workflows/sanity-tests.yaml) [![Unit tests](https://img.shields.io/github/actions/workflow/status/ansible-collections/kubernetes.core/unit-tests.yaml?label=unit%20tests)](https://github.com/ansible-collections/kubernetes.core/actions/workflows/unit-tests.yaml) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/kubernetes.core)](https://app.codecov.io/gh/ansible-collections/kubernetes.core)
4-
53
This repository hosts the `kubernetes.core` (formerly known as `community.kubernetes`) Ansible Collection.
64

5+
## Description
6+
77
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.
88

9+
## Requirements
10+
911
<!--start requires_ansible-->
10-
## Ansible version compatibility
12+
### Ansible version compatibility
1113

1214
This collection has been tested against following Ansible versions: **>=2.15.0**.
1315

@@ -18,43 +20,43 @@ A collection may contain metadata that identifies these versions.
1820
PEP440 is the schema used to describe the versions of Ansible.
1921
<!--end requires_ansible-->
2022

21-
## Python Support
23+
### Python Support
2224

2325
* Collection supports 3.9+
2426

2527
Note: Python2 is deprecated from [1st January 2020](https://www.python.org/doc/sunset-python-2/). Please switch to Python3.
2628

27-
## Kubernetes Version Support
29+
### Kubernetes Version Support
2830

2931
This collection supports Kubernetes versions >= 1.24.
3032

31-
## Included content
33+
### Included content
3234

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

3537
<!--start collection content-->
36-
### Connection plugins
38+
#### Connection plugins
3739
Name | Description
3840
--- | ---
3941
[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.
4042

41-
### K8s filter plugins
43+
#### K8s filter plugins
4244
Name | Description
4345
--- | ---
4446
kubernetes.core.k8s_config_resource_name|Generate resource name for the given resource of type ConfigMap, Secret
4547

46-
### Inventory plugins
48+
#### Inventory plugins
4749
Name | Description
4850
--- | ---
4951
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_inventory.rst)|Kubernetes (K8s) inventory source
5052

51-
### Lookup plugins
53+
#### Lookup plugins
5254
Name | Description
5355
--- | ---
5456
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API
5557
[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.
5658

57-
### Modules
59+
#### Modules
5860
Name | Description
5961
--- | ---
6062
[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
7981

8082
<!--end collection content-->
8183

82-
## Installation and Usage
83-
84-
### Installing the Collection from Ansible Galaxy
84+
## Installation
8585

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

@@ -102,7 +102,7 @@ Content in this collection requires the [Kubernetes Python client](https://pypi.
102102
103103
pip3 install kubernetes
104104
105-
### Using modules from the Kubernetes Collection in your playbooks
105+
## Use Cases
106106
107107
It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example `kubernetes.core.k8s_info`:
108108

@@ -189,12 +189,16 @@ defined in the playbook using `environment` keyword as above, you must set it us
189189

190190
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/ansible_turbo_mode.rst).
191191

192-
## Testing and Development
192+
## Contributing to this collection
193193

194194
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.
195195

196196
See [Contributing to kubernetes.core](CONTRIBUTING.md).
197197

198+
## Testing
199+
200+
[![Linters](https://img.shields.io/github/actions/workflow/status/ansible-collections/kubernetes.core/linters.yaml?label=linters)](https://github.com/ansible-collections/kubernetes.core/actions/workflows/linters.yaml) [![Integration tests](https://img.shields.io/github/actions/workflow/status/ansible-collections/kubernetes.core/integration-tests.yaml?label=integration%20tests)](https://github.com/ansible-collections/kubernetes.core/actions/workflows/integration-tests.yaml) [![Sanity tests](https://img.shields.io/github/actions/workflow/status/ansible-collections/kubernetes.core/sanity-tests.yaml?label=sanity%20tests)](https://github.com/ansible-collections/kubernetes.core/actions/workflows/sanity-tests.yaml) [![Unit tests](https://img.shields.io/github/actions/workflow/status/ansible-collections/kubernetes.core/unit-tests.yaml?label=unit%20tests)](https://github.com/ansible-collections/kubernetes.core/actions/workflows/unit-tests.yaml) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/kubernetes.core)](https://app.codecov.io/gh/ansible-collections/kubernetes.core)
201+
198202
### Testing with `ansible-test`
199203

200204
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
231235

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

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+
234257
## More Information
235258

236259
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.
237260

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.
266+
267+
238268
## License
239269

240270
GNU General Public License v3.0 or later
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
trivial:
3+
- Update the README doc to match https://access.redhat.com/articles/7068606.

0 commit comments

Comments
 (0)