Bug 1565143

Summary: [Doc] iSCSI gateway configuration guide needs changes
Product: Red Hat Ceph Storage Reporter: Madhavi Kasturi <mkasturi>
Component: DocumentationAssignee: Aron Gunn <agunn>
Status: CLOSED CURRENTRELEASE QA Contact: Madhavi Kasturi <mkasturi>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 3.0CC: agunn, hnallurv, kdreyer, pasik
Target Milestone: z2   
Target Release: 3.0   
Hardware: Unspecified   
OS: Unspecified   
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-08-26 06:55:33 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Madhavi Kasturi 2018-04-09 13:34:26 UTC
Description of problem:
The iSCSI gateway configuration document needs the following changes.
doc - https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/3/html/block_device_guide/using_an_iscsi_gateway

1. Spelling correction from Tolls to Tools.
a. On the iSCSI gateway nodes, enable the Red Hat Ceph Storage 3 Tolls repository. For
b. Enable the Red Hat Ceph Storage 3 Tolls repository. For details, see the Enabling the
change: Tolls to Tools

2. 9.2.1. Configuring the iSCSI Target using Ansible.
Section: iii ) Add an entry in /etc/ansible/hosts file for the gateway
Note: If colocating the iSCSI gateway with an OSD node, add the OSD node to the [ceph-iscsi-gw] section.
Change: [ceph-iscsi-gw] to [iscsi-gw]

3. 9.2.2. Configuring the iSCSI Target using the Command Line Interface --> Installing:
Section: 3. Create a file named iscsi-gateway.cfg
Sub-section - 3.i ) Edit the iscsi-gateway.cfg file and add the following lines:
ADD:  '# trusted_ip_list =,'  in both Syntax and Example section.

4. 9.2.2. Configuring the iSCSI Target using the Command Line Interface --> Configuring
Section: Adding a RADOS Block Device (RBD): The disks path mentioned in the snippet needs correction.
Change: cd /iscsi-target/iqn.2003-01.com.redhat.iscsi-gw:ceph-igw/disks/  to cd /disks

5.  9.2.2. Configuring the iSCSI Target using the Command Line Interface --> Configuring--> Creating a client:
Sytnax and Example should change to
Change: '> auth <user_name>/<password> | nochap ' to '> auth chap=<user_name>/<password> | nochap'

6. 9.3.4. The iSCSI Initiator for VMware ESX --> iSCSI Discovery and Multipath Device Setup:
Section: 5. On the CHAP Credentials windows, select “Do not use CHAP unless required by target”
Add the following:
The Mutual CHAP authentication section should have “Do not use CHAP” selected.

Warning: There is a bug in the web client where the requested CHAP settings are not always used initially.

7. Request to change the screenshot images from vsphere client to WEB UI as present in the upstream document - http://docs.ceph.com/docs/master/rbd/iscsi-initiator-esx/

Version-Release number of selected component (if applicable):

How reproducible:

Steps to Reproduce:

Actual results:

Expected results:

Additional info: