Skip to content

docs: describe adding collection to requirements.yaml #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dereknola merged 1 commit into from
Sep 2, 2025
Merged

docs: describe adding collection to requirements.yaml #438

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <comit-ish>
```

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:
Expand Down
Loading