Project

General

Profile

Actions

Feature #50160

closed

Self document attributes for each kind of service

Added by Juan Miguel Olmo Martínez about 3 years ago. Updated over 2 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
-
Category:
cephadm
Target version:
-
% Done:

0%

Source:
Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

Apart of the documentation we do not have another way to know what are the properties/attributes that we can use in a spec file for a kind of service. Even in the documentation this kind of information is not present sometimes... for example RGW service.

Attributes and properties can change due to bug fixing and implementation of new functionality, so we need to provide this information as part of the orchestrators API.

for example:

ceph orch describe <kind-of-service> <kind-of-service: rgw|nfs|osd|iscsi|alertmanager|ha-rgw|container>

In the documentation we need to add a note in each type of service suggestion to use the "describe" command to get the information about the composition of the spec file for the service. I think we also need to add a brief example of configuring the service using a spec file

Actions

Also available in: Atom PDF