cephadm(8)

1CEPHADM(8)                           Ceph                           CEPHADM(8)
2
3
4

NAME

6       cephadm - manage the local cephadm host
7

SYNOPSIS

9       cephadm** [-h] [--image IMAGE] [--docker] [--data-dir DATA_DIR]
10         [--log-dir LOG_DIR] [--logrotate-dir LOGROTATE_DIR]
11         [--unit-dir UNIT_DIR] [--verbose] [--timeout TIMEOUT]
12         [--retry RETRY]
13         {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}
14         ...
15
16       cephadm pull
17
18       cephadm inspect-image
19
20       cephadm ls
21
22       cephadm list-networks
23
24       cephadm adopt [-h] --name NAME --style STYLE [--cluster CLUSTER]
25         [--legacy-dir LEGACY_DIR] [--config-json CONFIG_JSON]
26         [--skip-firewalld] [--skip-pull]
27
28       cephadm rm-daemon [-h] --name NAME --fsid FSID [--force]
29         [--force-delete-data]
30
31       cephadm rm-cluster [-h] --fsid FSID [--force]
32
33       cephadm run [-h] --name NAME --fsid FSID
34
35       cephadm shell [-h] [--fsid FSID] [--name NAME] [--config CONFIG]
36       [--keyring KEYRING] [--mount MOUNT] [--env ENV]
37       [--] [command [command ...]]
38
39       cephadm enter [-h] [--fsid FSID] --name NAME [command [command ...]]
40
41       cephadm ceph-volume [-h] [--fsid FSID] [--config-json CONFIG_JSON]
42       [--config CONFIG] [--keyring KEYRING]
43       command [command ...]
44
45       cephadm unit  [-h] [--fsid FSID] --name NAME command
46
47       cephadm logs [-h] [--fsid FSID] --name NAME [command [command ...]]
48
49       cephadm bootstrap [-h] [--config CONFIG] [--mon-id MON_ID]
50         [--mon-addrv MON_ADDRV] [--mon-ip MON_IP]
51         [--mgr-id MGR_ID] [--fsid FSID]
52         [--output-dir OUTPUT_DIR]
53         [--output-keyring OUTPUT_KEYRING]
54         [--output-config OUTPUT_CONFIG]
55         [--output-pub-ssh-key OUTPUT_PUB_SSH_KEY]
56         [--skip-ssh]
57         [--initial-dashboard-user INITIAL_DASHBOARD_USER]
58         [--initial-dashboard-password INITIAL_DASHBOARD_PASSWORD]
59         [--ssl-dashboard-port SSL_DASHBOARD_PORT]
60         [--dashboard-key DASHBOARD_KEY]
61         [--dashboard-crt DASHBOARD_CRT]
62         [--ssh-config SSH_CONFIG]
63         [--ssh-private-key SSH_PRIVATE_KEY]
64         [--ssh-public-key SSH_PUBLIC_KEY]
65         [--ssh-user SSH_USER] [--skip-mon-network]
66         [--skip-dashboard] [--dashboard-password-noupdate]
67         [--no-minimize-config] [--skip-ping-check]
68         [--skip-pull] [--skip-firewalld] [--allow-overwrite]
69         [--allow-fqdn-hostname] [--skip-prepare-host]
70         [--orphan-initial-daemons] [--skip-monitoring-stack]
71         [--apply-spec APPLY_SPEC]
72         [--registry-url REGISTRY_URL]
73         [--registry-username REGISTRY_USERNAME]
74         [--registry-password REGISTRY_PASSWORD]
75         [--registry-json REGISTRY_JSON]
76
77       cephadm deploy [-h] --name NAME --fsid FSID [--config CONFIG]
78         [--config-json CONFIG_JSON] [--keyring KEYRING]
79         [--key KEY] [--osd-fsid OSD_FSID] [--skip-firewalld]
80         [--tcp-ports TCP_PORTS] [--reconfig] [--allow-ptrace]
81
82       cephadm check-host [-h] [--expect-hostname EXPECT_HOSTNAME]
83
84       cephadm prepare-host
85
86       cephadm add-repo [-h] [--release RELEASE] [--version VERSION]
87         [--dev DEV] [--dev-commit DEV_COMMIT]
88         [--gpg-url GPG_URL] [--repo-url REPO_URL]
89
90       cephadm rm-repo
91
92       cephadm install [-h] [packages [packages ...]]
93
94       cephadm registry-login [-h] [--registry-url REGISTRY_URL]
95         [--registry-username REGISTRY_USERNAME]
96         [--registry-password REGISTRY_PASSWORD]
97         [--registry-json REGISTRY_JSON] [--fsid FSID]
98
99

DESCRIPTION

101       cephadm is a command line tool to manage the local host for the cephadm
102       orchestrator.
103
104       It provides commands to investigate and modify the state of the current
105       host.
106
107       cephadm  is  not required on all hosts, but useful when investigating a
108       particular daemon.
109

OPTIONS

111       --image IMAGE
112              container image. Can also be set via the "CEPHADM_IMAGE" env var
113              (default: None)
114
115       --docker
116              use docker instead of podman (default: False)
117
118       --log-dir LOG_DIR
119              base    directory   for   daemon   logs   (default:..   option::
120              /var/log/ceph)
121
122       --logrotate-dir LOGROTATE_DIR
123              location of logrotate configuration files (default:  /etc/logro‐
124              tate.d)
125
126       --unit-dir UNIT_DIR
127              base directory for systemd units (default: /etc/systemd/system)
128
129       --verbose, -v
130              Show debug-level log messages (default: False)
131
132       --timeout TIMEOUT
133              timeout in seconds (default: None)
134
135       --retry RETRY
136              max number of retries (default: 10)
137

COMMANDS

139   add-repo
140       configure local package repository to also include the ceph repository.
141
142       Arguments:
143
144       · [--release  RELEASE]        use  latest  version  of  a named release
145         (e.g., octopus)
146
147       · [--version VERSION]       use specific upstream version (x.y.z)
148
149       · [--dev DEV]               use specified bleeding edge build from  git
150         branch or tag
151
152       · [--dev-commit  DEV_COMMIT] use specified bleeding edge build from git
153         commit
154
155       · [--gpg-url GPG_URL]       specify alternative GPG key location
156
157       · [--repo-url REPO_URL]     specify alternative repo location
158
159   adopt
160       Adopt a daemon deployed with a different deployment tool.
161
162       Arguments:
163
164       · [--name NAME, -n NAME]       daemon name (type.id)
165
166       · [--style STYLE]              deployment style (legacy, ...)
167
168       · [--cluster CLUSTER]          cluster name
169
170       · [--legacy-dir LEGACY_DIR]    base directory for legacy daemon data
171
172       · [--config-json CONFIG_JSON]  Additional configuration information  in
173         JSON format
174
175       · [--skip-firewalld]           Do not configure firewalld
176
177       · [--skip-pull]                 do  not  pull  the  latest image before
178         adopting
179
180   bootstrap
181       Bootstrap a cluster on the local host. It deploys a MON and a  MGR  and
182       then  also automatically deploys the monitoring stack on this host (see
183       --skip-monitoring-stack) and calls ceph orch host add $(hostname)  (see
184       --skip-ssh).
185
186       Arguments:
187
188       · [--config CONFIG, -c CONFIG]    ceph conf file to incorporate
189
190       · [--mon-id MON_ID]               mon id (default: local hostname)
191
192       · [--mon-addrv    MON_ADDRV]           mon   IPs   (e.g.,   [v2:locali‐
193         paddr:3300,v1:localipaddr:6789])
194
195       · [--mon-ip MON_IP]               mon IP
196
197       · [--mgr-id MGR_ID]               mgr id (default: randomly generated)
198
199       · [--fsid FSID]                   cluster FSID
200
201       · [--output-dir OUTPUT_DIR]       directory to write  config,  keyring,
202         and pub key files
203
204       · [--output-keyring OUTPUT_KEYRING] location to write keyring file with
205         new cluster admin and mon keys
206
207       · [--output-config OUTPUT_CONFIG] location to write conf file  to  con‐
208         nect to new cluster
209
210       · [--output-pub-ssh-key OUTPUT_PUB_SSH_KEY] location to write the clus‐
211         ter's public SSH key
212
213       · [--skip-ssh                     skip setup of ssh key on local host
214
215       · [--initial-dashboard-user INITIAL_DASHBOARD_USER]  Initial  user  for
216         the dashboard
217
218       · [--initial-dashboard-password   INITIAL_DASHBOARD_PASSWORD]   Initial
219         password for the initial dashboard user
220
221       · [--ssl-dashboard-port SSL_DASHBOARD_PORT] Port number used to connect
222         with dashboard using SSL
223
224       · [--dashboard-key DASHBOARD_KEY] Dashboard key
225
226       · [--dashboard-crt DASHBOARD_CRT] Dashboard certificate
227
228       · [--ssh-config SSH_CONFIG] SSH config
229
230       · [--ssh-private-key SSH_PRIVATE_KEY] SSH private key
231
232       · [--ssh-public-key SSH_PUBLIC_KEY] SSH public key
233
234       · [--ssh-user SSH_USER]           set user for SSHing to cluster hosts,
235         passwordless sudo will be needed for non-root users'
236
237       · [--skip-mon-network]            set mon public_network based on boot‐
238         strap mon ip
239
240       · [--skip-dashboard]              do not enable the Ceph Dashboard
241
242       · [--dashboard-password-noupdate] stop forced dashboard password change
243
244       · [--no-minimize-config]           do  not  assimilate and minimize the
245         config file
246
247       · [--skip-ping-check]             do not verify that mon IP is pingable
248
249       · [--skip-pull]                   do not pull the latest  image  before
250         bootstrapping
251
252       · [--skip-firewalld]              Do not configure firewalld
253
254       · [--allow-overwrite]              allow  overwrite  of existing --out‐
255         put-* config/keyring/ssh files
256
257       · [--allow-fqdn-hostname]         allow hostname that  is  fully-quali‐
258         fied (contains ".")
259
260       · [--skip-prepare-host]           Do not prepare host
261
262       · [--orphan-initial-daemons]       Do  not create initial mon, mgr, and
263         crash service specs
264
265       · [--skip-monitoring-stack]       Do not automatically provision  moni‐
266         toring stack] (prometheus, grafana, alertmanager, node-exporter)
267
268       · [--apply-spec  APPLY_SPEC]        Apply  cluster spec after bootstrap
269         (copy ssh key, add hosts and apply services)
270
271       · [--registry-url REGISTRY_URL]   url of custom registry to  login  to.
272         e.g. docker.io, quay.io
273
274       · [--registry-username  REGISTRY_USERNAME] username of account to login
275         to on custom registry
276
277       · [--registry-password REGISTRY_PASSWORD] password of account to  login
278         to on custom registry
279
280       · [--registry-json  REGISTRY_JSON]  JSON file containing registry login
281         info (see registry-login command documentation)
282
283   ceph-volume
284       Run ceph-volume inside a container:
285
286          cephadm ceph-volume inventory
287
288       Positional arguments: * [command]               command
289
290       Arguments:
291
292       · [--fsid FSID]                    cluster FSID
293
294       · [--config-json  CONFIG_JSON]        JSON   file   with   config   and
295         (client.bootrap-osd) key
296
297       · [--config CONFIG, -c CONFIG]     ceph conf file
298
299       · [--keyring  KEYRING, -k KEYRING]  ceph.keyring to pass through to the
300         container
301
302   check-host
303       check host configuration to be suitable for a Ceph cluster.
304
305       Arguments:
306
307       · [--expect-hostname EXPECT_HOSTNAME] Check that  hostname  matches  an
308         expected value
309
310   deploy
311       deploy a daemon on the local host. Used by the orchestrator CLI:
312
313          cephadm shell -- ceph orch apply <type> ...
314
315       Arguments:
316
317       · [--name NAME]               daemon name (type.id)
318
319       · [--fsid FSID]               cluster FSID
320
321       · [--config CONFIG, -c CONFIG] config file for new daemon
322
323       · [--config-json  CONFIG_JSON]  Additional configuration information in
324         JSON format
325
326       · [--keyring KEYRING]         keyring for new daemon
327
328       · [--key KEY]                 key for new daemon
329
330       · [--osd-fsid OSD_FSID]       OSD uuid, if creating an OSD container
331
332       · [--skip-firewalld]          Do not configure firewalld
333
334       · [--tcp-ports                List of tcp ports to  open  in  the  host
335         firewall
336
337       · [--reconfig]                Reconfigure a previously deployed daemon
338
339       · [--allow-ptrace]            Allow SYS_PTRACE on daemon container
340
341   enter
342       Run an interactive shell inside a running daemon container:
343
344          cephadm enter --name mgr.myhost.ysubfo
345
346       Positional arguments: * [command]               command
347
348       Arguments:
349
350       · [--fsid FSID]           cluster FSID
351
352       · [--name NAME, -n NAME]  daemon name (type.id)
353
354   install
355       install ceph package(s)
356
357       Positional arguments:
358
359       · [packages]    packages
360
361   inspect-image
362       inspect local ceph container image.
363
364   list-networks
365       list IP networks
366
367   ls
368       list daemon instances known to cephadm on this host:
369
370          $ cephadm ls
371          [
372              {
373                  "style": "cephadm:v1",
374                  "name": "mgr.storage-14b-1.ysubfo",
375                  "fsid": "5110cb22-8332-11ea-9148-0894ef7e8bdc",
376                  "enabled": true,
377                  "state": "running",
378                  "container_id": "8562de72370a3836473ecfff8a22c9ccdd99815386b4692a2b30924fb5493c44",
379                  "container_image_name": "docker.io/ceph/ceph:v15",
380                  "container_image_id": "bc83a388465f0568dab4501fb7684398dca8b50ca12a342a57f21815721723c2",
381                  "version": "15.2.1",
382                  "started": "2020-04-21T01:16:41.831456",
383                  "created": "2020-04-21T01:16:41.775024",
384                  "deployed": "2020-04-21T01:16:41.415021",
385                  "configured": "2020-04-21T01:16:41.775024"
386              },
387          ...
388
389   logs
390       print journald logs for a daemon container:
391
392          cephadm logs --name mgr.myhost.ysubfo
393
394       This is similar to:
395
396          journalctl -u mgr.myhost.ysubfo
397
398   prepare-host
399       prepare a host for cephadm use
400
401       Arguments:
402
403       · [--expect-hostname EXPECT_HOSTNAME] Set hostname
404
405   pull
406       Pull the ceph image:
407
408          cephadm pull
409
410   registry-login
411       Give  cephadm  login  information  for  an authenticated registry (url,
412       username and password).  Cephadm will attempt to log the  calling  host
413       into that registry:
414
415          cephadm registry-login --registry-url [REGISTRY_URL] --registry-username [USERNAME]
416                                 --registry-password [PASSWORD]
417
418       Can also use a JSON file containing the login info formatted as:
419
420          {
421           "url":"REGISTRY_URL",
422           "username":"REGISTRY_USERNAME",
423           "password":"REGISTRY_PASSWORD"
424          }
425
426       and turn it in with command:
427
428          cephadm registry-login --registry-json [JSON FILE]
429
430       Arguments:
431
432       · [--registry-url  REGISTRY_URL]    url  of  registry to login to. e.g.
433         docker.io, quay.io
434
435       · [--registry-username REGISTRY_USERNAME] username of account to  login
436         to on registry
437
438       · [--registry-password  REGISTRY_PASSWORD] password of account to login
439         to on registry
440
441       · [--registry-json REGISTRY_JSON] JSON file containing login  info  for
442         custom registry
443
444       · [--fsid FSID]                   cluster FSID
445
446   rm-daemon
447       Remove a specific daemon instance
448
449       Arguments:
450
451       · [--name NAME, -n NAME]  daemon name (type.id)
452
453       · [--fsid FSID]           cluster FSID
454
455       · [--force]                proceed,  even though this may destroy valu‐
456         able data
457
458       · [--force-delete-data]   delete valuable daemon data instead of making
459         a backup
460
461   rm-cluster
462       remove all daemons for a cluster
463
464       Arguments:
465
466       · [--fsid FSID]  cluster FSID
467
468       · [--force]      proceed, even though this may destroy valuable data
469
470   rm-repo
471       remove package repository configuration
472
473   run
474       run a ceph daemon, in a container, in the foreground
475
476       Arguments:
477
478       · [--name NAME, -n NAME]  daemon name (type.id)
479
480       · [--fsid FSID]           cluster FSID
481
482   shell
483       Run an interactive shell:
484
485          cephadm shell
486
487       Or one specific command inside a container:
488
489          cephadm shell -- ceph orch ls
490
491       Positional arguments:
492
493       · [command]               command (optional)
494
495       Arguments:
496
497       · [--fsid FSID]                   cluster FSID
498
499       · [--name NAME, -n NAME]          daemon name (type.id)
500
501       · [--config CONFIG, -c CONFIG]    ceph.conf to pass through to the con‐
502         tainer
503
504       · [--keyring KEYRING, -k KEYRING] ceph.keyring to pass through  to  the
505         container
506
507       · [--mount  MOUNT, -m MOUNT]       mount a file or directory under /mnt
508         in the container
509
510       · [--env ENV, -e ENV]             set environment variable
511
512   unit
513       Operate on the daemon's systemd unit.
514
515       Positional arguments:
516
517       · [command]                systemd  command  (start,   stop,   restart,
518         enable, disable, ...)
519
520       Arguments:
521
522       · [--fsid FSID]           cluster FSID
523
524       · [--name NAME, -n NAME]  daemon name (type.id)
525

AVAILABILITY

527       cephadm is part of Ceph, a massively scalable, open-source, distributed
528       storage   system.   Please    refer    to    the    documentation    at
529       http://docs.ceph.com/ for more information.
530

COPYRIGHT

535       2010-2020,  Inktank Storage, Inc. and contributors. Licensed under Cre‐
536       ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
537
538
539
540
541dev                              Sep 16, 2020                       CEPHADM(8)