mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-03-26 21:33:02 +00:00
Rename from community.kubernetes to kubernetes.core (#6)
* 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
This commit is contained in:
Mike Graves
GitHub
41
README.md
41
README.md
@@ -1,8 +1,8 @@
|
||||
# Kubernetes Collection for Ansible
|
||||
|
||||
[](https://github.com/ansible-collections/community.kubernetes/actions) [](https://codecov.io/gh/ansible-collections/community.kubernetes)
|
||||
[](https://github.com/ansible-collections/kubernetes.core/actions) [](https://codecov.io/gh/ansible-collections/kubernetes.core)
|
||||
|
||||
This repo hosts the `community.kubernetes` (a.k.a. `kubernetes.core`) Ansible Collection.
|
||||
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.
|
||||
|
||||
@@ -21,7 +21,7 @@ Click on the name of a plugin or module to view that content's documentation:
|
||||
- [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/community.kubernetes/blob/main/plugins/modules/k8s_cluster_info.py)
|
||||
- [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)
|
||||
@@ -29,10 +29,10 @@ Click on the name of a plugin or module to view that content's documentation:
|
||||
- [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/community.kubernetes/blob/main/plugins/modules/helm_plugin.py)
|
||||
- [helm_plugin_info](https://github.com/ansible-collections/community.kubernetes/blob/main/plugins/modules/helm_plugin_info.py)
|
||||
- [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/community.kubernetes/blob/main/plugins/modules/helm_template.py)
|
||||
- [helm_template](https://github.com/ansible-collections/kubernetes.core/blob/main/plugins/modules/helm_template.py)
|
||||
|
||||
## Installation and Usage
|
||||
|
||||
@@ -40,14 +40,14 @@ Click on the name of a plugin or module to view that content's documentation:
|
||||
|
||||
Before using the Kubernetes collection, you need to install it with the Ansible Galaxy CLI:
|
||||
|
||||
ansible-galaxy collection install community.kubernetes
|
||||
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: community.kubernetes
|
||||
- name: kubernetes.core
|
||||
version: 1.2.0
|
||||
```
|
||||
|
||||
@@ -59,7 +59,7 @@ Content in this collection requires the [OpenShift Python client](https://pypi.o
|
||||
|
||||
### 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 `community.kubernetes.k8s_info`:
|
||||
It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example `kubernetes.core.k8s_info`:
|
||||
|
||||
```yaml
|
||||
---
|
||||
@@ -69,14 +69,14 @@ It's preferable to use content in this collection using their Fully Qualified Co
|
||||
|
||||
tasks:
|
||||
- name: Ensure the myapp Namespace exists.
|
||||
community.kubernetes.k8s:
|
||||
kubernetes.core.k8s:
|
||||
api_version: v1
|
||||
kind: Namespace
|
||||
name: myapp
|
||||
state: present
|
||||
|
||||
- name: Ensure the myapp Service exists in the myapp Namespace.
|
||||
community.kubernetes.k8s:
|
||||
kubernetes.core.k8s:
|
||||
state: present
|
||||
definition:
|
||||
apiVersion: v1
|
||||
@@ -93,7 +93,7 @@ It's preferable to use content in this collection using their Fully Qualified Co
|
||||
app: myapp
|
||||
|
||||
- name: Get a list of all Services in the myapp namespace.
|
||||
community.kubernetes.k8s_info:
|
||||
kubernetes.core.k8s_info:
|
||||
kind: Service
|
||||
namespace: myapp
|
||||
register: myapp_services
|
||||
@@ -112,7 +112,7 @@ If upgrading older playbooks which were built prior to Ansible 2.10 and this col
|
||||
connection: local
|
||||
|
||||
collections:
|
||||
- community.kubernetes
|
||||
- kubernetes.core
|
||||
|
||||
tasks:
|
||||
- name: Ensure the myapp Namespace exists.
|
||||
@@ -129,7 +129,7 @@ For documentation on how to use individual modules and other content included in
|
||||
|
||||
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 community.kubernetes](CONTRIBUTING.md).
|
||||
See [Contributing to kubernetes.core](CONTRIBUTING.md).
|
||||
|
||||
### Testing with `ansible-test`
|
||||
|
||||
@@ -139,6 +139,7 @@ You can run the collection's test suites with the commands:
|
||||
|
||||
make test-sanity
|
||||
make test-integration
|
||||
make test-unit
|
||||
|
||||
### Testing with `molecule`
|
||||
|
||||
@@ -154,26 +155,16 @@ Releases are automatically built and pushed to Ansible Galaxy for any new tag. B
|
||||
1. Update the version in the following places:
|
||||
1. The `version` in `galaxy.yml`
|
||||
2. This README's `requirements.yml` example
|
||||
3. The `DOWNSTREAM_VERSION` in `utils/downstream.sh`
|
||||
4. The `VERSION` in `Makefile`
|
||||
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.
|
||||
5. Manually build and release the `kubernetes.core` collection (see following section).
|
||||
|
||||
After the version is published, verify it exists on the [Kubernetes Collection Galaxy page](https://galaxy.ansible.com/community/kubernetes).
|
||||
|
||||
### Publishing `kubernetes.core`
|
||||
|
||||
Until the contents of repository are moved into a new `kubernetes.core` repository on GitHub, this repository is the source of both the `kubernetes.core` and `community.kubernetes` repositories on Ansible Galaxy.
|
||||
|
||||
To publish the `kubernetes.core` collection on Ansible Galaxy, do the following:
|
||||
|
||||
1. Run `make downstream-release` (on macOS, add `LC_ALL=C` before the command).
|
||||
|
||||
The process for uploading a supported release to Automation Hub is documented separately.
|
||||
|
||||
## More Information
|
||||
|
||||
Reference in New Issue
Block a user