Skip to content

doc/cephadm: Restructure orchestrator docs#39551

Merged
sebastian-philipp merged 16 commits intoceph:masterfrom
sebastian-philipp:doc-cephadm-reduce-orch-cli
Feb 26, 2021
Merged

doc/cephadm: Restructure orchestrator docs#39551
sebastian-philipp merged 16 commits intoceph:masterfrom
sebastian-philipp:doc-cephadm-reduce-orch-cli

Conversation

@sebastian-philipp
Copy link
Contributor

@sebastian-philipp sebastian-philipp commented Feb 18, 2021 •
edited
Loading

This PR mainly moves chapters around.

  • move all host sections to a single host chapter
  • move all {service-type} chapters to a dedicated {service-type}.rst

TODOs:

  • No idea how to handle the install guide without duplicating things to much.
  • mgr/rook ?
  • iscsi
  • nfs
  • cephfs
  • deal with miscellaneous services (rbd-mirror, crash)

Checklist

  • References tracker ticket
  • Updates documentation if necessary
  • Includes tests for new functionality or reproducer for bug
Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox

@sebastian-philipp sebastian-philipp force-pushed the doc-cephadm-reduce-orch-cli branch 3 times, most recently from 77a88a7 to 40420f4 Compare February 18, 2021 17:15
@sebastian-philipp
Copy link
Contributor Author

sebastian-philipp commented Feb 18, 2021

jenkins render docs

@ceph-jenkins
Copy link
Collaborator

ceph-jenkins commented Feb 18, 2021

Doc render available at https://ceph--39551.org.readthedocs.build/en/39551/

@sebastian-philipp sebastian-philipp mentioned this pull request Feb 19, 2021
Merged
@github-actions
Copy link

github-actions bot commented Feb 19, 2021

This pull request can no longer be automatically merged: a rebase is needed and changes have to be manually resolved

@varshar16
Copy link
Contributor

varshar16 commented Feb 22, 2021

@sebastian-philipp please rebase

jmolmo
jmolmo approved these changes Feb 23, 2021
View reviewed changes
Copy link
Member

@jmolmo jmolmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good Work!!
I think that now is more easy to understand and over all more easy for the final user to get information about specific issues/topic.

Related with the "todo":

No idea how to handle the install guide without duplicating things to much.

What do you8 mean by "install guide"...
i think it is covered in the "DEPLOYING A NEW CEPH CLUSTER" section

mgr/rook ?
I think that it is just another point at the same level as "cephadm" in the docs. I do not mind to repeat the cephadm structure inside the rook point.

iscsi
nfs
cephfs
deal with miscellaneous services (rbd-mirror, crash)
We have the entry point or a very clear idea about where to insert the new doc. item.
And yes!! we need to make a more clear explanation of the use of this services. But it is something that can be done in next prs!.

Happy with this change Sebastian!!

@sebastian-philipp sebastian-philipp force-pushed the doc-cephadm-reduce-orch-cli branch from 40420f4 to bb532f5 Compare February 25, 2021 14:47
@sebastian-philipp
Copy link
Contributor Author

sebastian-philipp commented Feb 25, 2021

@zdover23 could you give this a review? I'd like to unblock other doc changes

@sebastian-philipp
Copy link
Contributor Author

sebastian-philipp commented Feb 25, 2021 

checking consistency... /home/jenkins-build/build/workspace/ceph-pr-docs/doc/cephadm/mds.rst: WARNING: document isn't included in any toctree

/home/jenkins-build/build/workspace/ceph-pr-docs/doc/cephadm/install.rst:241: WARNING: undefined label: cephadm-cephfs (if the link has no caption the label must precede a section header)

@sebastian-philipp sebastian-philipp changed the title [WIP] doc/cephadm: Restructure orchestrator docs doc/cephadm: Restructure orchestrator docs Feb 26, 2021
@sebastian-philipp
doc/cephadm: group host mgmt sections into one chapter
88e8e91 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: Move SSH config from operations to host-mgmt.rst
1dbac10 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: Move FQDN chapter to host mgmt.rst
a3036d9 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: group OSD mgmt sections into one chapter
74bcd7c 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: group general service mgmt sections into one chapter
11fe5ef 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: move unmanaged=true to service-mgmt.rst
31470cf 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: move scheduler topic to service mgmt
4f3305f 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: group RGW mgmt sections into one chapter
818ed4f 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: make custom containers its own chapter
0fb2ccb 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: group MON sections into one chapter
b3846f6 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: rename monitoring chapter title
769642c 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: group NFS sections into one chapter
8d07e35 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: Add iscsi
46a203a 
Fixes https://tracker.ceph.com/issues/49488

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: group MDS sections into one chapter
1033c46 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: move host labels to host mgmt
a4aef4a 
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp
doc/cephadm: remove Orchestrator CLI from cephadm toc
f4f3fee 
not much useful information there anymore.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
@sebastian-philipp sebastian-philipp force-pushed the doc-cephadm-reduce-orch-cli branch from 29e81cd to f4f3fee Compare February 26, 2021 10:51
@zdover23
Copy link
Contributor

zdover23 commented Feb 26, 2021

jenkins render docs

@ceph-jenkins
Copy link
Collaborator

ceph-jenkins commented Feb 26, 2021

Doc render available at https://ceph--39551.org.readthedocs.build/en/39551/

zdover23
zdover23 approved these changes Feb 26, 2021
View reviewed changes
Copy link
Contributor

@zdover23 zdover23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Fire when ready.

@sebastian-philipp sebastian-philipp merged commit bd44dcc into ceph:master Feb 26, 2021
@sebastian-philipp sebastian-philipp mentioned this pull request Mar 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zdover23 zdover23 zdover23 approved these changes

@jmolmo jmolmo jmolmo approved these changes

@liewegas liewegas Awaiting requested review from liewegas

@varshar16 varshar16 Awaiting requested review from varshar16

Assignees

No one assigned

Labels

cephadm documentation mgr needs-review orchestrator

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@sebastian-philipp @ceph-jenkins @varshar16 @zdover23 @jmolmo