Skip to content

Commit 19f53d0

Browse files
committed
docs: describe usage and how to use the collection
1 parent e4af516 commit 19f53d0

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A collection of roles to manage Linux-based development clients.
44

5-
[![Test](https://github.com/karras/ansible-collection-linux_client/actions/workflows/test.yml/badge.svg)](https://github.com/karras/ansible-collection-linux_client/actions/workflows/test.yml)[![Release](https://github.com/karras/ansible-collection-linux_client/actions/workflows/release.yml/badge.svg)](https://github.com/karras/ansible-collection-linux_client/actions/workflows/release.yml)
5+
[![Test](https://github.com/karras/ansible-collection-linux_client/actions/workflows/test.yml/badge.svg)](https://github.com/karras/ansible-collection-linux_client/actions/workflows/test.yml) [![Release](https://github.com/karras/ansible-collection-linux_client/actions/workflows/release.yml/badge.svg)](https://github.com/karras/ansible-collection-linux_client/actions/workflows/release.yml)
66

77
## Compatibility
88

@@ -28,7 +28,45 @@ some more complex tasks structures though.
2828

2929
## Usage
3030

31-
TODO
31+
Follow the below steps to start using the collection:
32+
33+
* Install the latest collection version:
34+
35+
```sh
36+
ansible-galaxy collection install karras.linux_client
37+
```
38+
39+
* Create a new playbook (e.g. `client.yml`) which includes the desired roles:
40+
41+
```yaml
42+
---
43+
44+
- name: deploy and manage linux clients
45+
hosts: all
46+
become: yes
47+
roles:
48+
- karras.linux_client.os_baseline
49+
- karras.linux_client.hardware
50+
- karras.linux_client.users
51+
- karras.linux_client.greetd
52+
- karras.linux_client.wayfire
53+
- karras.linux_client.desktop_baseline
54+
- karras.linux_client.networkmanager
55+
- karras.linux_client.firewalld
56+
```
57+
58+
* Define an inventory, in this case Ansible is executed against localhost:
59+
60+
```ini
61+
[dev]
62+
testclient ansible_connection=local
63+
```
64+
65+
* Finally run the playbook:
66+
67+
```sh
68+
ansible-playbook client.yml -i inventory -K
69+
```
3270

3371
## License
3472

0 commit comments

Comments
 (0)