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
|
#!/usr/bin/python
from ansible.module_utils.basic import AnsibleModule
import requests
import json
import functools
DOCUMENTATION = """
---
module: rancher1_api
short_description: Client library for rancher API
description:
- This module modifies a rancher 1.6 using it's API (v1).
- WIP, as of now it can only change a current value to a new one.
options:
rancher:
description:
- The domain name or the IP address and the port of the rancher
where API is exposed.
- For example: http://10.0.0.1:8080
required: true
aliases:
- server
- rancher_url
- rancher_api
- api
- url
category:
description:
- The path in JSON API without the last element.
required: false
default: settings
aliases:
- rancher_category
- api_category
option:
description:
- The name of the settings option.
required: true
aliases:
- name
- key
- settings
value:
description:
- A new value to replace the current one.
required: true
timeout:
description:
- How long in seconds to wait for a response before raising error
required: false
default: 10.0
"""
def _decorate_rancher_api_request(request_method):
@functools.wraps(request_method)
def wrap_request(*args, **kwargs):
response = request_method(*args, **kwargs)
if response.status_code != requests.codes.ok:
response.raise_for_status()
try:
json_data = response.json()
except Exception:
json_data = None
return json_data
return wrap_request
@_decorate_rancher_api_request
def get_rancher_api_value(url, headers=None, timeout=10.0,
username=None, password=None):
if username and password:
return requests.get(url, headers=headers,
timeout=timeout,
allow_redirects=False,
auth=(username, password))
else:
return requests.get(url, headers=headers,
timeout=timeout,
allow_redirects=False)
@_decorate_rancher_api_request
def set_rancher_api_value(url, payload, headers=None, timeout=10.0,
username=None, password=None):
if username and password:
return requests.put(url, headers=headers,
timeout=timeout,
allow_redirects=False,
data=json.dumps(payload),
auth=(username, password))
else:
return requests.put(url, headers=headers,
timeout=timeout,
allow_redirects=False,
data=json.dumps(payload))
def create_rancher_api_payload(json_data, new_value):
payload = {}
try:
api_id = json_data['id']
api_activeValue = json_data['activeValue']
api_name = json_data['name']
api_source = json_data['source']
except Exception:
raise ValueError
payload.update({"activeValue": api_activeValue,
"id": api_id,
"name": api_name,
"source": api_source,
"value": new_value})
if api_activeValue != new_value:
differs = True
else:
differs = False
return differs, payload
def is_valid_rancher_api_option(json_data):
try:
api_activeValue = json_data['activeValue']
api_source = json_data['source']
except Exception:
return False
if api_activeValue is None and api_source is None:
return False
return True
def main():
module = AnsibleModule(
argument_spec=dict(
rancher=dict(type='str', required=True,
aliases=['server',
'rancher_api',
'rancher_url',
'api',
'url']),
category=dict(type='str', default='settings',
aliases=['rancher_category', 'api_category']),
option=dict(type='str', required=True,
aliases=['name', 'key', 'settings']),
value=dict(type='str', required=True),
timeout=dict(type='float', default=10.0),
),
supports_check_mode=True
)
rancher_url = module.params['rancher'].strip('/')
rancher_option = module.params['option'].strip('/')
rancher_category = module.params['category']
rancher_value = module.params['value']
rancher_timeout = module.params['timeout']
# cattle_access_key = ''
# cattle_secret_key = ''
# Assemble API url
request_url = rancher_url + '/v1/' + rancher_category + '/' \
+ rancher_option
http_headers = {'Content-Type': 'application/json',
'Accept': 'application/json'}
# API get current value
try:
json_response = get_rancher_api_value(request_url,
headers=http_headers,
timeout=rancher_timeout)
except requests.HTTPError as e:
module.fail_json(msg=str(e))
except requests.Timeout as e:
module.fail_json(msg=str(e))
if not json_response:
module.fail_json(msg='ERROR: BAD RESPONSE (GET) - no json value \
in the response')
if is_valid_rancher_api_option(json_response):
valid = True
try:
differs, payload = create_rancher_api_payload(json_response,
rancher_value)
except ValueError:
module.fail_json(msg='ERROR: INVALID JSON - missing json values \
in the response')
else:
valid = False
if valid and differs and module.check_mode:
# ansible dry-run mode
changed = True
elif valid and differs:
# API set new value
try:
json_response = set_rancher_api_value(request_url,
payload,
headers=http_headers,
timeout=rancher_timeout)
except requests.HTTPError as e:
module.fail_json(msg=str(e))
except requests.Timeout as e:
module.fail_json(msg=str(e))
if not json_response:
module.fail_json(msg='ERROR: BAD RESPONSE (PUT) - no json value \
in the response')
else:
changed = True
else:
changed = False
if changed:
msg = "Option '%s' is now set to the new value: %s" \
% (rancher_option, rancher_value)
else:
msg = "Option '%s' is unchanged." % (rancher_option)
module.exit_json(changed=changed, msg=msg)
if __name__ == '__main__':
main()
|
