mirror of
https://github.com/ceph/ceph
synced 2025-04-01 00:26:47 +00:00
Merge pull request #34673 from sebastian-philipp/cephadm-man
doc/man: add cephadm Reviewed-by: Alexandra Settle <asettle@suse.com> Reviewed-by: Michael Fritch <mfritch@suse.com> Reviewed-by: Zac Dover <zac.dover@gmail.com>
This commit is contained in:
Sebastian Wagner
GitHub
commit
5bef4cbf34
@ -1465,6 +1465,7 @@ exit 0
|
||||
|
||||
%files -n cephadm
|
||||
%{_sbindir}/cephadm
|
||||
%{_mandir}/man8/cephadm.8*
|
||||
%{_sysconfdir}/sudoers.d/cephadm
|
||||
%attr(0700,cephadm,cephadm) %dir %{_sharedstatedir}/cephadm
|
||||
%attr(0700,cephadm,cephadm) %dir %{_sharedstatedir}/cephadm/.ssh
|
||||
|
||||
1
debian/cephadm.install
vendored
1
debian/cephadm.install
vendored
@ -1,2 +1,3 @@
|
||||
usr/sbin/cephadm
|
||||
usr/share/man/man8/cephadm.8
|
||||
etc/sudoers.d/cephadm
|
||||
|
||||
@ -37,7 +37,8 @@ list(APPEND man_srcs
|
||||
${osd_srcs}
|
||||
${mon_srcs}
|
||||
ceph-mds.rst
|
||||
librados-config.rst)
|
||||
librados-config.rst
|
||||
cephadm.rst)
|
||||
|
||||
if(HAVE_LIBFUSE)
|
||||
list(APPEND man_srcs
|
||||
|
||||
441
doc/man/8/cephadm.rst
Normal file
441
doc/man/8/cephadm.rst
Normal file
@ -0,0 +1,441 @@
|
||||
:orphan:
|
||||
|
||||
=========================================
|
||||
cephadm -- manage the local cephadm host
|
||||
=========================================
|
||||
|
||||
.. program:: cephadm
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
| **cephadm**** [-h] [--image IMAGE] [--docker] [--data-dir DATA_DIR]
|
||||
| [--log-dir LOG_DIR] [--logrotate-dir LOGROTATE_DIR]
|
||||
| [--unit-dir UNIT_DIR] [--verbose] [--timeout TIMEOUT]
|
||||
| [--retry RETRY]
|
||||
| {version,pull,inspect-image,ls,list-networks,adopt,rm-daemon,rm-cluster,run,shell,enter,ceph-volume,unit,logs,bootstrap,deploy,check-host,prepare-host,add-repo,rm-repo,install}
|
||||
| ...
|
||||
|
||||
|
||||
| **cephadm** **pull**
|
||||
|
||||
| **cephadm** **inspect-image**
|
||||
|
||||
| **cephadm** **ls**
|
||||
|
||||
| **cephadm** **list-networks**
|
||||
|
||||
| **cephadm** **adopt** [-h] --name NAME --style STYLE [--cluster CLUSTER]
|
||||
| [--legacy-dir LEGACY_DIR] [--config-json CONFIG_JSON]
|
||||
| [--skip-firewalld] [--skip-pull]
|
||||
|
||||
| **cephadm** **rm-daemon** [-h] --name NAME --fsid FSID [--force]
|
||||
| [--force-delete-data]
|
||||
|
||||
| **cephadm** **rm-cluster** [-h] --fsid FSID [--force]
|
||||
|
||||
| **cephadm** **run** [-h] --name NAME --fsid FSID
|
||||
|
||||
| **cephadm** **shell** [-h] [--fsid FSID] [--name NAME] [--config CONFIG]
|
||||
[--keyring KEYRING] [--env ENV]
|
||||
[--] [command [command ...]]
|
||||
|
||||
| **cephadm** **enter** [-h] [--fsid FSID] --name NAME [command [command ...]]
|
||||
|
||||
| **cephadm** **ceph-volume** [-h] [--fsid FSID] [--config-json CONFIG_JSON]
|
||||
[--config CONFIG] [--keyring KEYRING]
|
||||
command [command ...]
|
||||
|
||||
| **cephadm** **logs** [-h] [--fsid FSID] --name NAME [command [command ...]]
|
||||
|
||||
| **cephadm** **bootstrap** [-h] [--config CONFIG] [--mon-id MON_ID]
|
||||
| [--mon-addrv MON_ADDRV] [--mon-ip MON_IP]
|
||||
| [--mgr-id MGR_ID] [--fsid FSID]
|
||||
| [--output-dir OUTPUT_DIR]
|
||||
| [--output-keyring OUTPUT_KEYRING]
|
||||
| [--output-config OUTPUT_CONFIG]
|
||||
| [--output-pub-ssh-key OUTPUT_PUB_SSH_KEY]
|
||||
| [--skip-ssh]
|
||||
| [--initial-dashboard-user INITIAL_DASHBOARD_USER]
|
||||
| [--initial-dashboard-password INITIAL_DASHBOARD_PASSWORD]
|
||||
| [--dashboard-key DASHBOARD_KEY]
|
||||
| [--dashboard-crt DASHBOARD_CRT] [--skip-mon-network]
|
||||
| [--skip-dashboard] [--dashboard-password-noupdate]
|
||||
| [--no-minimize-config] [--skip-ping-check]
|
||||
| [--skip-pull] [--skip-firewalld] [--allow-overwrite]
|
||||
| [--allow-fqdn-hostname] [--skip-prepare-host]
|
||||
| [--orphan-initial-daemons] [--skip-monitoring-stack]
|
||||
|
||||
|
||||
| **cephadm** **deploy** [-h] --name NAME --fsid FSID [--config CONFIG]
|
||||
| [--config-json CONFIG_JSON] [--keyring KEYRING]
|
||||
| [--key KEY] [--osd-fsid OSD_FSID] [--skip-firewalld]
|
||||
| [--reconfig] [--allow-ptrace]
|
||||
|
||||
| **cephadm** **check-host** [-h] [--expect-hostname EXPECT_HOSTNAME]
|
||||
|
||||
| **cephadm** **prepare-host**
|
||||
|
||||
| **cephadm** **add-repo** [-h] [--release RELEASE] [--version VERSION]
|
||||
| [--dev DEV] [--dev-commit DEV_COMMIT]
|
||||
| [--gpg-url GPG_URL] [--repo-url REPO_URL]
|
||||
|
||||
|
||||
| **cephadm** **rm-repo**
|
||||
|
||||
| **cephadm** **install** [-h] [packages [packages ...]]
|
||||
|
||||
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
:program:`cephadm` is a command line tool to manage the local host for the cephadm orchestrator.
|
||||
|
||||
It provides commands to investigate and modify the state of the current host.
|
||||
|
||||
:program:`cephadm` is not required on all hosts, but useful when investigating a particular
|
||||
daemon.
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
.. option:: --image IMAGE
|
||||
|
||||
container image. Can also be set via the
|
||||
"CEPHADM_IMAGE" env var (default: None)
|
||||
|
||||
.. option:: --docker
|
||||
|
||||
use docker instead of podman (default: False)
|
||||
.. option::data-dir DATA_DIR
|
||||
|
||||
base directory for daemon data (default:/var/lib/ceph)
|
||||
|
||||
.. option:: --log-dir LOG_DIR
|
||||
|
||||
base directory for daemon logs (default:.. option:: /var/log/ceph)
|
||||
|
||||
.. option:: --logrotate-dir LOGROTATE_DIR
|
||||
|
||||
location of logrotate configuration files (default: /etc/logrotate.d)
|
||||
|
||||
.. option:: --unit-dir UNIT_DIR
|
||||
|
||||
base directory for systemd units (default: /etc/systemd/system)
|
||||
|
||||
.. option:: --verbose, -v
|
||||
|
||||
Show debug-level log messages (default: False)
|
||||
|
||||
.. option:: --timeout TIMEOUT
|
||||
|
||||
timeout in seconds (default: None)
|
||||
|
||||
.. option:: --retry RETRY
|
||||
|
||||
max number of retries (default: 10)
|
||||
|
||||
|
||||
Commands
|
||||
========
|
||||
|
||||
add-repo
|
||||
--------
|
||||
|
||||
configure local package repository to also include the ceph repository.
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--release RELEASE] use latest version of a named release (e.g., octopus)
|
||||
* [--version VERSION] use specific upstream version (x.y.z)
|
||||
* [--dev DEV] use specified bleeding edge build from git branch or tag
|
||||
* [--dev-commit DEV_COMMIT] use specified bleeding edge build from git commit
|
||||
* [--gpg-url GPG_URL] specify alternative GPG key location
|
||||
* [--repo-url REPO_URL] specify alternative repo location
|
||||
|
||||
|
||||
adopt
|
||||
-----
|
||||
|
||||
Adopt a daemon deployed with a different deployment tool.
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--name NAME, -n NAME] daemon name (type.id)
|
||||
* [--style STYLE] deployment style (legacy, ...)
|
||||
* [--cluster CLUSTER] cluster name
|
||||
* [--legacy-dir LEGACY_DIR] base directory for legacy daemon data
|
||||
* [--config-json CONFIG_JSON] Additional configuration information in JSON format
|
||||
* [--skip-firewalld] Do not configure firewalld
|
||||
* [--skip-pull] do not pull the latest image before adopting
|
||||
|
||||
|
||||
bootstrap
|
||||
---------
|
||||
|
||||
Bootstrap a cluster on the local host. It deploys a MON and a MGR and then also automatically
|
||||
deploys the monitoring stack on this host (see --skip-monitoring-stack) and calls
|
||||
``ceph orch host add $(hostname)`` (see --skip-ssh).
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--config CONFIG, -c CONFIG] ceph conf file to incorporate
|
||||
* [--mon-id MON_ID] mon id (default: local hostname)
|
||||
* [--mon-addrv MON_ADDRV] mon IPs (e.g., [v2:localipaddr:3300,v1:localipaddr:6789])
|
||||
* [--mon-ip MON_IP] mon IP
|
||||
* [--mgr-id MGR_ID] mgr id (default: randomly generated)
|
||||
* [--fsid FSID] cluster FSID
|
||||
* [--output-dir OUTPUT_DIR] directory to write config, keyring, and pub key files
|
||||
* [--output-keyring OUTPUT_KEYRING] location to write keyring file with new cluster admin and mon keys
|
||||
* [--output-config OUTPUT_CONFIG] location to write conf file to connect to new cluster
|
||||
* [--output-pub-ssh-key OUTPUT_PUB_SSH_KEY] location to write the cluster's public SSH key
|
||||
* [--skip-ssh skip setup of ssh key on local host
|
||||
* [--initial-dashboard-user INITIAL_DASHBOARD_USER] Initial user for the dashboard
|
||||
* [--initial-dashboard-password INITIAL_DASHBOARD_PASSWORD] Initial password for the initial dashboard user
|
||||
* [--dashboard-key DASHBOARD_KEY] Dashboard key
|
||||
* [--dashboard-crt DASHBOARD_CRT] Dashboard certificate
|
||||
* [--skip-mon-network] set mon public_network based on bootstrap mon ip
|
||||
* [--skip-dashboard] do not enable the Ceph Dashboard
|
||||
* [--dashboard-password-noupdate] stop forced dashboard password change
|
||||
* [--no-minimize-config] do not assimilate and minimize the config file
|
||||
* [--skip-ping-check] do not verify that mon IP is pingable
|
||||
* [--skip-pull] do not pull the latest image before bootstrapping
|
||||
* [--skip-firewalld] Do not configure firewalld
|
||||
* [--allow-overwrite] allow overwrite of existing --output-* config/keyring/ssh files
|
||||
* [--allow-fqdn-hostname] allow hostname that is fully-qualified (contains ".")
|
||||
* [--skip-prepare-host] Do not prepare host
|
||||
* [--orphan-initial-daemons] Do not create initial mon, mgr, and crash service specs
|
||||
* [--skip-monitoring-stack] Do not automatically provision monitoring stack] (prometheus, grafana, alertmanager, node-exporter)
|
||||
|
||||
|
||||
ceph-volume
|
||||
-----------
|
||||
|
||||
Run ceph-volume inside a container::
|
||||
|
||||
cephadm ceph-volume inventory
|
||||
|
||||
Positional arguments:
|
||||
* [command] command
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--fsid FSID] cluster FSID
|
||||
* [--config-json CONFIG_JSON] JSON file with config and (client.bootrap-osd) key
|
||||
* [--config CONFIG, -c CONFIG] ceph conf file
|
||||
* [--keyring KEYRING, -k KEYRING] ceph.keyring to pass through to the container
|
||||
|
||||
|
||||
check-host
|
||||
----------
|
||||
|
||||
check host configuration to be suitable for a Ceph cluster.
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--expect-hostname EXPECT_HOSTNAME] Check that hostname matches an expected value
|
||||
|
||||
|
||||
deploy
|
||||
------
|
||||
|
||||
deploy a daemon on the local host. Used by the orchestrator CLI::
|
||||
|
||||
cephadm shell -- ceph orch apply <type> ...
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--name NAME] daemon name (type.id)
|
||||
* [--fsid FSID] cluster FSID
|
||||
* [--config CONFIG, -c CONFIG] config file for new daemon
|
||||
* [--config-json CONFIG_JSON] Additional configuration information in JSON format
|
||||
* [--keyring KEYRING] keyring for new daemon
|
||||
* [--key KEY] key for new daemon
|
||||
* [--osd-fsid OSD_FSID] OSD uuid, if creating an OSD container
|
||||
* [--skip-firewalld] Do not configure firewalld
|
||||
* [--reconfig] Reconfigure a previously deployed daemon
|
||||
* [--allow-ptrace] Allow SYS_PTRACE on daemon container
|
||||
|
||||
|
||||
enter
|
||||
-----
|
||||
|
||||
Run an interactive shell inside a running daemon container::
|
||||
|
||||
cephadm enter --name mgr.myhost.ysubfo
|
||||
|
||||
Positional arguments:
|
||||
* [command] command
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--fsid FSID] cluster FSID
|
||||
* [--name NAME, -n NAME] daemon name (type.id)
|
||||
|
||||
install
|
||||
-------
|
||||
|
||||
install ceph package(s)
|
||||
|
||||
Positional arguments:
|
||||
|
||||
* [packages] packages
|
||||
|
||||
|
||||
inspect-image
|
||||
-------------
|
||||
|
||||
inspect local ceph container image.
|
||||
|
||||
list-networks
|
||||
-------------
|
||||
|
||||
list IP networks
|
||||
|
||||
|
||||
ls
|
||||
--
|
||||
|
||||
list daemon instances known to cephadm on **this** host::
|
||||
|
||||
$ cephadm ls
|
||||
[
|
||||
{
|
||||
"style": "cephadm:v1",
|
||||
"name": "mgr.storage-14b-1.ysubfo",
|
||||
"fsid": "5110cb22-8332-11ea-9148-0894ef7e8bdc",
|
||||
"enabled": true,
|
||||
"state": "running",
|
||||
"container_id": "8562de72370a3836473ecfff8a22c9ccdd99815386b4692a2b30924fb5493c44",
|
||||
"container_image_name": "docker.io/ceph/ceph:v15",
|
||||
"container_image_id": "bc83a388465f0568dab4501fb7684398dca8b50ca12a342a57f21815721723c2",
|
||||
"version": "15.2.1",
|
||||
"started": "2020-04-21T01:16:41.831456",
|
||||
"created": "2020-04-21T01:16:41.775024",
|
||||
"deployed": "2020-04-21T01:16:41.415021",
|
||||
"configured": "2020-04-21T01:16:41.775024"
|
||||
},
|
||||
...
|
||||
|
||||
logs
|
||||
----
|
||||
|
||||
print journald logs for a daemon container::
|
||||
|
||||
cephadm logs --name mgr.myhost.ysubfo
|
||||
|
||||
This is similar to::
|
||||
|
||||
journalctl -u mgr.myhost.ysubfo
|
||||
|
||||
|
||||
prepare-host
|
||||
------------
|
||||
|
||||
prepare a host for cephadm use
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--expect-hostname EXPECT_HOSTNAME] Set hostname
|
||||
|
||||
|
||||
pull
|
||||
----
|
||||
|
||||
Pull the ceph image::
|
||||
|
||||
cephadm pull
|
||||
|
||||
|
||||
rm-daemon
|
||||
---------
|
||||
|
||||
Remove a specific daemon instance
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--name NAME, -n NAME] daemon name (type.id)
|
||||
* [--fsid FSID] cluster FSID
|
||||
* [--force] proceed, even though this may destroy valuable data
|
||||
* [--force-delete-data] delete valuable daemon data instead of making a backup
|
||||
|
||||
|
||||
rm-cluster
|
||||
----------
|
||||
|
||||
remove all daemons for a cluster
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--fsid FSID] cluster FSID
|
||||
* [--force] proceed, even though this may destroy valuable data
|
||||
|
||||
rm-repo
|
||||
-------
|
||||
|
||||
remove package repository configuration
|
||||
|
||||
run
|
||||
---
|
||||
|
||||
run a ceph daemon, in a container, in the foreground
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--name NAME, -n NAME] daemon name (type.id)
|
||||
* [--fsid FSID] cluster FSID
|
||||
|
||||
|
||||
shell
|
||||
-----
|
||||
|
||||
Run an interactive shell::
|
||||
|
||||
cephadm shell
|
||||
|
||||
Or one specific command inside a container::
|
||||
|
||||
cephadm shell -- ceph orch ls
|
||||
|
||||
|
||||
Positional arguments:
|
||||
|
||||
* [command] command (optional)
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--fsid FSID] cluster FSID
|
||||
* [--name NAME, -n NAME] daemon name (type.id)
|
||||
* [--config CONFIG, -c CONFIG] ceph.conf to pass through to the container
|
||||
* [--keyring KEYRING, -k KEYRING] ceph.keyring to pass through to the container
|
||||
* [--env ENV, -e ENV] set environment variable
|
||||
|
||||
|
||||
unit
|
||||
----
|
||||
|
||||
Operate on the daemon's systemd unit.
|
||||
|
||||
Positional arguments:
|
||||
|
||||
* [command] systemd command (start, stop, restart, enable, disable, ...)
|
||||
|
||||
Arguments:
|
||||
|
||||
* [--fsid FSID] cluster FSID
|
||||
* [--name NAME, -n NAME] daemon name (type.id)
|
||||
|
||||
|
||||
Availability
|
||||
============
|
||||
|
||||
:program:`cephadm` is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
|
||||
the documentation at http://docs.ceph.com/ for more information.
|
||||
|
||||
|
||||
See also
|
||||
========
|
||||
|
||||
:doc:`ceph-volume <ceph-volume>`\(8),
|
||||
Loading…
Reference in New Issue
Block a user