Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/dev/cephadm: Define variables #42209

Merged

Conversation

sebastian-philipp
Copy link
Contributor

Fixes: https://tracker.ceph.com/issues/47142
Signed-off-by: Sebastian Wagner sewagner@redhat.com

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

Fixes: https://tracker.ceph.com/issues/47142
Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
Note regarding different variables used in the code
===================================================

* a ``service_type`` is something like mon, mgr, alertmanager etc defined
Copy link
Contributor

@tchaikov tchaikov Jul 8, 2021

Choose a reason for hiding this comment

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

how about using

.. describe:: service_type

   something like mon, mgr, alertmanager etc defined in ``ServiceSpec``

which is rendered like items like "waiting_for_healthy" in https://docs.ceph.com/en/latest/dev/crimson/osd/ .

Copy link
Contributor Author

Choose a reason for hiding this comment

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

tbh, I don't really care. this is just the developer documentation.


* a ``service_type`` is something like mon, mgr, alertmanager etc defined
in ``ServiceSpec``
* a ``service_id`` is the name of the service. Some services don't have
Copy link
Contributor

@adk3798 adk3798 Jul 9, 2021

Choose a reason for hiding this comment

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

possible suggestion, what you have now is correct

Suggested change
* a ``service_id`` is the name of the service. Some services don't have
* a ``service_id`` is the name for an instance of a service. Services only allowed
one instance per cluster don't have a service id (e.g. mgr, mon, prometheus).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants