-
Notifications
You must be signed in to change notification settings - Fork 8
/
rancher_compose.py
278 lines (257 loc) · 9.58 KB
/
rancher_compose.py
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
#!/usr/bin/python
##
# (c) 2016, GeoData, University of Southampton <[email protected]>
#
# This module is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This software is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this software. If not, see <http://www.gnu.org/licenses/>.
##
import datetime
import os.path
DOCUMENTATION = '''
---
module: rancher_compose
short_description: Run the C(rancher-compose) tool
version_added: "2.0"
author: "Homme Zwaagstra ([email protected])"
description:
- Run the C(rancher-compose) tool
U(http://docs.rancher.com/rancher/rancher-compose/). Rancher stacks can be
created, started, reloaded, stopped and removed using this module. The stack
to operate on is determined by the C(project_name) option, and defaults to
the directory in which the playbook resides. Note that for the purposes of
this module, the words I(stack) and I(project_name) are synonymous.
options:
project_dir:
description:
- The working directory under which C(rancher-compose) will run
required: false
default: The current working directory
project_name:
description:
- The rancher stack to operate on
required: false
default: The directory in which the playbook resides
docker_compose:
description:
- The location of the C(docker-compose.yml) file
required: false
default: None
rancher_compose:
description:
- The location of the C(rancher-compose.yml) file
required: false
default: None
env_file:
description:
- The location of the file containing C(rancher-compose) environment
variables.
required: false
default: None
url:
description:
- The URL of the rancher server (optionally including the port)
required: false
default: None
access_key:
description:
- The access key for the environment under which the project being
operated on resides. If specified C(secret_key) must be valid
required: false
default: None
secret_key:
description:
- The secret key associated with C(access_key). If specified
C(access_key) must be valid
required: false
default: None
executable:
description:
- The location of the C(rancher-compose) binary
required: false
default: rancher-compose
state:
description:
- Assert the stacks required state. I(present) asserts that the stack has
been created. I(started) asserts that the stack has been started, but
will not propagate changes in files referenced by C(docker_compose) or
C(rancher_compose). I(reloaded) asserts that the stack has been started,
and also propagates changes in files referenced by C(docker_compose) or
C(rancher_compose). I(restarted) asserts all services in the stack have
been restarted. I(stopped) asserts all services in the stack have been
stopped. I(absent) asserts the stack has been removed.
choices: ['present', 'started', 'reloaded', 'restarted', 'stopped', 'absent']
default: started
required: false
requirements:
- "python >= 2.6"
- "rancher-compose >= 0.7.4"
'''
EXAMPLES = '''
# Create a stack
- rancher_compose:
docker_compose: "{{playbook_dir}}/docker-compose.yml"
url: http://rancher-server:8080
access_key: 62883FB58840FB83D016
secret_key: BCZLqYsrmbxnw4jR6e7iy56cb9qViWayq7Yhnw9C
state: present
# Update a stack
- rancher_compose:
docker_compose: "{{playbook_dir}}/docker-compose.yml"
url: http://rancher-server:8080
access_key: 62883FB58840FB83D016
secret_key: BCZLqYsrmbxnw4jR6e7iy56cb9qViWayq7Yhnw9C
state: reloaded
# Delete a stack
- rancher_compose:
docker_compose: "{{playbook_dir}}/docker-compose.yml"
url: http://rancher-server:8080
access_key: 62883FB58840FB83D016
secret_key: BCZLqYsrmbxnw4jR6e7iy56cb9qViWayq7Yhnw9C
state: absent
# Start a stack assuming appropriate environment variables have been set (see
# `rancher-compose --help` for details of environment variables).
- rancher_compose:
state: started
# Start a stack assuming appropriate environment variables are in the file
# `env-vars.txt`
- rancher_compose:
env_file: ./env-vars.txt
state: started
'''
RETURN = '''
cmd:
description: The rancher compose command which was run
type: list
sample: ["rancher-compose", "--file", "/path/to/docker-compose.yml", "--url", "http://rancher-server.example.com:8080", "--access-key", "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "--secret-key", "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "up", "-d", "--upgrade", "--confirm-upgrade", "--pull"
returned: On success
delta:
description: How long it took to run C(rancher-compose)
type: string
sample: "0:00:00.340076"
returned: On success
start:
description: Timestamp of when C(rancher-compose) started
type: string
sample: "2016-04-14 10:14:10.230071"
returned: On success
end:
description: Timestamp of when C(rancher-compose) completed
type: string
sample: "2016-04-14 10:14:10.570147"
returned: On success
stderr:
description: Standard error output captured from C(rancher-compose)
type: string
sample: ""
returned: Whenever rancher compose encounters an error
stdout:
description: Standard output captured from C(rancher-compose)
type: string
sample: "time=\"2016-04-14T10:14:10+01:00\" level=info msg=\"Project [test]: Starting project \" \ntime=\"2016-04-14T10:14:10+01:00\" level=info msg=\"[0/3] [beanstalkd]: Starting \" \ntime=\"2016-04-14T10:14:10+01:00\" level=info msg=\"[0/3] [memcached]: Starting \" \ntime=\"2016-04-14T10:14:10+01:00\" level=info msg=\"[0/3] [postgres]: Starting \" \ntime=\"2016-04-14T10:14:10+01:00\" level=info msg=\"[1/3] [postgres]: Started \" \ntime=\"2016-04-14T10:14:10+01:00\" level=info msg=\"[2/3] [beanstalkd]: Started \" \ntime=\"2016-04-14T10:14:10+01:00\" level=info msg=\"[3/3] [memcached]: Started \" "
returned: Whenever rancher compose generates output
rc:
description: The exit code returned by C(rancher-compose)
type: int
sample: 0
returned: Whenever rancher compose returns
'''
def main():
# Declare the module arguments.
module = AnsibleModule(
argument_spec = dict(
project_dir = dict(type='str', default='.'),
project_name = dict(),
docker_compose = dict(),
rancher_compose = dict(),
env_file = dict(),
url = dict(),
access_key = dict(no_log=True),
secret_key = dict(no_log=True),
executable = dict(type='str', default='rancher-compose'),
state = dict(default='started', choices=['present', 'started', 'reloaded', 'restarted', 'stopped', 'absent']),
),
required_together = (
['access_key', 'secret_key'],
),
)
# Define the module arguments.
project_dir = os.path.abspath(os.path.expanduser(module.params['project_dir']))
project_name = module.params['project_name']
docker_compose = module.params['docker_compose']
rancher_compose = module.params['rancher_compose']
env_file = module.params['env_file']
url = module.params['url']
access_key = module.params['access_key']
secret_key = module.params['secret_key']
executable = module.params['executable']
state = module.params['state']
# Set the global rancher-compose command line arguments.
args = [executable]
if docker_compose:
args.extend(['--file', docker_compose])
if project_name:
args.extend(['--project-name', project_name])
if rancher_compose:
args.extend(['--rancher-file', rancher_compose])
if env_file:
args.extend(['--env-file', env_file])
if url:
args.extend(['--url', url])
if access_key:
args.extend(['--access-key', access_key])
if secret_key:
args.extend(['--secret-key', secret_key])
# Set the state related rancher-compose command line arguments.
if state == 'started':
args.extend(['up', '-d', '--confirm-upgrade'])
elif state == 'present':
args.append('create')
elif state == 'reloaded':
args.extend(['up', '-d', '--upgrade', '--confirm-upgrade', '--pull'])
elif state == 'restarted':
args.append('restart')
elif state == 'stopped':
args.append('stop')
elif state == 'absent':
args.extend(['rm', '--force'])
# Run rancher-compose.
startd = datetime.datetime.now()
rc, out, err = module.run_command(args, executable, cwd=project_dir)
endd = datetime.datetime.now()
delta = endd - startd
# STDOUT and STDERR should always be strings.
if out is None:
out = ''
if err is None:
err = ''
# Has the state changed?
changed = True
if state == 'reloaded' and 'Upgrading' not in out:
changed = False
if state == 'present' and 'Creating' not in out:
changed = False
# Return the results.
module.exit_json(
cmd = args,
stdout = out.rstrip("\r\n"),
stderr = err.rstrip("\r\n"),
rc = rc,
start = str(startd),
end = str(endd),
delta = str(delta),
changed = changed
)
# import module snippets
from ansible.module_utils.basic import *
if __name__ == '__main__':
main()