VhDddlmZmZmZeZdZdZddlZddl Z ddl Z ddl m Z ddl mZddlmZmZdZd Zgd Zd Zd ZGd deZGddeZdZedk(reyy))absolute_importdivisionprint_functionaw module: haproxy short_description: Enable, disable, and set weights for HAProxy backend servers using socket commands author: - Ravi Bhure (@ravibhure) description: - Enable, disable, drain and set weights for HAProxy backend servers using socket commands. notes: - Enable, disable and drain commands are restricted and can only be issued on sockets configured for level C(admin). For example, you can add the line C(stats socket /var/run/haproxy.sock level admin) to the general section of C(haproxy.cfg). See U(http://haproxy.1wt.eu/download/1.5/doc/configuration.txt). - Depends on netcat (C(nc)) being available; you need to install the appropriate package for your operating system before this module can be used. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: backend: description: - Name of the HAProxy backend pool. - If this parameter is unset, it will be auto-detected. type: str drain: description: - Wait until the server has no active connections or until the timeout determined by O(wait_interval) and O(wait_retries) is reached. - Continue only after the status changes to C(MAINT). - This overrides the shutdown_sessions option. type: bool default: false host: description: - Name of the backend host to change. type: str required: true shutdown_sessions: description: - When disabling a server, immediately terminate all the sessions attached to the specified server. - This can be used to terminate long-running sessions after a server is put into maintenance mode. Overridden by the drain option. type: bool default: false socket: description: - Path to the HAProxy socket file. type: path default: /var/run/haproxy.sock state: description: - Desired state of the provided backend host. - Note that V(drain) state is supported only by HAProxy version 1.5 or later. When used on versions < 1.5, it will be ignored. type: str required: true choices: [disabled, drain, enabled] agent: description: - Disable/enable agent checks (depending on O(state) value). type: bool default: false version_added: 1.0.0 health: description: - Disable/enable health checks (depending on O(state) value). type: bool default: false version_added: "1.0.0" fail_on_not_found: description: - Fail whenever trying to enable/disable a backend host that does not exist. type: bool default: false wait: description: - Wait until the server reports a status of C(UP) when O(state=enabled), status of C(MAINT) when O(state=disabled) or status of C(DRAIN) when O(state=drain). type: bool default: false wait_interval: description: - Number of seconds to wait between retries. type: int default: 5 wait_retries: description: - Number of times to check for status after changing the state. type: int default: 25 weight: description: - The value passed in argument. - If the value ends with the V(%) sign, then the new weight will be relative to the initially configured weight. - Relative weights are only permitted between 0 and 100% and absolute weights are permitted between 0 and 256. type: str aM - name: Disable server in 'www' backend pool community.general.haproxy: state: disabled host: '{{ inventory_hostname }}' backend: www - name: Disable server in 'www' backend pool, also stop health/agent checks community.general.haproxy: state: disabled host: '{{ inventory_hostname }}' health: true agent: true - name: Disable server without backend pool name (apply to all available backend pool) community.general.haproxy: state: disabled host: '{{ inventory_hostname }}' - name: Disable server, provide socket file community.general.haproxy: state: disabled host: '{{ inventory_hostname }}' socket: /var/run/haproxy.sock backend: www - name: Disable server, provide socket file, wait until status reports in maintenance community.general.haproxy: state: disabled host: '{{ inventory_hostname }}' socket: /var/run/haproxy.sock backend: www wait: true # Place server in drain mode, providing a socket file. Then check the server's # status every minute to see if it changes to maintenance mode, continuing if it # does in an hour and failing otherwise. - community.general.haproxy: state: disabled host: '{{ inventory_hostname }}' socket: /var/run/haproxy.sock backend: www wait: true drain: true wait_interval: 60 wait_retries: 60 - name: Disable backend server in 'www' backend pool and drop open sessions to it community.general.haproxy: state: disabled host: '{{ inventory_hostname }}' backend: www socket: /var/run/haproxy.sock shutdown_sessions: true - name: Disable server without backend pool name (apply to all available backend pool) but fail when the backend host is not found community.general.haproxy: state: disabled host: '{{ inventory_hostname }}' fail_on_not_found: true - name: Enable server in 'www' backend pool community.general.haproxy: state: enabled host: '{{ inventory_hostname }}' backend: www - name: Enable server in 'www' backend pool wait until healthy community.general.haproxy: state: enabled host: '{{ inventory_hostname }}' backend: www wait: true - name: Enable server in 'www' backend pool wait until healthy. Retry 10 times with intervals of 5 seconds to retrieve the health community.general.haproxy: state: enabled host: '{{ inventory_hostname }}' backend: www wait: true wait_retries: 10 wait_interval: 5 - name: Enable server in 'www' backend pool with change server(s) weight community.general.haproxy: state: enabled host: '{{ inventory_hostname }}' socket: /var/run/haproxy.sock weight: 10 backend: www - name: Set the server in 'www' backend pool to drain mode community.general.haproxy: state: drain host: '{{ inventory_hostname }}' socket: /var/run/haproxy.sock backend: www N)Template) AnsibleModule)to_bytesto_textz/var/run/haproxy.socki)enableddisableddrainc eZdZy)TimeoutExceptionN)__name__ __module__ __qualname__m/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/haproxy.pyrrsrrc^eZdZdZdZddZdZdZdZddZ d Z d Z d Z d Z dd ZdZy)HAProxya] Used for communicating with HAProxy through its local UNIX socket interface. Perform common tasks in Haproxy related to enable server and disable server. The complete set of external commands Haproxy handles is documented on their website: http://haproxy.1wt.eu/download/1.5/doc/configuration.txt#Unix Socket commands c,||_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_ |jjd |_ |jjd |_ |jjd |_ |jjd |_ |jjd |_i|_y)Nstatehostbackendweightsocketshutdown_sessionsfail_on_not_foundagenthealthwait wait_retries wait_intervalr )moduleparamsrrrrrrr r!r"r#r$r%_draincommand_results)selfr&s r__init__zHAProxy.__init__s5 [[''0 KK&&v. {{)))4 kk((2 kk((2 !%!3!34G!H!%!3!34G!H[[''0 kk((2 KK&&v.  KK..~>![[//@kk((1 !rc6tjtjtj|_|jj |j|jj t d|zd}d}|jjt}|r'||z }|jjt}|r't|d}|r |j||j|jj|S)z Executes a HAProxy command by sending a message to a HAProxy's local UNIX socket and waiting up to 'timeout' milliseconds for the response. z%s rsurrogate_or_strict)errors) rAF_UNIX SOCK_STREAMclientconnectsendallrrecv RECV_SIZEr capture_command_outputstripclose)r*cmdtimeoutcapture_outputresultbufs rexecutezHAProxy.executes mmFNNF4F4FG  DKK( HVc\23kky) cMF++""9-C(=>   ' 'V\\^ <  rcd|jvrg|jd<|jdj|d|jvrg|jd<|jdj|y)z2 Capture the output for a command commandoutputN)r)append)r*r9rAs rr6zHAProxy.capture_command_outputsr D00 0.0D  + Y'..s3 4// /-/D  * X&--f5rc |jdddjd}tj|j }t t dtd|S)zw Discover all entries with svname = 'BACKEND' and return a list of their corresponding pxnames show statF# c |dS)Npxnamerds rz/HAProxy.discover_all_backends../s 1X;rc|ddk(S)NsvnameBACKENDrrIs rrKz/HAProxy.discover_all_backends../s8PYAYrr>lstripcsv DictReader splitlinestuplemapfilter)r*datars rdiscover_all_backendszHAProxy.discover_all_backends(sR ||Ke4;;DA NN4??, -S.7Y[\0]^__rc\|jddd}|j}|Dcgc] }d|vs| }} |djddjj dd }t |dt |d f}|Scc}w#t ttf$rd }Y|SwxYw) zt Attempt to extract the haproxy version. Return a tuple containing major and minor version. z show inforEFzVersion:r:.N) r>rS partitionr7splitint ValueError TypeError IndexError)r*rWlinesxlineversion_valuesversions rdiscover_versionzHAProxy.discover_version1s ||Ke4! 4aJ!O44 !!W..s3A6<<>DDS!LN>!,-s>!3D/EFG5Iz2 G s B B ABB+*B+Ncv||j}n|g}|D]}|j||}|jr%|#|jj d|d|d|I|j t |j|||js|dk(r|dk(r|j|||y) z Run some command on the specified backends. If no backends are provided they will be discovered automatically (all backends) NzThe specified backend '/z' was not found!msg)rHrMDRAINDOWN) rY get_state_forr r& fail_jsonr>r substituter#wait_until_status)r*r9rHrMwait_for_statusbackendsrrs rexecute_for_backendszHAProxy.execute_for_backendsAs >113HxH MG&&w7E&&EM %%JQSYZ&\  Xc]55WV5TU99o&@Uf_**7FOL Mrc |jdddjd}tj|j }t t dtfd|}|xsdS)z Find the state of specific services. When pxname is not set, get all backends for a specific host. Returns a list of dictionaries containing the status and weight for those services. rDrEFrFc |d|d|ddS)Nstatusrscur)r{rr|rrIs rrKz'HAProxy.get_state_for..bsQx[AhKQRSYQZ[rc4duxs|dk(xr|dk(S)NrHrMr)rJrHrMs rrKz'HAProxy.get_state_for..cs3&D.#,AhK%+5,"G1281FrNrO)r*rHrMrWrXrs `` rrrzHAProxy.get_state_forYsj ||Ke4;;DA NN4??, - [GHIK  }rc<td|jD]V}|j||}||ddvr|jr |dddk(ryt j |j X|jjd||||jfzy ) a# Wait for a service to reach the specified status. Try RETRIES times 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. r_rr{r|0Tz8server %s/%s not status '%s' after %d retries. Aborting.rnN) ranger$rrr(timesleepr%r&rs)r*rHrMr{irs rruzHAProxy.wait_until_statusisq$++, +A&&vv6Eq(++{{eAhv&6#&= JJt)) * + "\%vvt7H7HI#J Krcd}|jr|dz }|jr|dz }|r|d|zz }|j|||dy)z Enabled action, marks server to UP and checks are re-enabled, also supports to get current weight for server (default) and set the weight for haproxy backend server when provides. z9get weight $pxname/$svname; enable server $pxname/$svnamez; enable agent $pxname/$svnamez; enable health $pxname/$svnamez; set weight $pxname/$svname %sUPNr!r"rx)r*rrrr9s rr zHAProxy.enabled}sU J :: 3 3C ;; 4 4C  4v= =C !!#wd;rcd}|jr|dz }|jr|dz }|dz }|r|dz }|j|||dy)z Disabled action, marks server to DOWN for maintenance. In this mode, no more checks will be performed on the server until it leaves maintenance, also it shutdown sessions while disabling backend host server. zget weight $pxname/$svnamez; disable agent $pxname/$svnamez ; disable health $pxname/$svnamez ; disable server $pxname/$svnamez*; shutdown sessions server $pxname/$svnameMAINTNr)r*rrrr9s rr zHAProxy.disabledsZ + :: 4 4C ;; 5 5C 11  ? ?C !!#wg>rc|j}|r@d|kr:d}|j|||d|dk(r|j|||jyyyy)z Drain action, sets the server to DRAIN mode. In this mode, the server will not accept any new connections other than those that are accepted via persistence. )r_rz&set server $pxname/$svname state drainrprN)rkrxr r)r*rrr{haproxy_versionr9s rr z HAProxy.drainsa //1 v8:C  % %c7D' B  dGT-C-CD! 9?rc|j|j|j|jd<|jdk(r2|j |j|j|j n|jdk(r5|jr)|j|j|jdn|jdk(r2|j|j|j|jn_|jdk(r'|j|j|jn)|jjd|jz|j|j|j|jd <|jd|jd k7|jd <|jjd i|jy ) zN Figure out what you want to do from ansible, and then do it. state_beforer r r)r{r zunknown state specified: '%s'rn state_afterchangedNr)rrrrr)rr rr(r r rr&rs exit_json)r*s ractz HAProxy.acts` 04/A/A$,,PTPYPY/Z^, :: " LLDLL$++ > ZZ: %$++ JJtyy$,,wJ ? ZZ: % MM$))T\\43I3I J ZZ7 " JJtyy$,, / KK ! !&E &R ! S/3.@.@tyy.Y]+,0+?+?+OSWSgSghuSv+vY' 5 4 45r)rET)N)rp)rrr__doc__r+r>r6rYrkrxrrrur r r rrrrrrsG "$, 6` M0 K( <? E6rrctttddttddtdtdtdttdd tdd tdd tdd tdd td ttd t tdd  }t s|jd t|}|jy)NstrT)typerequiredchoices)rr)rpath)rdefaultboolFrb) rrrrrrr r"r!r#r$r%r ) argument_speczunable to locate haproxy socketrn) rdictACTION_CHOICESDEFAULT_SOCKET_LOCATION WAIT_RETRIES WAIT_INTERVALrrsrr)r&ansible_haproxys rmainrsED.I540e$U#V-DE">">VU3FE26515,?E=AFE2 F$ >?foOr__main__) __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESrQrrstringransible.module_utils.basicr+ansible.module_utils.common.text.convertersrr rr5rrr ExceptionrobjectrrrrrrrsA@ b Hc J 4I2  1   y [6f[6|8 zFr