Remove inventory_builder and re-organize docs #11748
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This only really help with the easiest part of building your inventory (listing the hosts) as you still need to edit your groups vars and similar. The opaqueness of the script does not really help our users to understand their own inventory. Furthermore, there is not really a reason that something which is common to all the Ansible ecosystem should be done in a special way for Kubespray.
contrib/dind use inventory_builder, which is removed. It overlaps with the function of kind (Kubernetes in Docker) and has not see change (apart from linting driven ones) for a long time. It also does not seem to work (provisioning playbook crash).
There is no need to repeat the full example here, simply state what variables are.
- The bastion is not needed for a simple example - All is implicit we can just define our host in groups directly
Our README is currently pretty cluttered: - Part of the README duplicates docs/getting_started/getting-started.md -> Remove duplicates and extract useful info into the getting-started.md - General info on Ansible environment troubleshooting -> remove most of it as it's not specific to Kubespray, move to docs/ansible/ansible.md -> split inventory-related stuff of ansible.md into it's own file. This should host documentation on how to manages Kubespray inventories in the future. ansible.md: - remove the list of "Unused" variables, as: 1. It's not accurate 2. What matters is where users should put their variables
k8s-ci-robot
added
release-note
|
/ok-to-test |
k8s-ci-robot
added
approved
|
thanks |
tico88612
approved these changes
Nov 27, 2024
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ant31, tico88612, VannTen The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This was referenced Dec 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind cleanup
/kind documentation
What this PR does / why we need it:
-> this should be a first step towards:
-> unless there is know users of this, I don't think we should keep it given the overlap with kind.
Does this PR introduce a user-facing change?:
/label ci-short
/label tide/merge-method-merge
/cc @MrFreezeex @ant31 @tico88612