From b7ca065edf11d0c4ee8e911c7316cec87bd10d08 Mon Sep 17 00:00:00 2001
From: chenxing <chason.chan@foxmail.com>
Date: Fri, 14 Jun 2019 04:02:07 -0400
Subject: [PATCH] Remove ``hnas_iscsi`` from the supported storage backends
 list of Cinder

The Hitachi NAS Platform iSCSI driver was marked as not supported by
Cinder in the Ocata realease[1].

[1] https://review.opendev.org/#/c/444287/

Change-Id: I1a25789374fddaefc57bc59badec06f91ee6a52a
Closes-Bug: #1832821
---
 ansible/group_vars/all.yml                    |  3 +-
 ansible/roles/cinder/defaults/main.yml        | 16 ++------
 ansible/roles/cinder/tasks/precheck.yml       |  1 -
 ansible/roles/cinder/templates/cinder.conf.j2 | 14 -------
 .../reference/storage/cinder-guide-hnas.rst   | 39 +------------------
 doc/source/reference/storage/cinder-guide.rst |  1 -
 etc/kolla/globals.yml                         |  1 -
 etc/kolla/passwords.yml                       |  1 -
 ...r-hnas_iscsi-backend-03e6242227b9184c.yaml |  7 ++++
 9 files changed, 13 insertions(+), 70 deletions(-)
 create mode 100644 releasenotes/notes/remove-cinder-hnas_iscsi-backend-03e6242227b9184c.yaml

diff --git a/ansible/group_vars/all.yml b/ansible/group_vars/all.yml
index 53d6270d45..12aa89a397 100644
--- a/ansible/group_vars/all.yml
+++ b/ansible/group_vars/all.yml
@@ -529,9 +529,8 @@ enable_ceph_dashboard: "{{ enable_ceph | bool }}"
 enable_chrony: "yes"
 enable_cinder: "no"
 enable_cinder_backup: "yes"
-enable_cinder_backend_hnas_iscsi: "no"
 enable_cinder_backend_hnas_nfs: "no"
-enable_cinder_backend_iscsi: "{{ enable_cinder_backend_lvm | bool or enable_cinder_backend_hnas_iscsi | bool or enable_cinder_backend_zfssa_iscsi | bool }}"
+enable_cinder_backend_iscsi: "{{ enable_cinder_backend_lvm | bool or enable_cinder_backend_zfssa_iscsi | bool }}"
 enable_cinder_backend_lvm: "no"
 enable_cinder_backend_nfs: "no"
 enable_cinder_backend_zfssa_iscsi: "no"
diff --git a/ansible/roles/cinder/defaults/main.yml b/ansible/roles/cinder/defaults/main.yml
index b88f3ce1af..7df2547e53 100644
--- a/ansible/roles/cinder/defaults/main.yml
+++ b/ansible/roles/cinder/defaults/main.yml
@@ -190,8 +190,6 @@ cinder_backends:
     enabled: "{{ enable_cinder_backend_lvm | bool }}"
   - name: "nfs-1"
     enabled: "{{ enable_cinder_backend_nfs | bool }}"
-  - name: "hnas-iscsi"
-    enabled: "{{ enable_cinder_backend_hnas_iscsi | bool }}"
   - name: "hnas-nfs"
     enabled: "{{ enable_cinder_backend_hnas_nfs | bool }}"
   - name: "vmwarevc-vmdk"
@@ -216,17 +214,9 @@ cinder_notification_topics:
 
 cinder_enabled_notification_topics: "{{ cinder_notification_topics | selectattr('enabled', 'equalto', true) | list }}"
 
-#############################################
-# Hitachi NAS Platform iSCSI and NFS drivers
-#############################################
-# iscsi
-hnas_iscsi_backend: "hnas_iscsi_backend"
-hnas_iscsi_username:
-hnas_iscsi_mgmt_ip0:
-hnas_iscsi_svc0_volume_type:
-hnas_iscsi_svc0_hdp:
-hnas_iscsi_svc0_ip:
-
+##################################
+# Hitachi NAS Platform NFS drivers
+##################################
 # nfs
 hnas_nfs_backend: "hnas_nfs_backend"
 hnas_nfs_username:
diff --git a/ansible/roles/cinder/tasks/precheck.yml b/ansible/roles/cinder/tasks/precheck.yml
index 09737bc7a8..4756b7d2f1 100644
--- a/ansible/roles/cinder/tasks/precheck.yml
+++ b/ansible/roles/cinder/tasks/precheck.yml
@@ -22,7 +22,6 @@
   local_action: fail msg="Please enable at least one backend when enabling Cinder"
   when:
     - not skip_cinder_backend_check | bool
-    - not enable_cinder_backend_hnas_iscsi | bool
     - not enable_cinder_backend_hnas_nfs | bool
     - not enable_cinder_backend_iscsi | bool
     - not enable_cinder_backend_lvm | bool
diff --git a/ansible/roles/cinder/templates/cinder.conf.j2 b/ansible/roles/cinder/templates/cinder.conf.j2
index 789010084f..c9b2f4033c 100644
--- a/ansible/roles/cinder/templates/cinder.conf.j2
+++ b/ansible/roles/cinder/templates/cinder.conf.j2
@@ -145,20 +145,6 @@ nas_secure_file_permissions = False
 nas_secure_file_operations = False
 {% endif %}
 
-{% if enable_cinder_backend_hnas_iscsi | bool %}
-[hnas-iscsi]
-volume_driver = cinder.volume.drivers.hitachi.hnas_iscsi.HNASISCSIDriver
-volume_backend_name = {{ hnas_iscsi_backend }}
-hnas_username = {{ hnas_iscsi_username }}
-hnas_password = {{ hnas_iscsi_password }}
-hnas_mgmt_ip0 = {{ hnas_iscsi_mgmt_ip0 }}
-hnas_chap_enabled = True
-
-hnas_svc0_volume_type = {{ hnas_iscsi_svc0_volume_type }}
-hnas_svc0_hdp = {{ hnas_iscsi_svc0_hdp }}
-hnas_svc0_iscsi_ip = {{ hnas_iscsi_svc0_ip }}
-{% endif %}
-
 {% if enable_cinder_backend_hnas_nfs | bool %}
 [hnas-nfs]
 volume_driver = cinder.volume.drivers.hitachi.hnas_nfs.HNASNFSDriver
diff --git a/doc/source/reference/storage/cinder-guide-hnas.rst b/doc/source/reference/storage/cinder-guide-hnas.rst
index e710c4c1b8..7cd5a0712a 100644
--- a/doc/source/reference/storage/cinder-guide-hnas.rst
+++ b/doc/source/reference/storage/cinder-guide-hnas.rst
@@ -54,43 +54,8 @@ The NFS and iSCSI drivers support these operations:
 
 - Manage and unmanage snapshots (HNAS NFS only).
 
-Configuration example for Hitachi NAS Platform iSCSI and NFS
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-iSCSI backend
--------------
-
-Enable cinder hnas backend iscsi in ``/etc/kolla/globals.yml``
-
-.. code-block:: yaml
-
-   enable_cinder_backend_hnas_iscsi: "yes"
-
-Create or modify the file ``/etc/kolla/config/cinder.conf`` and add the
-contents:
-
-.. path /etc/kolla/config/cinder.conf
-.. code-block:: ini
-
-   [DEFAULT]
-   enabled_backends = hnas-iscsi
-
-   [hnas-iscsi]
-   volume_driver = cinder.volume.drivers.hitachi.hnas_iscsi.HNASISCSIDriver
-   volume_iscsi_backend = hnas_iscsi_backend
-   hnas_iscsi_username = supervisor
-   hnas_iscsi_mgmt_ip0 = <hnas_ip>
-   hnas_chap_enabled = True
-
-   hnas_iscsi_svc0_volume_type = iscsi_gold
-   hnas_iscsi_svc0_hdp = FS-Baremetal1
-   hnas_iscsi_svc0_iscsi_ip = <svc0_ip>
-
-Then set password for the backend in ``/etc/kolla/passwords.yml``:
-
-.. code-block:: yaml
-
-   hnas_iscsi_password: supervisor
+Configuration example for Hitachi NAS Platform NFS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 NFS backend
 -----------
diff --git a/doc/source/reference/storage/cinder-guide.rst b/doc/source/reference/storage/cinder-guide.rst
index d6e8b2d53f..8181c764e4 100644
--- a/doc/source/reference/storage/cinder-guide.rst
+++ b/doc/source/reference/storage/cinder-guide.rst
@@ -11,7 +11,6 @@ Cinder can be deployed using Kolla and supports the following storage
 backends:
 
 * ceph
-* hnas_iscsi
 * hnas_nfs
 * iscsi
 * lvm
diff --git a/etc/kolla/globals.yml b/etc/kolla/globals.yml
index cdfea0930b..43dd0c19a4 100644
--- a/etc/kolla/globals.yml
+++ b/etc/kolla/globals.yml
@@ -201,7 +201,6 @@ kolla_internal_vip_address: "10.10.10.254"
 #enable_chrony: "yes"
 #enable_cinder: "no"
 #enable_cinder_backup: "yes"
-#enable_cinder_backend_hnas_iscsi: "no"
 #enable_cinder_backend_hnas_nfs: "no"
 #enable_cinder_backend_iscsi: "no"
 #enable_cinder_backend_lvm: "no"
diff --git a/etc/kolla/passwords.yml b/etc/kolla/passwords.yml
index 87204dac10..0dd959b836 100644
--- a/etc/kolla/passwords.yml
+++ b/etc/kolla/passwords.yml
@@ -40,7 +40,6 @@ nsxv3_api_password:
 #####################
 # Hitachi NAS support
 #####################
-hnas_iscsi_password:
 hnas_nfs_password:
 
 ######################
diff --git a/releasenotes/notes/remove-cinder-hnas_iscsi-backend-03e6242227b9184c.yaml b/releasenotes/notes/remove-cinder-hnas_iscsi-backend-03e6242227b9184c.yaml
new file mode 100644
index 0000000000..eb86beb885
--- /dev/null
+++ b/releasenotes/notes/remove-cinder-hnas_iscsi-backend-03e6242227b9184c.yaml
@@ -0,0 +1,7 @@
+---
+deprecations:
+  - |
+    Remove the ``hnas_iscsi`` cinder backend. The Hitachi NAS Platform
+    iSCSI driver was `marked as not supported by Cinder
+    <https://docs.openstack.org/releasenotes/cinder/ocata.html#deprecation-notes>`_
+    in the Ocata release.