Skip to content

doc/cephadm/services: the config section of service specs#46926

Merged
adk3798 merged 1 commit intoceph:mainfrom
rkachach:fix_issue_53997
Jul 5, 2022
Merged

doc/cephadm/services: the config section of service specs#46926
adk3798 merged 1 commit intoceph:mainfrom
rkachach:fix_issue_53997

Conversation

@rkachach
Copy link
Copy Markdown
Contributor

@rkachach rkachach commented Jul 1, 2022

Fixes: https://tracker.ceph.com/issues/53997

Signed-off-by: Redouane Kachach rkachach@redhat.com

Contribution Guidelines

Checklist

  • Tracker (select at least one)
    • References tracker ticket
    • Very recent bug; references commit where it was introduced
    • New feature (ticket optional)
    • Doc update (no ticket needed)
    • Code cleanup (no ticket needed)
  • Component impact
    • Affects Dashboard, opened tracker ticket
    • Affects Orchestrator, opened tracker ticket
    • No impact that needs to be tracked
  • Documentation (select at least one)
    • Updates relevant documentation
    • No doc update is appropriate
  • Tests (select at least one)
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 dashboard cephadm
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox
  • jenkins test windows

@rkachach rkachach requested a review from adk3798 July 1, 2022 12:13
@rkachach rkachach requested a review from a team as a code owner July 1, 2022 12:13
adk3798
adk3798 reviewed Jul 1, 2022
View reviewed changes
doc/cephadm/services/index.rst Outdated
A *Service Specification* is a data structure that is used to specify the
deployment of services. Here is an example of a service specification in YAML:
deployment of services. In addition to parameters such as `placement`, etc
the user can set initial values of service configuration parameters.
Copy link
Copy Markdown
Contributor

@adk3798 adk3798 Jul 1, 2022

Choose a reason for hiding this comment

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

I feel like this comes out a bit vague. We should probably be a bit more clear that this sets ceph config options. Basically running beneath the hood ceph config set <service-name> <param> <value> for each param/value pair provided and doing so declaratively (as in, we'll keep checking the setting and change it if it has the wrong value). Additionally, you may want to try and incorporate some stuff from the first attempt at documenting this #44804

Copy link
Copy Markdown
Contributor Author

@rkachach rkachach Jul 4, 2022

Choose a reason for hiding this comment

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

@adk3798 agree, I reworded the doc and added more information. Please, let me know if more clarification is needed.

anthonyeleven
anthonyeleven requested changes Jul 2, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@anthonyeleven anthonyeleven left a comment

Choose a reason for hiding this comment

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

Commit and PR titles in conventional form please, something like:

doc/cephadm/services: Document the config section of service specs

@rkachach rkachach changed the title doc: adding doc for config section of service spec doc/cephadm/services: adding doc for config section of service spec Jul 4, 2022
@rkachach rkachach changed the title doc/cephadm/services: adding doc for config section of service spec doc/cephadm/services: the config section of service specs Jul 4, 2022
@rkachach
doc/cephadm/services: the config section of service specs
b67bd50 
Fixes: https://tracker.ceph.com/issues/53997

Signed-off-by: Redouane Kachach <rkachach@redhat.com>
@rkachach
Copy link
Copy Markdown
Contributor Author

rkachach commented Jul 4, 2022 •
edited
Loading

Commit and PR titles in conventional form please, something like:

doc/cephadm/services: Document the config section of service specs

Fixed.

BTW: in other doc PRs I saw the prefix doc/cephadm being used so not sure what's the correct one to be used. In dev we normally use two levels only i.e mgr/cephadm.

@rkachach rkachach requested review from adk3798 and anthonyeleven July 4, 2022 09:33
@anthonyeleven
Copy link
Copy Markdown
Contributor

anthonyeleven commented Jul 4, 2022

Oh and the project likes PR/commit messages to be imperatives, so something like

doc/cephadm/services: Document the config section of service specs

@adk3798 adk3798 merged commit b349762 into ceph:main Jul 5, 2022
@adk3798 adk3798 mentioned this pull request Jul 13, 2022
Merged
@adk3798 adk3798 mentioned this pull request Jul 28, 2022
Merged
@rkachach rkachach mentioned this pull request Feb 22, 2023
Closed
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anthonyeleven anthonyeleven anthonyeleven approved these changes

@adk3798 adk3798 adk3798 approved these changes

Assignees

No one assigned

Labels

cephadm documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rkachach @anthonyeleven @adk3798