Skip to content

docs: fix incorrect Ansible paths and standardize inventory references#13246

Open
jsuchome wants to merge 1 commit into
kubernetes-sigs:masterfrom
jsuchome:docs/ansible-paths
Open

docs: fix incorrect Ansible paths and standardize inventory references#13246
jsuchome wants to merge 1 commit into
kubernetes-sigs:masterfrom
jsuchome:docs/ansible-paths

Conversation

@jsuchome
Copy link
Copy Markdown

@jsuchome jsuchome commented May 9, 2026

Update documentation across several files to correct broken file paths and ensure consistency in Ansible command examples

  • Standardized inventory naming to inventory.ini for sample inventories.
  • Fixed group_vars paths to reflect the actual directory structure (e.g., group_vars/all/all.yml instead of group_vars/all.yml).
  • Corrected the k8s-cluster.yml filename in guides.
  • Clarified the location for kubectl_localhost and kubeconfig_localhost settings.
  • Replaced non-existent placeholders (like inventory/single.cfg) with valid repository paths.
  • Fixed typos in directory names (e.g., myclsuter -> mycluster).

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Fixes the ansible related documentation

Which issue(s) this PR fixes:

Fixes #13245

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. kind/documentation Categorizes issue or PR as related to documentation. labels May 9, 2026
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented May 9, 2026

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: jsuchome / name: Jiri Suchomel (5cca0ab)

@k8s-ci-robot k8s-ci-robot requested review from mzaian and tico88612 May 9, 2026 19:44
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @jsuchome!

It looks like this is your first PR to kubernetes-sigs/kubespray 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubespray has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jsuchome
Once this PR has been reviewed and has the lgtm label, please assign ant31 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 9, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @jsuchome. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 9, 2026
This commit updates documentation across several files to correct broken
file paths and ensure consistency in Ansible command examples

- Standardized inventory naming to `inventory.ini` for sample inventories.
- Fixed `group_vars` paths to reflect the actual directory structure
  (e.g., `group_vars/all/all.yml` instead of `group_vars/all.yml`).
- Corrected the `k8s-cluster.yml` filename in guides.
- Clarified the location for `kubectl_localhost` and `kubeconfig_localhost` settings.
- Replaced non-existent placeholders (like `inventory/single.cfg`) with
  valid repository paths.
- Fixed typos in directory names (e.g., `myclsuter` -> `mycluster`).
@jsuchome jsuchome force-pushed the docs/ansible-paths branch from 65e757b to 5cca0ab Compare May 9, 2026 19:51
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label May 9, 2026
@yankay
Copy link
Copy Markdown
Member

yankay commented May 10, 2026

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels May 10, 2026
@guoard
Copy link
Copy Markdown
Contributor

guoard commented May 14, 2026

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: ansible commands referring to wrong paths

4 participants