Skip to content

docs: add until example to k8s_info #885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MindTooth
Copy link

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.

Copy link

@MindTooth MindTooth marked this pull request as draft March 16, 2025 14:34
@MindTooth MindTooth force-pushed the docs/add_example_k8s_info branch from fe88e3d to 9627925 Compare March 16, 2025 15:25
Copy link

@MindTooth MindTooth marked this pull request as ready for review March 16, 2025 16:17
@yurnov
Copy link
Contributor

yurnov commented Mar 16, 2025

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

@MindTooth
Copy link
Author

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.

@MindTooth MindTooth force-pushed the docs/add_example_k8s_info branch from 9627925 to c25408d Compare March 27, 2025 22:03
@MindTooth
Copy link
Author

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:

I would liked to have an example like this when I was using the
documentation.
@MindTooth MindTooth force-pushed the docs/add_example_k8s_info branch from c25408d to 66aac95 Compare March 27, 2025 22:06
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants