ceph.ceph_admin package

Submodules

• ceph.ceph_admin.add module
• ceph.ceph_admin.alert_manager module
• ceph.ceph_admin.apply module
• ceph.ceph_admin.bootstrap module
• ceph.ceph_admin.ceph module
• ceph.ceph_admin.cephadm_ansible module
• ceph.ceph_admin.cephfs_mirror module
• ceph.ceph_admin.client_keyring module
• ceph.ceph_admin.common module
• ceph.ceph_admin.crash module
• ceph.ceph_admin.daemon module
• ceph.ceph_admin.dashboard module
• ceph.ceph_admin.device module
• ceph.ceph_admin.grafana module
• ceph.ceph_admin.helper module
• ceph.ceph_admin.host module
• ceph.ceph_admin.iscsi module
• ceph.ceph_admin.ls module
• ceph.ceph_admin.maintenance module
• ceph.ceph_admin.manager module
• ceph.ceph_admin.mds module
• ceph.ceph_admin.mgr module
• ceph.ceph_admin.mon module
• ceph.ceph_admin.nfs module
• ceph.ceph_admin.node_exporter module
• ceph.ceph_admin.orch module
• ceph.ceph_admin.osd module
• ceph.ceph_admin.pause module
• ceph.ceph_admin.prometheus module
• ceph.ceph_admin.ps module
• ceph.ceph_admin.rbd_mirror module
• ceph.ceph_admin.reconfig module
• ceph.ceph_admin.redeploy module
• ceph.ceph_admin.remove module
• ceph.ceph_admin.restart module
• ceph.ceph_admin.resume module
• ceph.ceph_admin.rgw module
• ceph.ceph_admin.rm module
• ceph.ceph_admin.shell module
• ceph.ceph_admin.snmp_gateway module
• ceph.ceph_admin.start module
• ceph.ceph_admin.stop module
• ceph.ceph_admin.typing_ module
• ceph.ceph_admin.upgrade module

Module contents

Ceph Administrator aka cephadm module is a configuration tool for Ceph cluster.

It allows the users to deploy and manage their Ceph cluster. It also supports all the operations part of the cluster lifecycle.

Over here, we create a glue between the CLI and CephCI to allow the QE to write test scenarios for verifying and validating cephadm.

class ceph.ceph_admin.CephAdmin(cluster, **config)

Bases: BootstrapMixin, ShellMixin

Ceph administrator base class which enables ceph pre-requisites and Inherits HostMixin and BootstrapMixin classes to support host and bootstrap operations respectively

TIMEOUT = 300

direct_calls = ['bootstrap', 'shell']

distribute_cephadm_gen_pub_key(ssh_key_path=None, nodes=None)

Distribute cephadm generated public key to all nodes in the list.

Parameters

• ssh_key_path (Str) – custom SSH ceph public key path (default: None)

• nodes (List) – node list to add ceph public key (default: None)

get_cluster_state(commands)

Display cluster state by executing commands provided Just used for sanity.

Parameters

commands (List) – list of commands

install(**kwargs: Dict) → None

Install the cephadm package in all node(s).

Parameters

kwargs (Dict) – Key/value pairs that needs to be provided to the installer

Example:

Supported keys:
  upgrade: boolean # to upgrade cephadm RPM package
  gpgcheck: boolean

Note

At present, they are prefixed with – hence use long options

read_cephadm_gen_pub_key(ssh_key_path=None)

Read cephadm generated public key.

Arg:

ssh_key_path ( Str ): custom ssh public key path

Returns

Public Key string (Str)

set_cdn_tool_repo()

Enable the cdn Tools repo on all ceph node.

set_tool_repo(repo=None)

Add the given repo on every node part of the cluster.

Parameters

repo (Str) – repository (default: None)

setup_upstream_repository(repo_url=None)

Download upstream repository to inidividual nodes.

Parameters

repo_url – repo file URL link (default: None)