stackhpc.cephadm.cephadm_pool (1.15.1) — module

Install collection

Install with ansible-galaxy collection install stackhpc.cephadm:==1.15.1

Add to requirements.yml

  collections:
    - name: stackhpc.cephadm
      version: 1.15.1

Description

Manage Ceph pool(s) creation, deletion and updates.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create Ceph pools
  hosts: all
  become: true
  tasks:
    - name: Create a pool
      ceph_pool:
        name: "{{ item.name }}"
        state: present
        size: "{{ item.size }}"
        application: "{{ item.application }}"
        pool_type: "{{ item.pool_type }}"
        pg_autoscale_mode: "{{ item.pg_autoscale_mode }}"
      with_items: "{{ pools }}"

Inputs

    
name:
    description:
    - name of the Ceph pool
    required: true
    type: str

size:
    description:
    - set the replica size of the pool.
    required: false
    type: str

state:
    choices:
    - present
    - absent
    - list
    default: present
    description:
    - If 'present' is used, the module creates a pool if it doesn't exist or update it
      if it already exists. If 'absent' is used, the module will simply delete the pool.
      If 'list' is used, the module will return all details about the existing pools.
      (json formatted).
    required: false
    type: str

pg_num:
    default: default to `osd_pool_default_pg_num` (ceph)
    description:
    - set the pg_num of the pool.
    required: false
    type: str

details:
    description:
    - show details when state is list
    required: false
    type: bool

pgp_num:
    default: default to `osd_pool_default_pgp_num` (ceph)
    description:
    - set the pgp_num of the pool.
    required: false
    type: str

min_size:
    default: default to `osd_pool_default_min_size` (ceph)
    description:
    - set the min_size parameter of the pool.
    required: false
    type: str

pool_type:
    choices:
    - replicated
    - erasure
    default: replicated
    description:
    - set the pool type, either 'replicated' or 'erasure'
    required: false
    type: str

rule_name:
    description:
    - Set the crush rule name assigned to the pool
    required: false
    type: str

application:
    default: None
    description:
    - Set the pool application on the pool.
    required: false
    type: str

erasure_profile:
    default: default
    description:
    - When pool_type = 'erasure', set the erasure profile of the pool
    required: false
    type: str

pg_autoscale_mode:
    default: 'on'
    description:
    - set the pg autoscaler on the pool.
    required: false
    type: str

target_size_ratio:
    description:
    - set the target_size_ratio on the pool
    required: false
    type: str

allow_ec_overwrites:
    default: false
    description:
    - Set the allow_ec_overwrites paramter of the pool.
    required: false
    type: bool

expected_num_objects:
    default: '0'
    description:
    - Set the expected_num_objects parameter of the pool.
    required: false
    type: str