Skip to content

Commit 5c3d701

Browse files
author
Sebastian Gumprich
committed
update readme to reflect new role
1 parent f6b65f9 commit 5c3d701

2 files changed

Lines changed: 14 additions & 18 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@ Icinga Director Collection for Ansible
22
=========
33

44
[![ci-ansible-test](https://github.com/T-Systems-MMS/ansible-collection-icinga-director/workflows/ansible-test/badge.svg)](https://github.com/T-Systems-MMS/ansible-collection-icinga-director/actions?query=workflow%3Aansible-test)
5-
[![ci-ansible-lint](https://github.com/T-Systems-MMS/ansible-collection-icinga-director/workflows/Ansible%20Lint/badge.svg)](https://github.com/T-Systems-MMS/ansible-collection-icinga-director/actions?query=workflow%3A%22Ansible+Lint%22)
65

7-
This collection contains Ansible modules to change objects in Icinga 2 using the director API.
6+
This collection contains Ansible [modules](plugins/modules/) and a [role](roles/ansible-icinga/) to change objects in Icinga 2 using the director API.
87

98
Required Ansible version: 2.9
109

@@ -42,8 +41,8 @@ collections:
4241
- t_systems_mms.icinga_director
4342
```
4443

45-
Examples
46-
--------
44+
Examples using the modules
45+
--------------------------
4746

4847
See the `examples` directory for a complete list of examples.
4948

@@ -69,6 +68,11 @@ See the `examples` directory for a complete list of examples.
6968
dnscheck: "no"
7069
```
7170

71+
Examples using the role
72+
-----------------------
73+
74+
Please see the [README](roles/ansible-icinga/README.md) of the role.
75+
7276
Troubleshooting
7377
---------------
7478

@@ -107,3 +111,4 @@ Author Information
107111

108112
* Sebastian Gumprich
109113
* Lars Krahl
114+
* Michaela Mattes

roles/ansible-icinga/README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,12 @@ collections:
1212
- name: t_systems_mms.icinga_director
1313
src: https://github.com/T-Systems-MMS/ansible-collection-icinga-director
1414
version: 1.2.2
15-
16-
roles:
17-
- name: icinga
18-
src: https://github.com/T-Systems-MMS/ansible-collection-icinga-director
19-
version: 1.2.3
2015
```
2116

2217
* install the collections:
2318

2419
```bash
2520
ansible-galaxy collection install -r requirements.yml -p collections/
26-
ansible-galaxy install -r requirements.yml
2721
```
2822

2923
## Dependencies
@@ -152,14 +146,15 @@ t_systems_mms.icinga_director >= 1.2.2
152146
```bash
153147
---
154148
- hosts: localhost
155-
connection: local
156149
gather_facts: false
150+
collections:
151+
- t_systems_mms.icinga_director
157152
roles:
158-
- icinga
153+
- ansible-icinga
159154
vars:
160155
icinga_url: "https://example.com"
161-
icinga_user: xxx
162-
icinga_pass: xxx
156+
icinga_user: "{{ icinga_user }}"
157+
icinga_pass: "{{ icinga_pass }}"
163158
icinga_timeperiods:
164159
- timeperiod_object:
165160
- "8x5"
@@ -195,7 +190,3 @@ t_systems_mms.icinga_director >= 1.2.2
195190
- host_object:
196191
- "service_abbreviation-environement-web01"
197192
```
198-
199-
## Contributing
200-
201-
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

0 commit comments

Comments
 (0)