kubernetes.core
kubernetes.core copied to clipboard
docs: add until example to k8s_info
SUMMARY
I would liked to have an example like this when I was using the documentation.
The concrete example helps you to check when the OpenShift bootstrap process is done. Instead of running the command openshift-install wait-for bootstrap-complete, we use the Ansible way of using a module.
ISSUE TYPE
- Docs Pull Request
COMPONENT NAME
kubernetes.core.k8s_info
ADDITIONAL INFORMATION
N/A.
Build succeeded. https://ansible.softwarefactory-project.io/zuul/buildset/5e2132a8d7e04fbd849d622557cebf03
:heavy_check_mark: ansible-galaxy-importer SUCCESS in 3m 53s :heavy_check_mark: build-ansible-collection SUCCESS in 5m 27s
Build succeeded. https://ansible.softwarefactory-project.io/zuul/buildset/849047842f064ae9a419e20df1a1a436
:heavy_check_mark: ansible-galaxy-importer SUCCESS in 4m 08s :heavy_check_mark: build-ansible-collection SUCCESS in 5m 40s
I'm not sure that it is worth having in the documentation as it is quite apparent and intuitive.
However, if you think that this part should be here, please follow the contribution guideline and update the documentation https://github.com/ansible-collections/kubernetes.core/blob/main/CONTRIBUTING.md#updating-documentation
I'm not sure that it is worth having in the documentation as it is quite apparent and intuitive.
Maybe, but as a new Ansible user, I kind to like having suggestions that shows a bit extra. You can say it's intuitive, but that's after some time working with Ansible. For me a lot of trial and error when a good doc could show me a bit more "verbose" example. My two cents.
If you don't think you'll include it, I'm happy to close the PR.
Updated using the doc prep.
Noticed an outdated doc:
diff --git a/docs/kubernetes.core.k8s_drain_module.rst b/docs/kubernetes.core.k8s_drain_module.rst
index 95f8271..995e911 100644
--- a/docs/kubernetes.core.k8s_drain_module.rst
+++ b/docs/kubernetes.core.k8s_drain_module.rst
@@ -595,7 +595,8 @@ Examples
kubernetes.core.k8s_drain:
state: drain
name: foo
- force: yes
+ delete_options:
+ force: yes
- name: Drain node "foo", but abort if there are pods not managed by a ReplicationController, Job, or DaemonSet, and use a grace period of 15 minutes.
kubernetes.core.k8s_drain:
Build succeeded. https://ansible.softwarefactory-project.io/zuul/buildset/1102296aece14f3baa0edf0ccd979f63
:heavy_check_mark: ansible-galaxy-importer SUCCESS in 4m 11s :heavy_check_mark: build-ansible-collection SUCCESS in 5m 17s
Build succeeded. https://ansible.softwarefactory-project.io/zuul/buildset/fc7c77de7b6b471c89a71aa9bda66bbe
:heavy_check_mark: ansible-galaxy-importer SUCCESS in 3m 38s :heavy_check_mark: build-ansible-collection SUCCESS in 6m 04s