Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ceph_ec_profile: add support more plugins (backport #7499) #7515

Merged
merged 3 commits into from
Mar 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions group_vars/osds.yml.sample
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,8 @@ dummy:
# - "{{ crush_rule_hdd }}"
# - "{{ crush_rule_ssd }}"

#ceph_ec_profiles: {}

# Caution: this will create crush roots and racks according to hostvars {{ osd_crush_location }}
# and will move hosts into them which might lead to significant data movement in the cluster!
#
Expand Down
95 changes: 51 additions & 44 deletions library/ceph_ec_profile.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@
RETURN = '''# '''


def get_profile(module, name, cluster='ceph', container_image=None):
def get_profile(name, cluster='ceph', container_image=None):
'''
Get existing profile
'''
Expand All @@ -116,16 +116,14 @@ def get_profile(module, name, cluster='ceph', container_image=None):
return cmd


def create_profile(module, name, k, m, stripe_unit, crush_device_class, cluster='ceph', force=False, container_image=None): # noqa: E501
def create_profile(name, user_profile, force, cluster='ceph', container_image=None): # noqa: E501
'''
Create a profile
'''

args = ['set', name, 'k={}'.format(k), 'm={}'.format(m)]
if stripe_unit:
args.append('stripe_unit={}'.format(stripe_unit))
if crush_device_class:
args.append('crush-device-class={}'.format(crush_device_class))
args = ['set', name]
for key, value in user_profile.items():
args.append('{}={}'.format(key, value))
if force:
args.append('--force')

Expand All @@ -137,7 +135,7 @@ def create_profile(module, name, k, m, stripe_unit, crush_device_class, cluster=
return cmd


def delete_profile(module, name, cluster='ceph', container_image=None):
def delete_profile(name, cluster='ceph', container_image=None):
'''
Delete a profile
'''
Expand All @@ -152,16 +150,41 @@ def delete_profile(module, name, cluster='ceph', container_image=None):
return cmd


def parse_user_profile(module):
profile_keys = ['plugin',
'k', 'm', 'd', 'l', 'c',
'stripe_unit', 'scalar_mds', 'technique',
'crush-root', 'crush-device-class', 'crush-failure-domain']

profile = {}
for key in profile_keys:
ansible_lookup_key = key.replace('-', '_')
value = module.params.get(ansible_lookup_key)
if value:
profile[key] = value

return profile


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'], default='present'),
stripe_unit=dict(type='str', required=False),
plugin=dict(type='str', required=False, default='jerasure'),
k=dict(type='str', required=False),
m=dict(type='str', required=False),
crush_device_class=dict(type='str', required=False, default=''),
d=dict(type='str', required=False),
l=dict(type='str', required=False),
c=dict(type='str', required=False),
scalar_mds=dict(type='str', required=False),
technique=dict(type='str', required=False),
crush_root=dict(type='str', required=False),
crush_failure_domain=dict(type='str', required=False),
crush_device_class=dict(type='str', required=False),
force=dict(type='bool', required=False, default=False),
)

module = AnsibleModule(
Expand All @@ -174,10 +197,8 @@ def run_module():
name = module.params.get('name')
cluster = module.params.get('cluster')
state = module.params.get('state')
stripe_unit = module.params.get('stripe_unit')
k = module.params.get('k')
m = module.params.get('m')
crush_device_class = module.params.get('crush_device_class')
force = module.params.get('force')
user_profile = parse_user_profile(module)

if module.check_mode:
module.exit_json(
Expand All @@ -191,54 +212,40 @@ def run_module():
)

startd = datetime.datetime.now()
diff = dict(before="", after="")
changed = False

# will return either the image name or None
container_image = is_containerized()

if state == "present":
rc, cmd, out, err = exec_command(module, get_profile(module, name, cluster, container_image=container_image)) # noqa: E501
rc, cmd, out, err = exec_command(module, get_profile(name, cluster, container_image=container_image)) # noqa: E501
current_profile = {}
if rc == 0:
# the profile already exists, let's check whether we have to
# update it
current_profile = json.loads(out)
if current_profile['k'] != k or \
current_profile['m'] != m or \
current_profile.get('stripe_unit', stripe_unit) != stripe_unit or \
current_profile.get('crush-device-class', crush_device_class) != crush_device_class: # noqa: E501
rc, cmd, out, err = exec_command(module,
create_profile(module,
name,
k,
m,
stripe_unit,
crush_device_class, # noqa: E501
cluster,
force=True, container_image=container_image)) # noqa: E501
changed = True
else:
# the profile doesn't exist, it has to be created
rc, cmd, out, err = exec_command(module, create_profile(module,
name,
k,
m,
stripe_unit, # noqa: E501
crush_device_class, # noqa: E501
cluster,
container_image=container_image)) # noqa: E501
if rc == 0:
changed = True

changed = current_profile != user_profile
if changed:
diff['before'] = json.dumps(current_profile)
diff['after'] = json.dumps(user_profile)
rc, cmd, out, err = exec_command(module,
create_profile(name,
user_profile,
force,
cluster,
container_image=container_image), # noqa: E501
check_rc=True)

elif state == "absent":
rc, cmd, out, err = exec_command(module, delete_profile(module, name, cluster, container_image=container_image)) # noqa: E501
rc, cmd, out, err = exec_command(module, delete_profile(name, cluster, container_image=container_image)) # noqa: E501
if not err:
out = 'Profile {} removed.'.format(name)
changed = True
else:
rc = 0
out = "Skipping, the profile {} doesn't exist".format(name)

exit_module(module=module, out=out, rc=rc, cmd=cmd, err=err, startd=startd, changed=changed) # noqa: E501
exit_module(module=module, out=out, rc=rc, cmd=cmd, err=err, startd=startd, changed=changed, diff=diff) # noqa: E501


def main():
Expand Down
4 changes: 2 additions & 2 deletions module_utils/ca_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,15 @@ def pre_generate_cmd(cmd, container_image=None, interactive=False):
return cmd


def exec_command(module, cmd, stdin=None):
def exec_command(module, cmd, stdin=None, check_rc=False):
'''
Execute command(s)
'''

binary_data = False
if stdin:
binary_data = True
rc, out, err = module.run_command(cmd, data=stdin, binary_data=binary_data)
rc, out, err = module.run_command(cmd, data=stdin, binary_data=binary_data, check_rc=check_rc) # noqa: E501

return rc, cmd, out, err

Expand Down
2 changes: 2 additions & 0 deletions roles/ceph-osd/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ crush_rules:
- "{{ crush_rule_hdd }}"
- "{{ crush_rule_ssd }}"

ceph_ec_profiles: {}

# Caution: this will create crush roots and racks according to hostvars {{ osd_crush_location }}
# and will move hosts into them which might lead to significant data movement in the cluster!
#
Expand Down
32 changes: 29 additions & 3 deletions roles/ceph-osd/tasks/crush_rules.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,39 @@
- hostvars[groups[mon_group_name][0]]['create_crush_tree'] | default(create_crush_tree) | bool
- osd_crush_location is defined

- name: Create configured ec profiles
ceph_ec_profile:
name: "{{ item.key }}"
cluster: "{{ cluster }}"
state: "{{ item.value.state | default('present') }}"
stripe_unit: "{{ item.value.stripe_unit | default(omit) }}"
plugin: "{{ item.value.plugin | default(omit) }}"
k: "{{ item.value.k }}"
m: "{{ item.value.m }}"
d: "{{ item.value.d | default(omit) }}"
l: "{{ item.value.l | default(omit) }}"
c: "{{ item.value.c | default(omit) }}"
scalar_mds: "{{ item.value.scalar_mds | default(omit) }}"
technique: "{{ item.value.technique | default(omit) }}"
crush_root: "{{ item.value.crush_root | default(omit) }}"
crush_failure_domain: "{{ item.value.crush_failure_domain | default(omit) }}"
crush_device_class: "{{ item.value.crush_device_class | default(omit) }}"
force: "{{ item.value.force | default(false) }}"
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 }}"
loop: "{{ ceph_ec_profiles | dict2items }}"
delegate_to: '{{ groups[mon_group_name][0] }}'
run_once: true

- name: Create configured crush rules
ceph_crush_rule:
name: "{{ item.name }}"
cluster: "{{ cluster }}"
rule_type: replicated
bucket_root: "{{ item.root }}"
bucket_type: "{{ item.type }}"
rule_type: "{{ item.rule_type | default('replicated') }}"
profile: "{{ item.ec_profile | default(omit) }}"
bucket_root: "{{ item.root | default(omit) }}"
bucket_type: "{{ item.type | default(omit) }}"
device_class: "{{ item.class | default(omit) }}"
environment:
CEPH_CONTAINER_IMAGE: "{{ ceph_docker_registry + '/' + ceph_docker_image + ':' + ceph_docker_image_tag if containerized_deployment | bool else None }}"
Expand Down
42 changes: 10 additions & 32 deletions roles/ceph-rgw/tasks/rgw_create_pools.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
ceph_ec_profile:
name: "{{ item.value.ec_profile }}"
cluster: "{{ cluster }}"
k: "{{ item.value.ec_k }}"
m: "{{ item.value.ec_m }}"
k: "{{ item.value.ec_k | default(omit) }}"
m: "{{ item.value.ec_m | default(omit) }}"
crush_device_class: "{{ item.value.ec_crush_device_class | default(omit) }}"
delegate_to: "{{ groups[mon_group_name][0] }}"
loop: "{{ rgw_create_pools | dict2items }}"
when:
- item.value.type is defined
- item.value.type == 'ec'
- item.value.create_profile | default(true)
- item.value.type | default('') == 'ec'
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 }}"
Expand All @@ -27,32 +27,10 @@
loop: "{{ rgw_create_pools | dict2items }}"
delegate_to: "{{ groups[mon_group_name][0] }}"
when:
- item.value.type is defined
- item.value.type == 'ec'
- item.value.create_profile | default(true)
- item.value.type | default('') == 'ec'

- name: Create ec pools for rgw
ceph_pool:
name: "{{ item.key }}"
state: present
cluster: "{{ cluster }}"
pg_num: "{{ item.value.pg_num | default(omit) }}"
pgp_num: "{{ item.value.pgp_num | default(omit) }}"
size: "{{ item.value.size | default(omit) }}"
pg_autoscale_mode: "{{ item.value.pg_autoscale_mode | default(omit) }}"
target_size_ratio: "{{ item.value.target_size_ratio | default(omit) }}"
pool_type: erasure
erasure_profile: "{{ item.value.ec_profile }}"
application: rgw
loop: "{{ rgw_create_pools | dict2items }}"
delegate_to: "{{ groups[mon_group_name][0] }}"
when:
- item.value.type is defined
- item.value.type == 'ec'
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 replicated pools for rgw
- name: Create rgw pools
ceph_pool:
name: "{{ item.key }}"
state: present
Expand All @@ -63,12 +41,12 @@
min_size: "{{ item.value.min_size | default(omit) }}"
pg_autoscale_mode: "{{ item.value.pg_autoscale_mode | default(omit) }}"
target_size_ratio: "{{ item.value.target_size_ratio | default(omit) }}"
pool_type: replicated
rule_name: "{{ item.value.rule_name | default(ceph_osd_pool_default_crush_rule_name) }}"
pool_type: "{{ 'erasure' if item.value.type | default('') == 'ec' else 'replicated' }}"
erasure_profile: "{{ item.value.ec_profile | default(omit) }}"
rule_name: "{{ item.value.rule_name if item.value.rule_name is defined else item.key if item.value.type | default('') == 'ec' else ceph_osd_pool_default_crush_rule_name }}"
application: rgw
loop: "{{ rgw_create_pools | dict2items }}"
delegate_to: "{{ groups[mon_group_name][0] }}"
when: item.value.type is not defined or item.value.type == 'replicated'
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 }}"
2 changes: 2 additions & 0 deletions roles/ceph-validate/tasks/check_rgw_pools.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
when:
- item.value.type is defined
- item.value.type == 'ec'
- item.value.create_profile | default(true)
- item.value.ec_k is undefined

- name: Fail if ec_m is not set for ec pools
Expand All @@ -24,4 +25,5 @@
when:
- item.value.type is defined
- item.value.type == 'ec'
- item.value.create_profile | default(true)
- item.value.ec_m is undefined
Loading