From 6ca9f1f731aff15a44ad09ae1f6a8f3e6eef57cc Mon Sep 17 00:00:00 2001 From: Elias Probst Date: Mon, 7 Jul 2025 12:01:25 +0200 Subject: [PATCH] docs: Ansible Collection 404s (#12376) * docs: remove obsolete reference to `gen_tags.sh` `scripts/gen_tags.sh` was removed in 373b952a0cd23cbf185ba12ca317631e1ea88dda * docs: fix 404 links Merge the `Requirements` section with the `Usage` section and just reference the inventory documentation, which then points to all further information related to group vars etc. --- docs/ansible/ansible.md | 4 ---- docs/ansible/ansible_collection.md | 17 ++++++++--------- 2 files changed, 8 insertions(+), 13 deletions(-) diff --git a/docs/ansible/ansible.md b/docs/ansible/ansible.md index 9c23b9b4e..8bf5a73b0 100644 --- a/docs/ansible/ansible.md +++ b/docs/ansible/ansible.md @@ -155,10 +155,6 @@ The following tags are defined in playbooks: | win_nodes | Running windows specific tasks | | youki | Configuring youki runtime | -Note: Use the ``bash scripts/gen_tags.sh`` command to generate a list of all -tags found in the codebase. New tags will be listed with the empty "Used for" -field. - ## Example commands Example command to filter and apply only DNS configuration tasks and skip diff --git a/docs/ansible/ansible_collection.md b/docs/ansible/ansible_collection.md index bcf23baa3..64aa0e0f3 100644 --- a/docs/ansible/ansible_collection.md +++ b/docs/ansible/ansible_collection.md @@ -2,14 +2,13 @@ Kubespray can be installed as an [Ansible collection](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html). -## Requirements - -- An inventory file with the appropriate host groups. See the [README](../README.md#usage). -- A `group_vars` directory. These group variables **need** to match the appropriate variable names under `inventory/local/group_vars`. See the [README](../README.md#usage). - ## Usage -1. Add Kubespray to your requirements.yml file +1. Set up an inventory with the appropriate host groups and required group vars. + See also the documentation on [kubespray inventories](./inventory.md) and the + general ["Getting started" documentation](../getting_started/getting-started.md#building-your-own-inventory). + +2. Add Kubespray to your requirements.yml file ```yaml collections: @@ -18,20 +17,20 @@ Kubespray can be installed as an [Ansible collection](https://docs.ansible.com/a version: master # use the appropriate tag or branch for the version you need ``` -2. Install your collection +3. Install your collection ```ShellSession ansible-galaxy install -r requirements.yml ``` -3. Create a playbook to install your Kubernetes cluster +4. Create a playbook to install your Kubernetes cluster ```yaml - name: Install Kubernetes ansible.builtin.import_playbook: kubernetes_sigs.kubespray.cluster ``` -4. Update INVENTORY and PLAYBOOK so that they point to your inventory file and the playbook you created above, and then install Kubespray +5. Update INVENTORY and PLAYBOOK so that they point to your inventory file and the playbook you created above, and then install Kubespray ```ShellSession ansible-playbook -i INVENTORY --become --become-user=root PLAYBOOK