]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc: Add rbd-target-api ceph iscsi ansible vars
authorMike Christie <mchristi@redhat.com>
Thu, 20 Jun 2019 02:39:48 +0000 (21:39 -0500)
committerJason Dillaman <dillaman@redhat.com>
Mon, 24 Jun 2019 18:27:53 +0000 (14:27 -0400)
Signed-off-by: Mike Christie <mchristi@redhat.com>
doc/rbd/iscsi-target-ansible.rst

index 42e1c64e8af26d0ff6edf486b21c955933f85a1e..5f46be30241a230797e423d2ef69f1a3255e49e1 100644 (file)
@@ -43,7 +43,8 @@ install, and configure the Ceph iSCSI gateway for basic operation.
 The ``ceph-ansible`` package places a file in the ``/usr/share/ceph-ansible/group_vars/``
 directory called ``iscsigws.yml.sample``. Create a copy of this sample file named
 ``iscsigws.yml``. Review the following Ansible variables and descriptions,
-and update accordingly.
+and update accordingly. See the ``iscsigws.yml.sample`` for a full list of
+advanced variables.
 
 +--------------------------------------+--------------------------------------+
 | Variable                             | Meaning/Purpose                      |
@@ -72,6 +73,26 @@ and update accordingly.
 |                                      | run to ensure multipathd and lvm are |
 |                                      | configured properly.                 |
 +--------------------------------------+--------------------------------------+
+| ``api_user``                         | The user name for the API. The       |
+|                                      | default is `admin`.                  |
++--------------------------------------+--------------------------------------+
+| ``api_password``                     | The password for using the API. The  |
+|                                      | default is `admin`.                  |
++--------------------------------------+--------------------------------------+
+| ``api_port``                         | The TCP port number for using the    |
+|                                      | API. The default is `5000`.          |
++--------------------------------------+--------------------------------------+
+| ``api_secure``                       | True if TLS must be used. The        |
+|                                      | default is `false`. If true the user |
+|                                      | must create the necessary            |
+|                                      | certificate and key files. See the   |
+|                                      | gwcli man file for details.          |
++--------------------------------------+--------------------------------------+
+| ``trusted_ip_list``                  | A list of IPv4 or IPv6 addresses     |
+|                                      | who have access to the API. By       |
+|                                      | default, only the iSCSI gateway      |
+|                                      | nodes have access.                   |
++--------------------------------------+--------------------------------------+
 
 **Deploying:**