From: Sebastian Wagner <sewagner@redhat.com>
Date: Wed, 29 Sep 2021 10:00:42 +0000 (+0200)
Subject: doc/cephadm: use sphinx autoclass to document IscsiServiceSpec
X-Git-Tag: v16.2.7~67^2~27
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=7863887b703ff5d202d03e8bfbe23f129bbf236b;p=ceph.git

doc/cephadm: use sphinx autoclass to document IscsiServiceSpec

Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
(cherry picked from commit 2e7b369373236c32e429463512521da1fc7e159d)
---

diff --git a/doc/cephadm/services/iscsi.rst b/doc/cephadm/services/iscsi.rst
index 581d2c9d4061..e039e8d9a346 100644
--- a/doc/cephadm/services/iscsi.rst
+++ b/doc/cephadm/services/iscsi.rst
@@ -44,7 +44,6 @@ For example:
       trusted_ip_list: "IP_ADDRESS_1,IP_ADDRESS_2,IP_ADDRESS_3,..."
       api_user: API_USERNAME
       api_password: API_PASSWORD
-      api_secure: true
       ssl_cert: |
         -----BEGIN CERTIFICATE-----
         MIIDtTCCAp2gAwIBAgIYMC4xNzc1NDQxNjEzMzc2MjMyXzxvQ7EcMA0GCSqGSIb3
@@ -58,6 +57,11 @@ For example:
         [...]
         -----END PRIVATE KEY-----
 
+.. py:currentmodule:: ceph.deployment.service_spec
+
+.. autoclass:: IscsiServiceSpec
+   :members:
+
 
 The specification can then be applied using:
 
@@ -68,6 +72,8 @@ The specification can then be applied using:
 
 See :ref:`orchestrator-cli-placement-spec` for details of the placement specification.
 
+See also: :ref:`orchestrator-cli-service-spec`.
+
 Further Reading
 ===============
 
diff --git a/src/python-common/ceph/deployment/service_spec.py b/src/python-common/ceph/deployment/service_spec.py
index eb4e6c2e9210..b0b852c1216d 100644
--- a/src/python-common/ceph/deployment/service_spec.py
+++ b/src/python-common/ceph/deployment/service_spec.py
@@ -833,12 +833,19 @@ class IscsiServiceSpec(ServiceSpec):
 
         #: RADOS pool where ceph-iscsi config data is stored.
         self.pool = pool
+        #: list of trusted IP addresses
         self.trusted_ip_list = trusted_ip_list
+        #: ``api_port`` as defined in the ``iscsi-gateway.cfg``
         self.api_port = api_port
+        #: ``api_user`` as defined in the ``iscsi-gateway.cfg``
         self.api_user = api_user
+        #: ``api_password`` as defined in the ``iscsi-gateway.cfg``
         self.api_password = api_password
+        #: ``api_secure`` as defined in the ``iscsi-gateway.cfg``
         self.api_secure = api_secure
+        #: SSL certificate
         self.ssl_cert = ssl_cert
+        #: SSL private key
         self.ssl_key = ssl_key
 
         if not self.api_secure and self.ssl_cert and self.ssl_key: