ceph.ceph_admin.apply module

Represent the ceph orch CLI action ‘apply’.

Module to deploy ceph role service(s) using orchestration command “ceph orch apply <role> [options] –placement ‘<placements>’ “

This is a mixin object and can be applied to the supported service classes.

class ceph.ceph_admin.apply.ApplyMixin

Bases: object

Add apply command support to child object.

apply(config: Dict) None

Execute the apply method using the object’s service name and provided input.

Parameters

config (Dict) – Key/value pairs passed from the test suite.

Example:

base_cmd_args   - key/value pairs to set for base command
pos_args        - List to be added as positional params
args            - Key/value pairs as optional arguments.

config:
    command: apply
    service: rgw
    base_cmd_args:          # arguments to ceph orch
        concise: true
        verbose: true
        input_file: <name of spec>
    pos_args:               # positional arguments
        - india             # realm
        - south             # zone
    args:
        placement:
            label: rgw_south
            nodes:              # A list of strings that would looked up
                - node1
            limit: 3            # no of daemons
            sep: " "            # separator to be used for placements
        dry-run: true
        unmanaged: true
exception ceph.ceph_admin.apply.OrchApplyServiceFailure

Bases: Exception