Files
kubespray/docs/ansible/ansible_collection.md
Elias Probst 6ca9f1f731 docs: Ansible Collection 404s (#12376)
* 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.
2025-07-07 03:01:25 -07:00

1.2 KiB

Ansible collection

Kubespray can be installed as an Ansible collection.

Usage

  1. Set up an inventory with the appropriate host groups and required group vars. See also the documentation on kubespray inventories and the general "Getting started" documentation.

  2. Add Kubespray to your requirements.yml file

    collections:
    - name: https://github.com/kubernetes-sigs/kubespray
      type: git
      version: master # use the appropriate tag or branch for the version you need
    
  3. Install your collection

    ansible-galaxy install -r requirements.yml
    
  4. Create a playbook to install your Kubernetes cluster

    - name: Install Kubernetes
      ansible.builtin.import_playbook: kubernetes_sigs.kubespray.cluster
    
  5. Update INVENTORY and PLAYBOOK so that they point to your inventory file and the playbook you created above, and then install Kubespray

    ansible-playbook -i INVENTORY --become --become-user=root PLAYBOOK