Notice
This document is for a development version of Ceph.
Cephadm
cephadm
is a utility that is used to manage a Ceph cluster.
Here is a list of some of the things that cephadm
can do:
cephadm
can add a Ceph container to the cluster.cephadm
can remove a Ceph container from the cluster.cephadm
can update Ceph containers.
cephadm
does not rely on external configuration tools like Ansible, Rook,
or Salt. However, those external configuration tools can be used to automate
operations not performed by cephadm itself. To learn more about these external
configuration tools, visit their pages:
cephadm
manages the full lifecycle of a Ceph cluster. This lifecycle starts
with the bootstrapping process, when cephadm
creates a tiny Ceph cluster on
a single node. This cluster consists of one monitor and one manager.
cephadm
then uses the orchestration interface to expand the cluster, adding
hosts and provisioning Ceph daemons and services. Management of this lifecycle
can be performed either via the Ceph command-line interface (CLI) or via the
dashboard (GUI).
To use cephadm
to get started with Ceph, follow the instructions in
Using cephadm to Deploy a New Ceph Cluster.
cephadm
was introduced in Ceph release v15.2.0 (Octopus) and does not
support older versions of Ceph.
- Compatibility and Stability
- Using cephadm to Deploy a New Ceph Cluster
- Converting an existing cluster to cephadm
- Host Management
- Service Management
- MON Service
- MGR Service
- OSD Service
- RGW Service
- MDS Service
- NFS Service
- iSCSI Service
- Custom Container Service
- Monitoring Services
- SNMP Gateway Service
- Tracing Services
- SMB Service
- Management Gateway
- OAuth2 Proxy
- Service Status
- Daemon Status
- Service Specification
- Daemon Placement
- Extra Container Arguments
- Extra Entrypoint Arguments
- Custom Config Files
- Removing a Service
- Disabling automatic deployment of daemons
- Upgrading Ceph
- Cephadm operations
- Client Setup
- Troubleshooting
- Pausing or Disabling cephadm
- Per-service and Per-daemon Events
- Checking Cephadm Logs
- Gathering Log Files
- Collecting Systemd Status
- List all Downloaded Container Images
- Manually Running Containers
- SSH Errors
- Failed to Infer CIDR network error
- Accessing the Admin Socket
- Running Various Ceph Tools
- Restoring the Monitor Quorum
- Manually Deploying a Manager Daemon
- Capturing Core Dumps
- Running the Debugger with cephadm
- Cephadm Feature Planning
Brought to you by the Ceph Foundation
The Ceph Documentation is a community resource funded and hosted by the non-profit Ceph Foundation. If you would like to support this and our other efforts, please consider joining now.