1bcd7395fa
* Bump galaxy.yml to next expected version * Refactor check_galaxy + fix version (#10729) * Remove checks for docs using exact tags Instead use a more generic documentation for installing kubespray as a collection from git. * Check that we upgraded galaxy.yml to next version This is only intented to check for human error. The version in galaxy should be the next (which does not mean the same if we're on master or a release branch). * Set collection version to KUBESPRAY_NEXT_VERSION
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
# Ansible collection
|
|
|
|
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
|
|
|
|
```yaml
|
|
collections:
|
|
- name: https://github.com/kubernetes-sigs/kubespray
|
|
type: git
|
|
version: master # use the appropriate tag or branch for the version you need
|
|
```
|
|
|
|
2. Install your collection
|
|
|
|
```ShellSession
|
|
ansible-galaxy install -r requirements.yml
|
|
```
|
|
|
|
3. 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
|
|
|
|
```ShellSession
|
|
ansible-playbook -i INVENTORY --become --become-user=root PLAYBOOK
|
|
```
|