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 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2013, Chatham Financial <oss@chathamfinancial.com>
# 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
DOCUMENTATION = r"""
---
module: rabbitmq_vhost
short_description: Manage the state of a virtual host in RabbitMQ
description:
- Manage the state of a virtual host in RabbitMQ using rabbitmqctl or REST APIs.
author: Chris Hoffman (@chrishoffman)
options:
name:
description:
- The name of the vhost to manage
type: str
required: true
aliases: [vhost]
node:
description:
- erlang node name of the rabbit we wish to configure
type: str
default: rabbit
tracing:
description:
- Enable/disable tracing for a vhost
type: bool
default: false
aliases: [trace]
state:
description:
- The state of vhost
type: str
default: present
choices: [present, absent]
login_user:
description:
- RabbitMQ user for connection.
type: str
version_added: '1.5.0'
login_password:
description:
- RabbitMQ password for connection.
type: str
version_added: '1.5.0'
login_host:
description:
- RabbitMQ host for connection.
type: str
version_added: '1.5.0'
login_port:
description:
- RabbitMQ management API port.
type: str
default: '15672'
version_added: '1.5.0'
login_protocol:
description:
- RabbitMQ management API protocol.
type: str
choices: [ http , https ]
default: http
version_added: '1.5.0'
ca_cert:
description:
- CA certificate to verify SSL connection to management API.
type: path
version_added: '1.5.0'
client_cert:
description:
- Client certificate to send on SSL connections to management API.
type: path
version_added: '1.5.0'
client_key:
description:
- Private key matching the client certificate.
type: path
version_added: '1.5.0'
"""
EXAMPLES = r"""
- name: Ensure that the vhost /test exists.
community.rabbitmq.rabbitmq_vhost:
name: /test
state: present
- name: Ensure that the vhost /test exists using REST APIs.
community.rabbitmq.rabbitmq_vhost:
name: /test
state: present
login_host: localhost
login_user: admin
login_password: changeadmin
"""
import traceback
from ansible.module_utils.six.moves.urllib import parse
from ansible.module_utils.basic import AnsibleModule
REQUESTS_IMP_ERR = None
try:
import requests
HAS_REQUESTS = True
except ImportError:
REQUESTS_IMP_ERR = traceback.format_exc()
HAS_REQUESTS = False
from ansible.module_utils.basic import AnsibleModule
class RabbitMqVhost(object):
def __init__(
self,
module,
name,
tracing,
node,
login_user,
login_password,
login_host,
login_port,
login_protocol,
ca_cert,
client_cert,
client_key,
):
self.module = module
self.name = name
self.tracing = tracing
self.node = node
self.login_user = login_user
self.login_password = login_password
self.login_host = login_host
self.login_port = login_port
self.login_protocol = login_protocol
self.verify = ca_cert
self.cert = client_cert
self.key = client_key
self._tracing = False
self._rabbitmqctl = module.get_bin_path("rabbitmqctl", True)
def _exec(self, args, force_exec_in_check_mode=False):
if not self.module.check_mode or (
self.module.check_mode and force_exec_in_check_mode
):
cmd = [self._rabbitmqctl, "-q", "-n", self.node]
rc, out, err = self.module.run_command(cmd + args, check_rc=True)
return out.splitlines()
return list()
def get(self):
if self.login_host is not None:
response = self._request_vhost_api("get")
if response.ok:
self._tracing = response.json()["tracing"]
return True
elif response.status_code == 404:
return False
else:
self.module.fail_json(
msg="Error getting the vhost",
status=response.status_code,
details=response.text,
)
else:
vhosts = self._exec(["list_vhosts", "name", "tracing"], True)
for vhost in vhosts:
if "\t" not in vhost:
continue
name, tracing = vhost.split("\t")
if name == self.name:
self._tracing = self.module.boolean(tracing)
return True
return False
def add(self):
if self.login_host is not None:
response = self._request_vhost_api("put")
if response is not None and not response.ok:
msg = (
"Error trying to create vhost %s in rabbitmq. " "Status code '%s'."
) % (self.name, response.status_code)
self.module.fail_json(msg=msg)
else:
return self._exec(["add_vhost", self.name])
def delete(self):
if self.login_host is not None:
response = self._request_vhost_api("delete")
if response is not None and not response.ok:
msg = (
"Error trying to remove vhost %s in rabbitmq. " "Status code '%s'."
) % (self.name, response.status_code)
self.module.fail_json(msg=msg)
else:
return self._exec(["delete_vhost", self.name])
def set_tracing(self):
if self.tracing != self._tracing:
if self.tracing:
self._enable_tracing()
else:
self._disable_tracing()
return True
return False
def _enable_tracing(self):
if self.login_host is not None:
response = self._request_vhost_api("put", data={"tracing": True})
if response is not None and not response.ok:
msg = (
"Error trying to enable tracing on vhost %s in rabbitmq. "
"Status code '%s'."
) % (self.name, response.status_code)
self.module.fail_json(msg=msg)
else:
return self._exec(["trace_on", "-p", self.name])
def _disable_tracing(self):
if self.login_host is not None:
response = self._request_vhost_api("put", data={"tracing": False})
if response is not None and not response.ok:
msg = (
"Error trying to disable tracing on vhost %s in rabbitmq. "
"Status code '%s'."
) % (self.name, response.status_code)
self.module.fail_json(msg=msg)
else:
return self._exec(["trace_off", "-p", self.name])
def _request_vhost_api(self, method, data=None):
if self.module.check_mode and method != "get":
return None
try:
url = "%s://%s:%s/api/vhosts/%s" % (
self.login_protocol,
self.login_host,
self.login_port,
parse.quote(self.name, ""),
)
response = requests.request(
method=method,
url=url,
auth=(self.login_user, self.login_password),
verify=self.verify,
cert=(self.cert, self.key),
json=data,
)
except requests.exceptions.RequestException as exception:
msg = "Error in HTTP request (method %s) for user %s in rabbitmq." % (
method,
self.login_user,
)
self.module.fail_json(msg=msg, exception=exception)
return response
def main():
arg_spec = dict(
name=dict(required=True, aliases=["vhost"]),
tracing=dict(default="off", aliases=["trace"], type="bool"),
state=dict(default="present", choices=["present", "absent"]),
node=dict(default="rabbit"),
login_user=dict(type="str", no_log=True),
login_password=dict(type="str", no_log=True),
login_host=dict(type="str"),
login_port=dict(type="str", default="15672"),
login_protocol=dict(type="str", default="http", choices=["http", "https"]),
ca_cert=dict(type="path"),
client_cert=dict(type="path"),
client_key=dict(type="path"),
)
module = AnsibleModule(argument_spec=arg_spec, supports_check_mode=True)
name = module.params["name"]
tracing = module.params["tracing"]
state = module.params["state"]
node = module.params["node"]
login_user = module.params["login_user"]
login_password = module.params["login_password"]
login_host = module.params["login_host"]
login_port = module.params["login_port"]
login_protocol = module.params["login_protocol"]
ca_cert = module.params["ca_cert"]
client_cert = module.params["client_cert"]
client_key = module.params["client_key"]
if not HAS_REQUESTS:
module.warn("requests module not present. Using RabbitMQ cli.")
login_host = None
result = dict(changed=False, name=name, state=state)
rabbitmq_vhost = RabbitMqVhost(
module,
name,
tracing,
node,
login_user,
login_password,
login_host,
login_port,
login_protocol,
ca_cert,
client_cert,
client_key,
)
if rabbitmq_vhost.get():
if state == "absent":
rabbitmq_vhost.delete()
result["changed"] = True
else:
if rabbitmq_vhost.set_tracing():
result["changed"] = True
elif state == "present":
rabbitmq_vhost.add()
rabbitmq_vhost.set_tracing()
result["changed"] = True
module.exit_json(**result)
if __name__ == "__main__":
main()
|