ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-05 10:10:31 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

add pacemaker_resource plugin (#9531)

Browse source 
* Add initial pacemaker resource

* Additional fixes on pacemaker_resource

* Fix up module parameters

* fix doc and lint

* fix group command build

* Apply suggestions for removing status and improve descriptions

* fix cmd builder list

* Apply suggestions and add initial unit tests

* Fix unit tests expected output

* Initial refactor on pacemaker resource

Refactorization on pacemaker_resource to utilize module helpers.

* Apply suggestions and fix up initial unit test

* Apply suggestions from code review

* Fix pep8 format for utils

* Fix unit tests for pacemaker resource

* Add botmeta maintainers for new moduules

* Apply suggestions from code review

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

* Apply unit test suggestion

* Add disable and enable states for pacemaker_resource

* Fix state names and add cli_action for runner

* Remove unnecessary variables

* Fix documentation example playbook

* Fix IP Address for resource_option

* Refactor and remove unnecessary facts

* Apply suggestions from code review

---------

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
Dexter 2025-03-05 15:08:42 -05:00 • committed by GitHub
parent c43289b8f1
commit 402f725424
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 517 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/BOTMETA.yml vendored
View file

@ -378,6 +378,8 @@ files:
$module_utils/oracle/oci_utils.py:
labels: cloud
maintainers: $team_oracle
$module_utils/pacemaker.py:
maintainers: munchtoast
$module_utils/pipx.py:
labels: pipx
maintainers: russoz
@ -1054,6 +1056,8 @@ files:
maintainers: fraff
$modules/pacemaker_cluster.py:
maintainers: matbu
$modules/pacemaker_resource.py:
maintainers: munchtoast
$modules/packet_:
maintainers: nurfet-becirevic t0mk
$modules/packet_device.py:

56
plugins/module_utils/pacemaker.py Normal file
View file

@ -0,0 +1,56 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2025, Dexter Le <dextersydney2001@gmail.com>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import absolute_import, division, print_function
__metaclass__ = type
from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
_state_map = {
"present": "create",
"absent": "remove",
"status": "status",
"enabled": "enable",
"disabled": "disable"
}
def fmt_resource_type(value):
return [value[k] for k in ['resource_standard', 'resource_provider', 'resource_name'] if value.get(k) is not None]
def fmt_resource_operation(value):
cmd = []
for op in value:
cmd.append("op")
cmd.append(op.get('operation_action'))
for operation_option in op.get('operation_option'):
cmd.append(operation_option)
return cmd
def fmt_resource_argument(value):
return ['--group' if value['argument_action'] == 'group' else value['argument_action']] + value['argument_option']
def pacemaker_runner(module, cli_action, **kwargs):
runner = CmdRunner(
module,
command=['pcs', cli_action],
arg_formats=dict(
state=cmd_runner_fmt.as_map(_state_map),
name=cmd_runner_fmt.as_list(),
resource_type=cmd_runner_fmt.as_func(fmt_resource_type),
resource_option=cmd_runner_fmt.as_list(),
resource_operation=cmd_runner_fmt.as_func(fmt_resource_operation),
resource_meta=cmd_runner_fmt.stack(cmd_runner_fmt.as_opt_val)("meta"),
resource_argument=cmd_runner_fmt.as_func(fmt_resource_argument),
wait=cmd_runner_fmt.as_opt_eq_val("--wait"),
),
**kwargs
)
return runner

228
plugins/modules/pacemaker_resource.py Normal file
View file

@ -0,0 +1,228 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2025, Dexter Le <dextersydney2001@gmail.com>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: pacemaker_resource
short_description: Manage pacemaker resources
author:
- Dexter Le (@munchtoast)
version_added: 10.5.0
description:
- This module can manage resources in a Pacemaker cluster using the pacemaker CLI.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
state:
description:
- Indicate desired state for cluster resource.
choices: [ present, absent, enabled, disabled ]
default: present
type: str
name:
description:
- Specify the resource name to create.
required: true
type: str
resource_type:
description:
- Resource type to create.
type: dict
suboptions:
resource_name:
description:
- Specify the resource type name.
type: str
resource_standard:
description:
- Specify the resource type standard.
type: str
resource_provider:
description:
- Specify the resource type providers.
type: str
resource_option:
description:
- Specify the resource option to create.
type: list
elements: str
default: []
resource_operation:
description:
- List of operations to associate with resource.
type: list
elements: dict
default: []
suboptions:
operation_action:
description:
- Operation action to associate with resource.
type: str
operation_option:
description:
- Operation option to associate with action.
type: list
elements: str
resource_meta:
description:
- List of meta to associate with resource.
type: list
elements: str
resource_argument:
description:
- Action to associate with resource.
type: dict
suboptions:
argument_action:
description:
- Action to apply to resource.
type: str
choices: [ clone, master, group, promotable ]
argument_option:
description:
- Options to associate with resource action.
type: list
elements: str
wait:
description:
- Timeout period for polling the resource creation.
type: int
default: 300
'''
EXAMPLES = '''
---
- name: Create pacemaker resource
hosts: localhost
gather_facts: false
tasks:
- name: Create virtual-ip resource
community.general.pacemaker_resource:
state: present
name: virtual-ip
resource_type:
resource_name: IPaddr2
resource_option:
- "ip=[192.168.2.1]"
resource_argument:
argument_action: group
argument_option:
- master
resource_operation:
- operation_action: monitor
operation_option:
- interval=20
'''
RETURN = '''
cluster_resources:
description: The cluster resource output message.
type: str
sample: "Assumed agent name ocf:heartbeat:IPaddr2 (deduced from IPaddr2)"
returned: always
'''
from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper
from ansible_collections.community.general.plugins.module_utils.pacemaker import pacemaker_runner
class PacemakerResource(StateModuleHelper):
module = dict(
argument_spec=dict(
state=dict(type='str', default='present', choices=[
'present', 'absent', 'enabled', 'disabled']),
name=dict(type='str', required=True),
resource_type=dict(type='dict', options=dict(
resource_name=dict(type='str'),
resource_standard=dict(type='str'),
resource_provider=dict(type='str'),
)),
resource_option=dict(type='list', elements='str', default=list()),
resource_operation=dict(type='list', elements='dict', default=list(), options=dict(
operation_action=dict(type='str'),
operation_option=dict(type='list', elements='str'),
)),
resource_meta=dict(type='list', elements='str'),
resource_argument=dict(type='dict', options=dict(
argument_action=dict(type='str', choices=['clone', 'master', 'group', 'promotable']),
argument_option=dict(type='list', elements='str'),
)),
wait=dict(type='int', default=300),
),
required_if=[('state', 'present', ['resource_type', 'resource_option'])],
supports_check_mode=True,
)
use_old_vardict = False
default_state = "present"
def __init_module__(self):
self.runner = pacemaker_runner(self.module, cli_action='resource')
self.vars.set('previous_value', self._get())
self.vars.set('value', self.vars.previous_value, change=True, diff=True)
def _process_command_output(self, fail_on_err, ignore_err_msg=""):
def process(rc, out, err):
if fail_on_err and rc != 0 and err and ignore_err_msg not in err:
self.do_raise('pcs failed with error (rc={0}): {1}'.format(rc, err))
out = out.rstrip()
return None if out == "" else out
return process
def _get(self):
with self.runner('state name', output_process=self._process_command_output(False)) as ctx:
return ctx.run(state='status')
def state_absent(self):
with self.runner('state name', output_process=self._process_command_output(True, "does not exist"), check_mode_skip=True) as ctx:
ctx.run()
self.vars.set('value', self._get())
self.vars.stdout = ctx.results_out
self.vars.stderr = ctx.results_err
self.vars.cmd = ctx.cmd
def state_present(self):
with self.runner(
'state name resource_type resource_option resource_operation resource_meta resource_argument wait',
output_process=self._process_command_output(True, "already exists"),
check_mode_skip=True) as ctx:
ctx.run()
self.vars.set('value', self._get())
self.vars.stdout = ctx.results_out
self.vars.stderr = ctx.results_err
self.vars.cmd = ctx.cmd
def state_enabled(self):
with self.runner('state name', output_process=self._process_command_output(True, "Starting"), check_mode_skip=True) as ctx:
ctx.run()
self.vars.set('value', self._get())
self.vars.stdout = ctx.results_out
self.vars.stderr = ctx.results_err
self.vars.cmd = ctx.cmd
def state_disabled(self):
with self.runner('state name', output_process=self._process_command_output(True, "Stopped"), check_mode_skip=True) as ctx:
ctx.run()
self.vars.set('value', self._get())
self.vars.stdout = ctx.results_out
self.vars.stderr = ctx.results_err
self.vars.cmd = ctx.cmd
def main():
PacemakerResource.execute()
if __name__ == '__main__':
main()

19
tests/unit/plugins/modules/test_pacemaker_resource.py Normal file
View file

@ -0,0 +1,19 @@
# -*- coding: utf-8 -*-
# Author: Dexter Le (dextersydney2001@gmail.com)
# Largely adapted from test_redhat_subscription by
# Jiri Hnidek (jhnidek@redhat.com)
#
# Copyright (c) Dexter Le (dextersydney2001@gmail.com)
# Copyright (c) Jiri Hnidek (jhnidek@redhat.com)
#
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
from ansible_collections.community.general.plugins.modules import pacemaker_resource
from .uthelper import UTHelper, RunCommandMock
UTHelper.from_module(pacemaker_resource, __name__, mocks=[RunCommandMock])

210
tests/unit/plugins/modules/test_pacemaker_resource.yaml Normal file
View file

@ -0,0 +1,210 @@
# -*- coding: utf-8 -*-
# Copyright (c) Dexter Le (dextersydney2001@gmail.com)
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
---
anchors:
environ: &env-def {environ_update: {LANGUAGE: C, LC_ALL: C}, check_rc: false}
test_cases:
- id: test_missing_input
input: {}
output:
failed: true
msg: "missing required arguments: name"
- id: test_present_minimal_input_resource_not_exist
input:
state: present
name: virtual-ip
resource_type:
resource_name: IPaddr2
resource_option:
- "ip=[192.168.2.1]"
output:
changed: true
previous_value:
value: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
mocks:
run_command:
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 1
out: ""
err: ""
- command: [/testbin/pcs, resource, create, virtual-ip, IPaddr2, "ip=[192.168.2.1]", --wait=300]
environ: *env-def
rc: 0
out: "Assumed agent name 'ocf:heartbeat:IPaddr2' (deduced from 'IPAddr2')"
err: ""
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 0
out: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
err: ""
- id: test_present_minimal_input_resource_exists
input:
state: present
name: virtual-ip
resource_type:
resource_name: IPaddr2
resource_option:
- "ip=[192.168.2.1]"
output:
changed: false
previous_value: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
value: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
mocks:
run_command:
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 0
out: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
err: ""
- command: [/testbin/pcs, resource, create, virtual-ip, IPaddr2, "ip=[192.168.2.1]", --wait=300]
environ: *env-def
rc: 1
out: ""
err: "Error: 'virtual-ip' already exists\n"
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 0
out: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
err: ""
- id: test_absent_minimal_input_resource_not_exist
input:
state: absent
name: virtual-ip
output:
changed: false
previous_value:
value:
mocks:
run_command:
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 1
out: ""
err: ""
- command: [/testbin/pcs, resource, remove, virtual-ip]
environ: *env-def
rc: 1
out: ""
err: "Error: Resource 'virtual-ip' does not exist.\n"
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 1
out: ""
err: ""
- id: test_absent_minimal_input_resource_exists
input:
state: absent
name: virtual-ip
output:
changed: true
previous_value: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
value:
mocks:
run_command:
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 0
out: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
err: ""
- command: [/testbin/pcs, resource, remove, virtual-ip]
environ: *env-def
rc: 0
out: ""
err: "Attempting to stop: virtual-ip... Stopped\n"
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 1
out: ""
err: ""
- id: test_enabled_minimal_input_resource_not_exists
input:
state: enabled
name: virtual-ip
output:
failed: true
msg: "pcs failed with error (rc=1): bundle/clone/group/resource/tag 'virtual-ip' does not exist"
mocks:
run_command:
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 1
out: ""
err: ""
- command: [/testbin/pcs, resource, enable, virtual-ip]
environ: *env-def
rc: 1
out: ""
err: "bundle/clone/group/resource/tag 'virtual-ip' does not exist"
- id: test_enabled_minimal_input_resource_exists
input:
state: enabled
name: virtual-ip
output:
changed: true
previous_value: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Stopped (disabled)"
value: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Starting"
mocks:
run_command:
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 0
out: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Stopped (disabled)"
err: ""
- command: [/testbin/pcs, resource, enable, virtual-ip]
environ: *env-def
rc: 0
out: ""
err: ""
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 0
out: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Starting"
err: ""
- id: test_disable_minimal_input_resource_not_exists
input:
state: disabled
name: virtual-ip
output:
failed: true
msg: "pcs failed with error (rc=1): bundle/clone/group/resource/tag 'virtual-ip' does not exist"
mocks:
run_command:
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 1
out: ""
err: ""
- command: [/testbin/pcs, resource, disable, virtual-ip]
environ: *env-def
rc: 1
out: ""
err: "bundle/clone/group/resource/tag 'virtual-ip' does not exist"
- id: test_disable_minimal_input_resource_exists
input:
state: disabled
name: virtual-ip
output:
changed: true
previous_value: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
value: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Stopped (disabled)"
mocks:
run_command:
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 0
out: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Started"
err: ""
- command: [/testbin/pcs, resource, disable, virtual-ip]
environ: *env-def
rc: 0
out: ""
err: ""
- command: [/testbin/pcs, resource, status, virtual-ip]
environ: *env-def
rc: 0
out: " * virtual-ip\t(ocf:heartbeat:IPAddr2):\t Stopped (disabled)"
err: ""