epostnikof/kubespray
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kubespray.git synced 2025-12-13 21:34:40 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Ansible Collection 404s (#12376)

Browse Source 
* docs: remove obsolete reference to `gen_tags.sh`

`scripts/gen_tags.sh` was removed in 373b952a0c

* 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.
This commit is contained in:
Elias Probst
2025-07-07 12:01:25 +02:00
committed by GitHub
parent 3311ceaa7b
commit 6ca9f1f731
2 changed files with 8 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/ansible/ansible.md
View File

@@ -155,10 +155,6 @@ The following tags are defined in playbooks:
| win_nodes | Running windows specific tasks | | win_nodes | Running windows specific tasks |
| youki | Configuring youki runtime | | 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 commands
Example command to filter and apply only DNS configuration tasks and skip Example command to filter and apply only DNS configuration tasks and skip

17
docs/ansible/ansible_collection.md
View File

@@ -2,14 +2,13 @@
Kubespray can be installed as an [Ansible collection](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html). 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 ## 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 ```yaml
collections: 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 version: master # use the appropriate tag or branch for the version you need
``` ```
2. Install your collection 3. Install your collection
```ShellSession ```ShellSession
ansible-galaxy install -r requirements.yml 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 ```yaml
- name: Install Kubernetes - name: Install Kubernetes
ansible.builtin.import_playbook: kubernetes_sigs.kubespray.cluster 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 ```ShellSession
ansible-playbook -i INVENTORY --become --become-user=root PLAYBOOK ansible-playbook -i INVENTORY --become --become-user=root PLAYBOOK