cluster

Manages the MicroCeph cluster.

Usage:

microceph cluster [flags]
microceph cluster [command]

Available commands:

add                    Generates a token for a new server
bootstrap              Sets up a new cluster
bootstrap-ceph         Bootstrap Ceph on an existing Microcluster member
config                 Manage Ceph Cluster configs
export                 Generates cluster token for given Remote cluster
join                   Joins an existing cluster
list                   List servers in the cluster
maintenance            Enter or exit the maintenance mode.
migrate                Migrate automatic services from one node to another
remove                 Removes a server from the cluster
sql                    Runs a SQL query against the cluster database

Global options:

-d, --debug       Show all debug messages
-h, --help        Print help
    --state-dir   Path to store state information
-v, --verbose     Show all information messages
    --version     Print version number

add

Generates a token for a new server

Usage:

microceph cluster add <NAME> [flags]

bootstrap

Sets up a new cluster

Usage:

microceph cluster bootstrap [flags]

Flags:

--availability-zone string Availability zone for failure domain distribution.
--microceph-ip      string Network address microceph daemon binds to.
--mon-ip            string Public address for bootstrapping ceph mon service.
--public-network    string Comma-delimited list of CIDRs for the Ceph public network (Ceph daemons bind addresses).
--cluster-network   string Comma-delimited list of CIDRs for the Ceph cluster network (OSD replication/recovery traffic).
--v2-only                  Whether to support V2 messenger only or both V1 and V2.
--defer-ceph               Initialize Microcluster only and defer Ceph bootstrap. Ceph network flags (--mon-ip, --public-network, --cluster-network, --v2-only) are ignored with this option; pass them to 'cluster bootstrap-ceph' instead.

bootstrap-ceph

Bootstrap Ceph on an existing Microcluster member. This is used after a deferred bootstrap (cluster bootstrap --defer-ceph) to complete the Ceph bootstrap on a specific member.

Usage:

microceph cluster bootstrap-ceph [flags]

Flags:

--availability-zone   string Availability zone for the bootstrap target host.
--cluster-network     string Comma-delimited list of CIDRs for the Ceph cluster network (OSD replication/recovery traffic).
--force                      Recover from a stale in_progress bootstrap state (reset to failed then retry). Not for normal use. Must not be used while a live bootstrap may be running on another member.
--mon-ip             string Public address for bootstrapping ceph mon service.
--public-network     string Comma-delimited list of CIDRs for the Ceph public network (Ceph daemons bind addresses).
--target             string Target Microcluster member name for Ceph bootstrap (required).
--v2-only                   Whether to support V2 messenger only or both V1 and V2.

Warning

--force resets any in_progress lifecycle row, including one belonging to a genuinely live bootstrap running on another member. Using --force while a live bootstrap is in progress can cause two members to race to bootstrap divergent Ceph clusters. Only use --force to recover from a stale in_progress state left behind by a crashed or stuck daemon, and only after confirming no bootstrap is running elsewhere in the cluster.

config

Manages Ceph Cluster configs.

Usage:

microceph cluster config [flags]
microceph cluster config [command]

Available Commands:

get         Get specified Ceph Cluster config
list        List all set Ceph level configs
reset       Clear specified Ceph Cluster config
set         Set specified Ceph Cluster config

config get

Gets specified Ceph Cluster config.

Usage:

microceph cluster config get <key> [flags]

config list

Lists all set Ceph level configs.

Usage:

microceph cluster config list [flags]

config reset

Clears specified Ceph Cluster config.

Usage:

microceph cluster config reset <key> [flags]

Flags:

--wait           Wait for required ceph services to restart post config reset.
--skip-restart   Don't perform the daemon restart for current config.

config set

Sets specified Ceph Cluster config.

Usage:

microceph cluster config set <Key> <Value> [flags]

Flags:

--wait           Wait for required ceph services to restart post config set.
--skip-restart   Don't perform the daemon restart for current config.

export

Generates cluster token for Remote cluster with given name.

Usage:

microceph cluster export <remote-name> [flags]

Flags:

--json   output as json string

join

Joins an existing cluster.

Usage:

microceph cluster join <TOKEN> [flags]

Flags:

--availability-zone string Availability zone for failure domain distribution.
--microceph-ip      string Network address microceph daemon binds to.
--defer-ceph               Join Microcluster only and defer Ceph join auto-placement.

list

Lists servers in the cluster.

Usage:

microceph cluster list [flags]

maintenance

Enter or exit the maintenance mode.

Usage:

microceph cluster maintenance [flags]
microceph cluster maintenance [command]

Available Commands:

enter       Enter maintenance mode.
exit        Exit maintenance mode.

maintenance enter

Enter maintenance mode.

Usage:

microceph cluster maintenance enter <NODE_NAME> [flags]

Flags:

--check-only     Only run the preflight checks (mutually exclusive with --ignore-check).
--dry-run        Dry run the command.
--force          Force to enter maintenance mode.
--ignore-check   Ignore the the preflight checks (mutually exclusive with --check-only).
--set-noout      Stop CRUSH from rebalancing the cluster. (default true)
--stop-osds      Stop the OSDS when entering maintenance mode.

maintenance exit

Exit maintenance mode.

Usage:

microceph cluster maintenance exit <NODE_NAME> [flags]

Flags:

--check-only     Only run the preflight checks (mutually exclusive with --ignore-check).
--dry-run        Dry run the command.
--ignore-check   Ignore the the preflight checks (mutually exclusive with --check-only).

migrate

Migrates automatic services from one node to another.

Usage:

microceph cluster migrate <SRC> <DST [flags]

remove

Removes a server from the cluster.

Syntax:

microceph cluster remove <NAME> [flags]

Flags:

-f, --force   Forcibly remove the cluster member

sql

Runs a SQL query against the cluster database.

Usage:

microceph cluster sql <query> [flags]