From 10b9f6634fa96db0d5069b089568ab215e1c8877 Mon Sep 17 00:00:00 2001 From: Felix Seifert Date: Wed, 3 Sep 2025 01:49:27 +0200 Subject: [PATCH] docs: describe adding collection to `requirements.yaml` (#438) Signed-off-by: Felix Seifert --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 18a988e..b51d7c9 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,17 @@ It is also recommended that all managed nodes disable firewalls and swap. See [K $ ansible-galaxy collection install git+https://github.com/k3s-io/k3s-ansible.git ``` +Alternatively, add it to the [`requirement.yaml` file of your Ansible project](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html#install-multiple-collections-with-a-requirements-file) as follows: + +```yaml +collections: + - name: https://github.com/k3s-io/k3s-ansible.git + type: git + version: +``` + +As a comit-ish, you can use a branch, a version tag, or a specific commit. + ### From source Alternatively to an installation with `ansible-galaxy`, the `k3s-ansible` repository can simply be cloned from github: