library: add radosgw_zonegroup module

This adds radosgw_zonegroup ansible module for replacing the command
module usage with the radosgw-admin zonegroup command.

Signed-off-by: Dimitri Savineau <dsavinea@redhat.com>
pull/5911/head
Dimitri Savineau 2020-08-12 17:43:29 -04:00 committed by Guillaume Abrioux
parent d171f4068d
commit 65dbe0782e
4 changed files with 518 additions and 20 deletions

View File

@ -0,0 +1,367 @@
# Copyright 2020, Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {
'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'
}
DOCUMENTATION = '''
---
module: radosgw_zonegroup
short_description: Manage RADOS Gateway Zonegroup
version_added: "2.8"
description:
- Manage RADOS Gateway zonegroup(s) creation, deletion and updates.
options:
cluster:
description:
- The ceph cluster name.
required: false
default: ceph
name:
description:
- name of the RADOS Gateway zonegroup.
required: true
state:
description:
If 'present' is used, the module creates a zonegroup if it doesn't
exist or update it if it already exists.
If 'absent' is used, the module will simply delete the zonegroup.
If 'info' is used, the module will return all details about the
existing zonegroup (json formatted).
required: false
choices: ['present', 'absent', 'info']
default: present
realm:
description:
- name of the RADOS Gateway realm.
required: true
endpoints:
description:
- endpoints of the RADOS Gateway zonegroup.
required: false
default: []
default:
description:
- set the default flag on the zonegroup.
required: false
default: false
master:
description:
- set the master flag on the zonegroup.
required: false
default: false
author:
- Dimitri Savineau <dsavinea@redhat.com>
'''
EXAMPLES = '''
- name: create a RADOS Gateway default zonegroup
radosgw_zonegroup:
name: foo
realm: bar
endpoints:
- http://192.168.1.10:8080
- http://192.168.1.11:8080
default: true
- name: get a RADOS Gateway zonegroup information
radosgw_zonegroup:
name: foo
realm: bar
state: info
- name: delete a RADOS Gateway zonegroup
radosgw_zonegroup:
name: foo
realm: bar
state: absent
'''
RETURN = '''# '''
from ansible.module_utils.basic import AnsibleModule # noqa E402
import datetime # noqa E402
import json # noqa E402
import os # noqa E402
import stat # noqa E402
import time # noqa E402
def container_exec(binary, container_image):
'''
Build the docker CLI to run a command inside a container
'''
container_binary = os.getenv('CEPH_CONTAINER_BINARY')
command_exec = [container_binary,
'run',
'--rm',
'--net=host',
'-v', '/etc/ceph:/etc/ceph:z',
'-v', '/var/lib/ceph/:/var/lib/ceph/:z',
'-v', '/var/log/ceph/:/var/log/ceph/:z',
'--entrypoint=' + binary, container_image]
return command_exec
def is_containerized():
'''
Check if we are running on a containerized cluster
'''
if 'CEPH_CONTAINER_IMAGE' in os.environ:
container_image = os.getenv('CEPH_CONTAINER_IMAGE')
else:
container_image = None
return container_image
def pre_generate_radosgw_cmd(container_image=None):
'''
Generate radosgw-admin prefix comaand
'''
if container_image:
cmd = container_exec('radosgw-admin', container_image)
else:
cmd = ['radosgw-admin']
return cmd
def generate_radosgw_cmd(cluster, args, container_image=None):
'''
Generate 'radosgw' command line to execute
'''
cmd = pre_generate_radosgw_cmd(container_image=container_image)
base_cmd = [
'--cluster',
cluster,
'zonegroup'
]
cmd.extend(base_cmd + args)
return cmd
def exec_commands(module, cmd):
'''
Execute command(s)
'''
rc, out, err = module.run_command(cmd)
return rc, cmd, out, err
def create_zonegroup(module, container_image=None):
'''
Create a new zonegroup
'''
cluster = module.params.get('cluster')
name = module.params.get('name')
realm = module.params.get('realm')
endpoints = module.params.get('endpoints')
default = module.params.get('default')
master = module.params.get('master')
args = ['create', '--rgw-realm=' + realm, '--rgw-zonegroup=' + name]
if endpoints:
args.extend(['--endpoints=' + ','.join(endpoints)])
if default:
args.append('--default')
if master:
args.append('--master')
cmd = generate_radosgw_cmd(cluster=cluster, args=args, container_image=container_image)
return cmd
def modify_zonegroup(module, container_image=None):
'''
Modify a new zonegroup
'''
cluster = module.params.get('cluster')
name = module.params.get('name')
realm = module.params.get('realm')
endpoints = module.params.get('endpoints')
default = module.params.get('default')
master = module.params.get('master')
args = ['modify', '--rgw-realm=' + realm, '--rgw-zonegroup=' + name]
if endpoints:
args.extend(['--endpoints=' + ','.join(endpoints)])
if default:
args.append('--default')
if master:
args.append('--master')
cmd = generate_radosgw_cmd(cluster=cluster, args=args, container_image=container_image)
return cmd
def get_zonegroup(module, container_image=None):
'''
Get existing zonegroup
'''
cluster = module.params.get('cluster')
name = module.params.get('name')
realm = module.params.get('realm')
args = ['get', '--rgw-realm=' + realm, '--rgw-zonegroup=' + name, '--format=json']
cmd = generate_radosgw_cmd(cluster=cluster,
args=args,
container_image=container_image)
return cmd
def remove_zonegroup(module, container_image=None):
'''
Remove a zonegroup
'''
cluster = module.params.get('cluster')
name = module.params.get('name')
realm = module.params.get('realm')
args = ['delete', '--rgw-realm=' + realm, '--rgw-zonegroup=' + name]
cmd = generate_radosgw_cmd(cluster=cluster, args=args, container_image=container_image)
return cmd
def exit_module(module, out, rc, cmd, err, startd, changed=False):
endd = datetime.datetime.now()
delta = endd - startd
result = dict(
cmd=cmd,
start=str(startd),
end=str(endd),
delta=str(delta),
rc=rc,
stdout=out.rstrip("\r\n"),
stderr=err.rstrip("\r\n"),
changed=changed,
)
module.exit_json(**result)
def run_module():
module_args = dict(
cluster=dict(type='str', required=False, default='ceph'),
name=dict(type='str', required=True),
state=dict(type='str', required=False, choices=['present', 'absent', 'info'], default='present'),
realm=dict(type='str', require=True),
endpoints=dict(type='list', require=False, default=[]),
default=dict(type='bool', required=False, default=False),
master=dict(type='bool', required=False, default=False),
)
module = AnsibleModule(
argument_spec=module_args,
supports_check_mode=True,
)
# Gather module parameters in variables
name = module.params.get('name')
state = module.params.get('state')
endpoints = module.params.get('endpoints')
master = str(module.params.get('master')).lower()
if module.check_mode:
module.exit_json(
changed=False,
stdout='',
stderr='',
rc=0,
start='',
end='',
delta='',
)
startd = datetime.datetime.now()
changed = False
# will return either the image name or None
container_image = is_containerized()
if state == "present":
rc, cmd, out, err = exec_commands(module, get_zonegroup(module, container_image=container_image))
if rc == 0:
zonegroup = json.loads(out)
current = {
'endpoints': zonegroup['endpoints'],
'master': zonegroup.get('is_master', 'false')
}
asked = {
'endpoints': endpoints,
'master': master
}
if current != asked:
rc, cmd, out, err = exec_commands(module, modify_zonegroup(module, container_image=container_image))
changed = True
else:
rc, cmd, out, err = exec_commands(module, create_zonegroup(module, container_image=container_image))
changed = True
elif state == "absent":
rc, cmd, out, err = exec_commands(module, get_zonegroup(module, container_image=container_image))
if rc == 0:
rc, cmd, out, err = exec_commands(module, remove_zonegroup(module, container_image=container_image))
changed = True
else:
rc = 0
out = "Zonegroup {} doesn't exist".format(name)
elif state == "info":
rc, cmd, out, err = exec_commands(module, get_zonegroup(module, container_image=container_image))
exit_module(module=module, out=out, rc=rc, cmd=cmd, err=err, startd=startd, changed=changed)
def main():
run_module()
if __name__ == '__main__':
main()

View File

@ -1,15 +1,4 @@
---
- name: check if the zonegroup already exists
command: "{{ container_exec_cmd }} radosgw-admin zonegroup get --cluster={{ cluster }} --rgw-realm={{ item.realm }} --rgw-zonegroup={{ item.zonegroup }}"
delegate_to: "{{ groups[mon_group_name][0] }}"
register: zonegroupcheck
failed_when: False
changed_when: False
check_mode: no
run_once: True
loop: "{{ zonegroups }}"
when: zonegroups is defined
- name: check if the zone already exists
command: "{{ container_exec_cmd }} radosgw-admin zone get --rgw-realm={{ item.realm }} --cluster={{ cluster }} --rgw-zonegroup={{ item.zonegroup }} --rgw-zone={{ item.zone }}"
delegate_to: "{{ groups[mon_group_name][0] }}"

View File

@ -13,15 +13,19 @@
CEPH_CONTAINER_BINARY: "{{ container_binary }}"
- name: create zonegroup(s)
command: "{{ container_exec_cmd }} radosgw-admin zonegroup create --cluster={{ cluster }} --rgw-realm={{ item.item.realm }} --rgw-zonegroup={{ item.item.zonegroup }} {{ '--default' if zonegroups | length == 1 else '' }} {{ '--master' if item.item.is_master | bool else '' }}"
radosgw_zonegroup:
name: "{{ item.zonegroup }}"
cluster: "{{ cluster }}"
realm: "{{ item.realm }}"
default: "{{ true if zonegroups | length == 1 else false }}"
master: "{{ true if item.is_master | bool else false }}"
delegate_to: "{{ groups[mon_group_name][0] }}"
run_once: true
loop: "{{ zonegroupcheck.results }}"
when:
- zonegroups is defined
- zonegroups | length > 0
- item.item.is_master | bool
- "'No such file or directory' in item.stderr"
loop: "{{ zonegroups }}"
when: zonegroups is defined
environment:
CEPH_CONTAINER_IMAGE: "{{ ceph_docker_registry + '/' + ceph_docker_image + ':' + ceph_docker_image_tag if containerized_deployment | bool else None }}"
CEPH_CONTAINER_BINARY: "{{ container_binary }}"
- name: create the master zone
command: "{{ container_exec_cmd }} radosgw-admin zone create --cluster={{ cluster }} --rgw-realm={{ item.item.realm }} --rgw-zonegroup={{ item.item.zonegroup }} --rgw-zone={{ item.item.zone }} --access-key={{ item.item.system_access_key }} --secret={{ item.item.system_secret_key }} {{ '--default' if zones | length == 1 else '' }} --master"
@ -35,13 +39,20 @@
- "'No such file or directory' in item.stderr"
- name: add endpoints to their zone groups(s)
command: "{{ container_exec_cmd }} radosgw-admin zonegroup modify --cluster={{ cluster }} --rgw-realm={{ item.realm }} --rgw-zonegroup={{ item.zonegroup }} --endpoints {{ item.endpoints }}"
loop: "{{ zone_endpoints_list }}"
radosgw_zonegroup:
name: "{{ item.zonegroup }}"
cluster: "{{ cluster }}"
realm: "{{ item.realm }}"
endpoints: "{{ item.endpoints.split(',') }}"
delegate_to: "{{ groups[mon_group_name][0] }}"
run_once: true
loop: "{{ zone_endpoints_list }}"
when:
- zone_endpoints_list is defined
- item.is_master | bool
environment:
CEPH_CONTAINER_IMAGE: "{{ ceph_docker_registry + '/' + ceph_docker_image + ':' + ceph_docker_image_tag if containerized_deployment | bool else None }}"
CEPH_CONTAINER_BINARY: "{{ container_binary }}"
- name: add endpoints to their zone(s)
command: "{{ container_exec_cmd }} radosgw-admin zone modify --cluster={{ cluster }} --rgw-realm={{ item.realm }} --rgw-zonegroup={{ item.zonegroup }} --rgw-zone={{ item.zone }} --endpoints {{ item.endpoints }}"

View File

@ -0,0 +1,131 @@
import os
import sys
from mock.mock import patch, MagicMock
import pytest
sys.path.append('./library')
import radosgw_zonegroup # noqa: E402
fake_binary = 'radosgw-admin'
fake_cluster = 'ceph'
fake_container_binary = 'podman'
fake_container_image = 'docker.io/ceph/daemon:latest'
fake_container_cmd = [
fake_container_binary,
'run',
'--rm',
'--net=host',
'-v', '/etc/ceph:/etc/ceph:z',
'-v', '/var/lib/ceph/:/var/lib/ceph/:z',
'-v', '/var/log/ceph/:/var/log/ceph/:z',
'--entrypoint=' + fake_binary,
fake_container_image
]
fake_realm = 'foo'
fake_zonegroup = 'bar'
fake_endpoints = ['http://192.168.1.10:8080', 'http://192.168.1.11:8080']
fake_params = {'cluster': fake_cluster,
'name': fake_zonegroup,
'realm': fake_realm,
'endpoints': fake_endpoints,
'default': True,
'master': True}
class TestRadosgwZonegroupModule(object):
@patch.dict(os.environ, {'CEPH_CONTAINER_BINARY': fake_container_binary})
def test_container_exec(self):
cmd = radosgw_zonegroup.container_exec(fake_binary, fake_container_image)
assert cmd == fake_container_cmd
def test_not_is_containerized(self):
assert radosgw_zonegroup.is_containerized() is None
@patch.dict(os.environ, {'CEPH_CONTAINER_IMAGE': fake_container_image})
def test_is_containerized(self):
assert radosgw_zonegroup.is_containerized() == fake_container_image
@pytest.mark.parametrize('image', [None, fake_container_image])
@patch.dict(os.environ, {'CEPH_CONTAINER_BINARY': fake_container_binary})
def test_pre_generate_radosgw_cmd(self, image):
if image:
expected_cmd = fake_container_cmd
else:
expected_cmd = [fake_binary]
assert radosgw_zonegroup.pre_generate_radosgw_cmd(image) == expected_cmd
@pytest.mark.parametrize('image', [None, fake_container_image])
@patch.dict(os.environ, {'CEPH_CONTAINER_BINARY': fake_container_binary})
def test_generate_radosgw_cmd(self, image):
if image:
expected_cmd = fake_container_cmd
else:
expected_cmd = [fake_binary]
expected_cmd.extend([
'--cluster',
fake_cluster,
'zonegroup'
])
assert radosgw_zonegroup.generate_radosgw_cmd(fake_cluster, [], image) == expected_cmd
def test_create_zonegroup(self):
fake_module = MagicMock()
fake_module.params = fake_params
expected_cmd = [
fake_binary,
'--cluster', fake_cluster,
'zonegroup', 'create',
'--rgw-realm=' + fake_realm,
'--rgw-zonegroup=' + fake_zonegroup,
'--endpoints=' + ','.join(fake_endpoints),
'--default',
'--master'
]
assert radosgw_zonegroup.create_zonegroup(fake_module) == expected_cmd
def test_modify_zonegroup(self):
fake_module = MagicMock()
fake_module.params = fake_params
expected_cmd = [
fake_binary,
'--cluster', fake_cluster,
'zonegroup', 'modify',
'--rgw-realm=' + fake_realm,
'--rgw-zonegroup=' + fake_zonegroup,
'--endpoints=' + ','.join(fake_endpoints),
'--default',
'--master'
]
assert radosgw_zonegroup.modify_zonegroup(fake_module) == expected_cmd
def test_get_zonegroup(self):
fake_module = MagicMock()
fake_module.params = fake_params
expected_cmd = [
fake_binary,
'--cluster', fake_cluster,
'zonegroup', 'get',
'--rgw-realm=' + fake_realm,
'--rgw-zonegroup=' + fake_zonegroup,
'--format=json'
]
assert radosgw_zonegroup.get_zonegroup(fake_module) == expected_cmd
def test_remove_zonegroup(self):
fake_module = MagicMock()
fake_module.params = fake_params
expected_cmd = [
fake_binary,
'--cluster', fake_cluster,
'zonegroup', 'delete',
'--rgw-realm=' + fake_realm,
'--rgw-zonegroup=' + fake_zonegroup
]
assert radosgw_zonegroup.remove_zonegroup(fake_module) == expected_cmd