archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fail when backend host is not found (#1385)

Browse Source
reviewable/pr18780/r1
Gerrit Germis 9 years ago committed by Brian Coca
parent 8fac01a3cc
commit a003b8d081
1 changed files with 100 additions and 117 deletions
Show Stats Download Patch File Download Diff File

207
network/haproxy.py
Unescape Escape View File

@ -60,6 +60,12 @@ options:
required: true required: true
default: null default: null
choices: [ "enabled", "disabled" ] choices: [ "enabled", "disabled" ]
fail_on_not_found:
description:
- Fail whenever trying to enable/disable a backend host that does not exist
required: false
default: false
version_added: "2.2"
wait: wait:
description: description:
- Wait until the server reports a status of 'UP' when `state=enabled`, or - Wait until the server reports a status of 'UP' when `state=enabled`, or
@ -105,6 +111,9 @@ EXAMPLES = '''
# disable backend server in 'www' backend pool and drop open sessions to it # disable backend server in 'www' backend pool and drop open sessions to it
- haproxy: state=disabled host={{ inventory_hostname }} backend=www socket=/var/run/haproxy.sock shutdown_sessions=true - haproxy: state=disabled host={{ inventory_hostname }} backend=www socket=/var/run/haproxy.sock shutdown_sessions=true
# disable server without backend pool name (apply to all available backend pool) but fail when the backend host is not found
- haproxy: state=disabled host={{ inventory_hostname }} fail_on_not_found=yes
# enable server in 'www' backend pool # enable server in 'www' backend pool
- haproxy: state=enabled host={{ inventory_hostname }} backend=www - haproxy: state=enabled host={{ inventory_hostname }} backend=www
@ -123,6 +132,7 @@ author: "Ravi Bhure (@ravibhure)"
import socket import socket
import csv import csv
import time import time
from string import Template
DEFAULT_SOCKET_LOCATION="/var/run/haproxy.sock" DEFAULT_SOCKET_LOCATION="/var/run/haproxy.sock"
@ -156,23 +166,17 @@ class HAProxy(object):
self.weight = self.module.params['weight'] self.weight = self.module.params['weight']
self.socket = self.module.params['socket'] self.socket = self.module.params['socket']
self.shutdown_sessions = self.module.params['shutdown_sessions'] self.shutdown_sessions = self.module.params['shutdown_sessions']
self.fail_on_not_found = self.module.params['fail_on_not_found']
self.wait = self.module.params['wait'] self.wait = self.module.params['wait']
self.wait_retries = self.module.params['wait_retries'] self.wait_retries = self.module.params['wait_retries']
self.wait_interval = self.module.params['wait_interval'] self.wait_interval = self.module.params['wait_interval']
self.command_results = [] self.command_results = {}
self.status_servers = []
self.status_weights = []
self.previous_weights = []
self.previous_states = []
self.current_states = []
self.current_weights = []
def execute(self, cmd, timeout=200, capture_output=True): def execute(self, cmd, timeout=200, capture_output=True):
""" """
Executes a HAProxy command by sending a message to a HAProxy's local Executes a HAProxy command by sending a message to a HAProxy's local
UNIX socket and waiting up to 'timeout' milliseconds for the response. UNIX socket and waiting up to 'timeout' milliseconds for the response.
""" """
self.client = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) self.client = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
self.client.connect(self.socket) self.client.connect(self.socket)
self.client.sendall('%s\n' % cmd) self.client.sendall('%s\n' % cmd)
@ -183,61 +187,85 @@ class HAProxy(object):
result += buf result += buf
buf = self.client.recv(RECV_SIZE) buf = self.client.recv(RECV_SIZE)
if capture_output: if capture_output:
self.command_results = result.strip() self.capture_command_output(cmd, result.strip())
self.client.close() self.client.close()
return result return result
def wait_until_status(self, pxname, svname, status):
def capture_command_output(self, cmd, output):
""" """
Wait for a service to reach the specified status. Try RETRIES times Capture the output for a command
with INTERVAL seconds of sleep in between. If the service has not reached """
the expected status in that time, the module will fail. If the service was if not 'command' in self.command_results.keys():
not found, the module will fail. self.command_results['command'] = []
self.command_results['command'].append(cmd)
if not 'output' in self.command_results.keys():
self.command_results['output'] = []
self.command_results['output'].append(output)
def discover_all_backends(self):
"""
Discover all entries with svname = 'BACKEND' and return a list of their corresponding
pxnames
""" """
for i in range(1, self.wait_retries):
data = self.execute('show stat', 200, False).lstrip('# ') data = self.execute('show stat', 200, False).lstrip('# ')
r = csv.DictReader(data.splitlines()) r = csv.DictReader(data.splitlines())
found = False return map(lambda d: d['pxname'], filter(lambda d: d['svname'] == 'BACKEND', r))
for row in r:
if row['pxname'] == pxname and row['svname'] == svname:
found = True def execute_for_backends(self, cmd, pxname, svname, wait_for_status = None):
if row['status'] == status: """
return True; Run some command on the specified backends. If no backends are provided they will
be discovered automatically (all backends)
"""
# Discover backends if none are given
if pxname is None:
backends = self.discover_all_backends()
else: else:
time.sleep(self.wait_interval) backends = [pxname]
if not found: # Run the command for each requested backend
self.module.fail_json(msg="unable to find server %s/%s" % (pxname, svname)) for backend in backends:
# Fail when backends were not found
state = self.get_state_for(backend, svname)
if (self.fail_on_not_found or self.wait) and state is None:
self.module.fail_json(msg="The specified backend '%s/%s' was not found!" % (backend, svname))
self.execute(Template(cmd).substitute(pxname = backend, svname = svname))
if self.wait:
self.wait_until_status(backend, svname, wait_for_status)
self.module.fail_json(msg="server %s/%s not status '%s' after %d retries. Aborting." % (pxname, svname, status, self.wait_retries))
def get_current_state(self, host, backend): def get_state_for(self, pxname, svname):
""" """
Gets the each original state value from show stat. Find the state of specific services. When pxname is not set, get all backends for a specific host.
Runs before and after to determine if values are changed. Returns a list of dictionaries containing the status and weight for those services.
This relies on weight always being the next element after
status in "show stat" as well as status states remaining
as indicated in status_states and haproxy documentation.
""" """
data = self.execute('show stat', 200, False).lstrip('# ')
r = csv.DictReader(data.splitlines())
state = map(lambda d: { 'status': d['status'], 'weight': d['weight'] }, filter(lambda d: (pxname is None or d['pxname'] == pxname) and d['svname'] == svname, r))
return state or None
output = self.execute('show stat')
output = output.lstrip('# ').strip()
output = output.split(',')
result = output
status_states = [ 'UP','DOWN','DRAIN','NOLB','MAINT' ]
self.status_server = []
status_weight_pos = []
self.status_weight = []
for check, status in enumerate(result): def wait_until_status(self, pxname, svname, status):
if status in status_states: """
self.status_server.append(status) Wait for a service to reach the specified status. Try RETRIES times
status_weight_pos.append(check + 1) with INTERVAL seconds of sleep in between. If the service has not reached
the expected status in that time, the module will fail. If the service was
not found, the module will fail.
"""
for i in range(1, self.wait_retries):
state = self.get_state_for(pxname, svname)
for weight in status_weight_pos: # We can assume there will only be 1 element in state because both svname and pxname are always set when we get here
self.status_weight.append(result[weight]) if state[0]['status'] == status:
return True
else:
time.sleep(self.wait_interval)
self.module.fail_json(msg="server %s/%s not status '%s' after %d retries. Aborting." % (pxname, svname, status, self.wait_retries))
return{'self.status_server':self.status_server, 'self.status_weight':self.status_weight}
def enabled(self, host, backend, weight): def enabled(self, host, backend, weight):
""" """
@ -245,33 +273,11 @@ class HAProxy(object):
also supports to get current weight for server (default) and also supports to get current weight for server (default) and
set the weight for haproxy backend server when provides. set the weight for haproxy backend server when provides.
""" """
svname = host cmd = "get weight $pxname/$svname; enable server $pxname/$svname"
if self.backend is None:
output = self.execute('show stat')
#sanitize and make a list of lines
output = output.lstrip('# ').strip()
output = output.split('\n')
result = output
for line in result:
if 'BACKEND' in line:
result = line.split(',')[0]
pxname = result
cmd = "get weight %s/%s ; enable server %s/%s" % (pxname, svname, pxname, svname)
if weight: if weight:
cmd += "; set weight %s/%s %s" % (pxname, svname, weight) cmd += "; set weight $pxname/$svname %s" % weight
self.execute(cmd) self.execute_for_backends(cmd, backend, host, 'UP')
if self.wait:
self.wait_until_status(pxname, svname, 'UP')
else:
pxname = backend
cmd = "get weight %s/%s ; enable server %s/%s" % (pxname, svname, pxname, svname)
if weight:
cmd += "; set weight %s/%s %s" % (pxname, svname, weight)
self.execute(cmd)
if self.wait:
self.wait_until_status(pxname, svname, 'UP')
def disabled(self, host, backend, shutdown_sessions): def disabled(self, host, backend, shutdown_sessions):
""" """
@ -279,64 +285,40 @@ class HAProxy(object):
performed on the server until it leaves maintenance, performed on the server until it leaves maintenance,
also it shutdown sessions while disabling backend host server. also it shutdown sessions while disabling backend host server.
""" """
svname = host cmd = "get weight $pxname/$svname; disable server $pxname/$svname"
if self.backend is None:
output = self.execute('show stat')
#sanitize and make a list of lines
output = output.lstrip('# ').strip()
output = output.split('\n')
result = output
for line in result:
if 'BACKEND' in line:
result = line.split(',')[0]
pxname = result
cmd = "get weight %s/%s ; disable server %s/%s" % (pxname, svname, pxname, svname)
if shutdown_sessions: if shutdown_sessions:
cmd += "; shutdown sessions server %s/%s" % (pxname, svname) cmd += "; shutdown sessions server $pxname/$svname"
self.execute(cmd) self.execute_for_backends(cmd, backend, host, 'MAINT')
if self.wait:
self.wait_until_status(pxname, svname, 'MAINT')
else:
pxname = backend
cmd = "get weight %s/%s ; disable server %s/%s" % (pxname, svname, pxname, svname)
if shutdown_sessions:
cmd += "; shutdown sessions server %s/%s" % (pxname, svname)
self.execute(cmd)
if self.wait:
self.wait_until_status(pxname, svname, 'MAINT')
def act(self): def act(self):
""" """
Figure out what you want to do from ansible, and then do it. Figure out what you want to do from ansible, and then do it.
""" """
# Get the state before the run
self.get_current_state(self.host, self.backend) state_before = self.get_state_for(self.backend, self.host)
self.previous_states = ','.join(self.status_server) self.command_results['state_before'] = state_before
self.previous_weights = ','.join(self.status_weight)
# toggle enable/disbale server # toggle enable/disbale server
if self.state == 'enabled': if self.state == 'enabled':
self.enabled(self.host, self.backend, self.weight) self.enabled(self.host, self.backend, self.weight)
elif self.state == 'disabled': elif self.state == 'disabled':
self.disabled(self.host, self.backend, self.shutdown_sessions) self.disabled(self.host, self.backend, self.shutdown_sessions)
else: else:
self.module.fail_json(msg="unknown state specified: '%s'" % self.state) self.module.fail_json(msg="unknown state specified: '%s'" % self.state)
self.get_current_state(self.host, self.backend) # Get the state after the run
self.current_states = ','.join(self.status_server) state_after = self.get_state_for(self.backend, self.host)
self.current_weights = ','.join(self.status_weight) self.command_results['state_after'] = state_after
if self.current_weights != self.previous_weights: # Report change status
self.module.exit_json(stdout=self.command_results, changed=True) if state_before != state_after:
elif self.current_states != self.previous_states: self.command_results['changed'] = True
self.module.exit_json(stdout=self.command_results, changed=True) self.module.exit_json(**self.command_results)
else: else:
self.module.exit_json(stdout=self.command_results, changed=False) self.command_results['changed'] = False
self.module.exit_json(**self.command_results)
def main(): def main():
@ -349,11 +331,11 @@ def main():
weight=dict(required=False, default=None), weight=dict(required=False, default=None),
socket = dict(required=False, default=DEFAULT_SOCKET_LOCATION), socket = dict(required=False, default=DEFAULT_SOCKET_LOCATION),
shutdown_sessions=dict(required=False, default=False), shutdown_sessions=dict(required=False, default=False),
fail_on_not_found=dict(required=False, default=False, type='bool'),
wait=dict(required=False, default=False, type='bool'), wait=dict(required=False, default=False, type='bool'),
wait_retries=dict(required=False, default=WAIT_RETRIES, type='int'), wait_retries=dict(required=False, default=WAIT_RETRIES, type='int'),
wait_interval=dict(required=False, default=WAIT_INTERVAL, type='int'), wait_interval=dict(required=False, default=WAIT_INTERVAL, type='int'),
), ),
) )
if not socket: if not socket:
@ -366,3 +348,4 @@ def main():
from ansible.module_utils.basic import * from ansible.module_utils.basic import *
main() main()

Write Preview
Loading…
Cancel
Save