1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2019, Paul Arthur <paul.arthur@flowerysong.com>
# Copyright: (c) 2019, XLAB Steampunk <steampunk@xlab.si>
#
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {
"metadata_version": "1.1",
"status": ["stableinterface"],
"supported_by": "certified",
}
DOCUMENTATION = '''
module: entity
author:
- Paul Arthur (@flowerysong)
- Aljaz Kosir (@aljazkosir)
- Miha Plesko (@miha-plesko)
- Tadej Borovsak (@tadeboro)
short_description: Manage Sensu entities
description:
- Create, update or delete Sensu entity.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/entities/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
- sensu.sensu_go.auth
- sensu.sensu_go.name
- sensu.sensu_go.namespace
- sensu.sensu_go.state
- sensu.sensu_go.labels
- sensu.sensu_go.annotations
seealso:
- module: sensu.sensu_go.entity_info
options:
entity_class:
description:
- Entity class. Standard classes are C(proxy) and C(agent), but you can
use whatever you want.
- Required if I(state) is C(present).
type: str
subscriptions:
description:
- List of subscriptions for the entity.
type: list
elements: str
system:
description:
- System information about the entity, such as operating system and platform. See
U(https://docs.sensu.io/sensu-go/5.13/reference/entities/#system-attributes) for more information.
type: dict
last_seen:
description:
- Timestamp the entity was last seen, in seconds since the Unix epoch.
type: int
deregister:
description:
- If the entity should be removed when it stops sending keepalive messages.
type: bool
deregistration_handler:
description:
- The name of the handler to be called when an entity is deregistered.
type: str
redact:
description:
- List of items to redact from log messages. If a value is provided,
it overwrites the default list of items to be redacted.
type: list
elements: str
user:
description:
- Sensu RBAC username used by the entity. Agent entities require get,
list, create, update, and delete permissions for events across all namespaces.
type: str
'''
EXAMPLES = '''
- name: Create an entity
sensu.sensu_go.entity:
auth:
url: http://localhost:8080
name: entity
entity_class: proxy
subscriptions:
- web
- prod
system:
hostname: playbook-entity
os: linux
platform: ubutntu
network:
interfaces:
- name: lo
addresses:
- 127.0.0.1/8
- ::1/128
- name: eth0
mac: 52:54:00:20:1b:3c
addresses:
- 93.184.216.34/24
last_seen: 1522798317
deregister: yes
deregistration_handler: email-handler
redact:
- password
- pass
- api_key
user: agent
- name: Delete an entity
sensu.sensu_go.entity:
name: entity
state: absent
'''
RETURN = '''
object:
description: Object representing Sensu entity.
returned: success
type: dict
sample:
metadata:
annotations: null
labels: null
name: webserver01
namespace: default
deregister: false
deregistration: {}
entity_class: agent
last_seen: 1542667231
redact:
- password
- private_key
- secret
subscriptions:
- entity:webserver01
system:
arch: amd64
libc_type: glibc
vm_system: kvm
vm_role: host
cloud_provider: null
network:
interfaces:
- addresses:
- 127.0.0.1/8
- ::1/128
name: lo
- addresses:
- 172.28.128.3/24
- fe80::a00:27ff:febc:be60/64
mac: 08:00:27:bc:be:60
name: enp0s8
os: linux
platform: centos
platform_family: rhel
platform_version: 7.4.1708
sensu_agent_version: 1.0.0
user: agent
'''
from ansible.module_utils.basic import AnsibleModule
from ..module_utils import arguments, errors, utils
def do_differ(current, desired):
system = desired.get('system')
if system and utils.do_differ(current.get('system'), system):
return True
subs = desired.get('subscriptions')
if subs is not None and set(subs) != set(current.get('subscriptions', [])):
return True
return utils.do_differ(current, desired, 'system', 'subscriptions')
def main():
required_if = [
('state', 'present', ['entity_class'])
]
module = AnsibleModule(
required_if=required_if,
supports_check_mode=True,
argument_spec=dict(
arguments.get_spec(
"auth", "name", "state", "labels", "annotations", "namespace",
),
entity_class=dict(),
subscriptions=dict(
type='list', elements='str',
),
system=dict(
type='dict'
),
last_seen=dict(
type='int'
),
deregister=dict(
type='bool'
),
deregistration_handler=dict(),
redact=dict(
type='list', elements='str',
),
user=dict()
),
)
client = arguments.get_sensu_client(module.params['auth'])
path = utils.build_core_v2_path(
module.params['namespace'], 'entities', module.params['name'],
)
payload = arguments.get_mutation_payload(
module.params, 'entity_class', 'subscriptions', 'system', 'last_seen', 'deregister',
'redact', 'user'
)
if module.params['deregistration_handler']:
payload['deregistration'] = dict(handler=module.params['deregistration_handler'])
# As per conversation with @echlebek, the only two supported entity
# classes are agent and proxy. All other classes can lead to undefined
# behavior and should not be used.
eclass = payload.get('entity_class')
if eclass and eclass not in ('agent', 'proxy'):
deprecation_msg = (
'The `entity_class` parameter should be set to either `agent` or '
'`proxy`. All other values can result in undefined behavior of '
'the Sensu Go backend.'
)
utils.deprecate(module, deprecation_msg, '2.0.0')
# Agent entities always have entity:{entity_name} subscription enabled
# even if we pass an empty subscriptions. In order to prevent falsely
# reporting changed: true, we always add this subscription to the agent
# entities.
if eclass == 'agent':
entity_sub = 'entity:' + module.params['name']
subs = payload.get('subscriptions', [])
if entity_sub not in subs:
# Copy subs in order to avoid mutating module params
payload['subscriptions'] = subs + [entity_sub]
try:
changed, entity = utils.sync(
module.params['state'], client, path, payload, module.check_mode,
do_differ,
)
module.exit_json(changed=changed, object=entity)
except errors.Error as e:
module.fail_json(msg=str(e))
if __name__ == '__main__':
main()
|
