Zac Dover
2172b7ec98
doc/mgr: edit orchestrator.rst
...
This PR improves the English language in the "Orchestrator CLI"
section of the MGR documentation. It adds a couple of section
headers in order to signpost the information in the document
a bit more than had already been done, but it makes no major
structural changes to the presentation of the information here.
This PR was motivated by feedback from the 2022 Ceph User Survey
in which one of the respondents wrote "better ceph orch documen-
tation".
The final section on this page, "Current Implementation Status",
must be verified by someone who is familiar with the current state
of "ceph orch" and a date stamp should be applied to the top of
the section so that the word "current" has a meaningful referent.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-08-24 13:21:25 +10:00
Anthony D'Atri
f1235a8ee0
doc/mgr: Fix capitalization in orchestrator.rst
...
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-07-05 19:23:36 -07:00
Redouane Kachach
df1aaacb7d
doc/cephadm: enhancing daemon operations documentation
...
Fixes: https://tracker.ceph.com/issues/54399
Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-06-20 11:44:49 +02:00
Paul Cuzner
91f35e1f53
mgr/cephadm: Updated docs for snmp-gateway support
...
Updated docs to show snmp-gateway usage. docs provide
guidance on SNMP versions supported and show CLI and
yaml deployment examples.
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2021-12-15 14:25:34 +13:00
Daniel Pivonka
41a1df1b96
doc/cephadm: fix rgw realm and zone flags
...
Signed-off-by: Daniel Pivonka <dpivonka@redhat.com>
2021-03-26 16:18:28 -04:00
Sage Weil
50bc491373
doc: update docs
...
Signed-off-by: Sage Weil <sage@newdream.net>
2021-03-09 14:29:39 -05:00
Sebastian Wagner
a4aef4a49d
doc/cephadm: move host labels to host mgmt
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
1033c46ad7
doc/cephadm: group MDS sections into one chapter
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
b3846f6f6a
doc/cephadm: group MON sections into one chapter
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
0fb2ccb49b
doc/cephadm: make custom containers its own chapter
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
818ed4f202
doc/cephadm: group RGW mgmt sections into one chapter
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
11fe5ef7cf
doc/cephadm: group general service mgmt sections into one chapter
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
74bcd7c5f6
doc/cephadm: group OSD mgmt sections into one chapter
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
88e8e91f72
doc/cephadm: group host mgmt sections into one chapter
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-26 11:51:29 +01:00
Sebastian Wagner
316b4ad614
Merge pull request #39472 from sebastian-philipp/doc-cephadm-host-labels
...
doc/orch: Host labels
Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2021-02-19 13:28:51 +01:00
Sebastian Wagner
4cb501416d
doc/orch: Host labels
...
Fixes: https://tracker.ceph.com/issues/45833
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-18 12:49:46 +01:00
Sebastian Wagner
5c872ace45
doc/cephadm: Disable automatic deployment of daemons
...
Fixes: https://tracker.ceph.com/issues/45767
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-16 16:11:06 +01:00
Paul Cuzner
a4f4a67fe7
mgr/orchestrator: doc updated to show optional parameter
...
Updated the orch status document to show the --detail option
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2021-02-03 11:47:49 +13:00
Mitsumasa KONDO
53639c2b01
doc/mgr/orchestrator: Unify the content of command and yaml
...
Signed-off-by: Mitsumasa KONDO <kondo.mitsumasa@gmail.com>
2021-02-01 18:13:12 +08:00
Sebastian Wagner
d055d855ea
Merge pull request #38686 from wornet-mwo/wip-doc-add-section-declarative-orch-cmd
...
doc: added section about retival of Service Specication
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-01-29 12:37:15 +01:00
Michael Wodniok
f857bcd622
doc: Applied text as suggested by @zdover23
...
Signed-off-by: Michael Wodniok <wodniok@wor.net>
2021-01-27 08:19:06 +01:00
Adam King
aeeffb07f1
mgr/cephadm: force flag for ok-to-stop and ok-to-stop for monitoring stack
...
Daemons that could cause data loss when stopped will always block.
Daemons that will only cause loss in availability should block but have
a workaround in the form of a force flag if the user is okay with the service
being down.
Also implements ok-to-stop for monitoring stack daemons that uses this system
of blocking on availability loss unless force flag is provided
Signed-off-by: Adam King <adking@redhat.com>
Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
2021-01-20 08:21:55 -05:00
Michael Wodniok
d97731969a
doc: changed commands as suggested by @sebastian-philipp
...
Signed-off-by: Michael Wodniok <wodniok@wor.net>
Co-authored-by: Sebastian Wagner <sebastian@spawnhost.de>
2021-01-19 13:15:32 +01:00
Michael Wodniok
a955306199
doc: added internal link
...
Linked from Service Status to retrieval of specificaton section as
`ceph orch ls --export` is also mentioned there.
Signed-off-by: Michael Wodniok wodniok@wor.net
2021-01-19 13:12:57 +01:00
Daniel-Pivonka
a398fc239f
cephadm: HA for RGW endpoints
...
Cephadm deploying keepalived and HAproxy for providing High availability for RGW endpoints
Fixes: https://tracker.ceph.com/issues/45116
Signed-off-by: Daniel-Pivonka <dpivonka@redhat.com>
Signed-off-by: Adam King <adking@redhat.com>
Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-01-08 17:00:51 -05:00
Michael Wodniok
84bdafe0e3
doc: added section about retival of Service Spec.
...
Signed-off-by: Michael Wodniok <wodniok@wor.net>
2020-12-22 10:48:32 +01:00
Sebastian Wagner
453000af19
doc/cephadm: Add remove host to operations
...
Co-authored-by: Alexandra Settle <asettle@suse.com>
Co-authored-by: Kefu Chai <tchaikov@gmail.com>
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-12-09 12:34:16 +01:00
Anthony D'Atri
9c67b80495
doc/mgr: Fix msgr2 TCP port in a couple of examples
...
Fixes: https://tracker.ceph.com/issues/47976
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-19 22:58:10 -08:00
Volker Theile
1927809b0b
doc/mgr/orchestrator: Add hints related to custom containers to the docs
...
Fixes: https://tracker.ceph.com/issues/48113
Signed-off-by: Volker Theile <vtheile@suse.com>
2020-11-04 14:39:44 +01:00
Varsha Rao
a251cea714
doc/mgr/orchestrator: Update about nfs add in rook
...
"nfs add" is no longer supported in rook. Instead "apply nfs" should be used to
deploy nfs-ganesha daemons.
Signed-off-by: Varsha Rao <varao@redhat.com>
2020-11-03 12:13:10 +05:30
Varsha Rao
23b9fb6456
doc/mgr/orchestrator: Update about "{mds, rgw} add" status in rook
...
"mds add" and "rgw add" are no longer supported in rook. Their implementation
was removed by commits 56cfeb6
and 0580297
. Instead "apply mds" and "apply rgw"
is preferred.
Signed-off-by: Varsha Rao <varao@redhat.com>
2020-10-28 19:16:35 +05:30
Kiefer Chang
a5aaaa69cc
doc/dashboard: add information for Orchestrator NFS-Ganesha clusters
...
Fixes: https://tracker.ceph.com/issues/46492
Signed-off-by: Kiefer Chang <kiefer.chang@suse.com>
2020-10-19 19:11:17 +08:00
Joshua Schmid
b38bc14525
docs: <orch osd spec> is no longer present
...
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-10-02 10:22:55 +02:00
Kefu Chai
e492447fde
Merge pull request #37236 from jschmid1/osd_rm_doc_fix
...
docs: remove docs should say osd_id instead of svc_id
Reviewed-by: Michael Fritch <mfritch@suse.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-09-24 15:51:05 +08:00
Ponnuvel Palaniyappan
d99d520493
doc: Fixed a number of typos in documentation
...
Signed-off-by: Ponnuvel Palaniyappan <pponnuvel@gmail.com>
2020-09-18 18:17:15 +01:00
Joshua Schmid
d7d1267686
docs: s/svc_id/osd_id
...
Fixes: https://tracker.ceph.com/issues/47402
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-09-18 14:33:40 +02:00
Volker Theile
7219377cfc
cephadm: Introduce 'container' specification to deploy custom containers
...
Fixes: https://tracker.ceph.com/issues/46666
Signed-off-by: Volker Theile <vtheile@suse.com>
2020-09-17 10:04:11 +02:00
Sebastian Wagner
f3bd8f2569
doc/mgr: fix outdated orch apply
docs.
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-08-31 10:14:20 +02:00
Dan Mick
a2a9054202
doc/mgr: Clean up orchestrator.rst (spell/punct, awkward wording)
...
Signed-off-by: Dan Mick <dmick@redhat.com>
2020-08-26 20:07:10 +00:00
Joshua Schmid
f8b8e6f229
docs/mgr: remove traces of ceph orch osd spec
...
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-08-11 16:47:36 +02:00
Sebastian Wagner
5a15c730c2
Merge pull request #36151 from jschmid1/osd_support_reweight_impl
...
mgr/cephadm: rework osd removals/replacements
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-07-31 13:28:18 +02:00
Joshua Schmid
9606f4d602
doc/cephadm: adjust osd removal docs
...
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-07-31 10:23:59 +02:00
Varsha Rao
195f28a614
doc/mgr/orchestrator: Fix formatting and examples in create OSDs
...
Signed-off-by: Varsha Rao <varao@redhat.com>
2020-07-30 15:28:47 +02:00
Sebastian Wagner
1125a805bd
doc/cephadm: status
doesn't show a progress
...
Fixes: https://tracker.ceph.com/issues/45858
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-07-27 16:50:05 +02:00
Michael Fritch
7906460483
doc/mgr/orchestrator: add missing OSD service_id
...
example for deploying multiple specs via yaml was missing the service_id
Fixes: https://tracker.ceph.com/issues/46377
Signed-off-by: Michael Fritch <mfritch@suse.com>
2020-07-22 16:41:58 -06:00
Joshua Schmid
a8e21a114b
doc: add notes about --dry-run
...
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2020-07-22 16:01:56 +02:00
Juan Miguel Olmo Martínez
da62f752c5
doc/mgr/orchestrator: Add information about unmanaged parameter
...
Explain parameter 'unmanaged' in OSDs creation and deletion
Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2020-06-30 13:58:15 +02:00
Sebastian Wagner
b0bbef91f0
doc/mgr/orch: Update documentation to the new CLI
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-06-18 11:17:46 +02:00
Sebastian Wagner
55e608d796
doc/cephadm: Add chapter about FQDNs
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-06-15 15:26:11 +02:00
Sebastian Wagner
3204457917
doc/orch: How to update an existing specification
...
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-06-09 10:57:30 +02:00