Skip to content

Commit f63be2c

Browse files
committed
docs(readme): add installation, configuration, and usage sections
1 parent a4b4358 commit f63be2c

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,47 @@ This Ansible collection provides a set of roles designed for configuring Kubuntu
1313
| [xebis.ansible.system](roles/system/README.md) | System-related tasks such as reboot handler or reboot when required handler. | |
1414
| [`xebis.ansible.users`](roles/users/README.md) | Ansible role for managing system users. | `xebis.ansible.openssh_server` |
1515

16+
## Installation and Configuration
17+
18+
Add to `requirements.yaml`:
19+
20+
```yaml
21+
---
22+
collections:
23+
- name: git+https://github.com/xebis/ansible-collection.git,main
24+
```
25+
26+
Install dependencies:
27+
28+
```shell
29+
ansible-galaxy collection install -r requirements.yaml
30+
```
31+
32+
## Usage
33+
34+
Create an Ansible playbook:
35+
36+
```yaml
37+
---
38+
- hosts: all
39+
roles:
40+
- role: xebis.ansible.apt
41+
vars:
42+
autoclean: true
43+
autoremove: true
44+
cache_valid_time: 3600
45+
purge: true
46+
upgrade: "full"
47+
```
48+
49+
Refer to the example playbook [test.yaml](test.yaml) for additional inspiration.
50+
51+
Run the Ansible playbook:
52+
53+
```shell
54+
ansible-playbook -i localhost, playbook.yaml
55+
```
56+
1657
## Contributing
1758

1859
### Development

0 commit comments

Comments
 (0)