kubespray/docs/ansible_collection.md

Ansible collection

Kubespray can be installed as an Ansible collection.

Requirements

• An inventory file with the appropriate host groups. See the README.
• A group_vars directory. These group variables need to match the appropriate variable names under inventory/local/group_vars. See the README.

Usage

1. Add Kubespray to your requirements.yml file

   collections:
   - name: https://github.com/kubernetes-sigs/kubespray
     type: git
     version: v2.23.0
   

2. Install your collection

   ansible-galaxy install -r requirements.yml
   

3. Create a playbook to install your Kubernetes cluster

   - 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

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