From 37c9a9695547c98713cfd01a09736e1ed93a115e Mon Sep 17 00:00:00 2001 From: Mike Christie Date: Wed, 19 Jun 2019 21:39:48 -0500 Subject: [PATCH] doc: Add rbd-target-api ceph iscsi ansible vars Signed-off-by: Mike Christie --- doc/rbd/iscsi-target-ansible.rst | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/doc/rbd/iscsi-target-ansible.rst b/doc/rbd/iscsi-target-ansible.rst index 42e1c64e8af..5f46be30241 100644 --- a/doc/rbd/iscsi-target-ansible.rst +++ b/doc/rbd/iscsi-target-ansible.rst @@ -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:** -- 2.39.5