diff --git a/cinder/volume/drivers/hpe/hpe_3par_common.py b/cinder/volume/drivers/hpe/hpe_3par_common.py index 511d29137ee..cc390783fca 100644 --- a/cinder/volume/drivers/hpe/hpe_3par_common.py +++ b/cinder/volume/drivers/hpe/hpe_3par_common.py @@ -86,27 +86,27 @@ hpe3par_opts = [ cfg.StrOpt('hpe3par_api_url', default='', help="WSAPI Server URL. " - "This setting applies to both 3PAR and Primera. " + "This setting applies to: 3PAR, Primera and Alletra 9k " "\n Example 1: for 3PAR, URL is: " "\n https://<3par ip>:8080/api/v1 " - "\n Example 2: for Primera, URL is: " + "\n Example 2: for Primera/Alletra 9k, URL is: " "\n https://:443/api/v1"), cfg.StrOpt('hpe3par_username', default='', - help="3PAR / Primera username with the 'edit' role"), + help="3PAR/Primera/Alletra 9k username with the 'edit' role"), cfg.StrOpt('hpe3par_password', default='', - help="3PAR / Primera password for the user specified " + help="3PAR/Primera/Alletra 9k password for the user specified " "in hpe3par_username", secret=True), cfg.ListOpt('hpe3par_cpg', default=["OpenStack"], - help="List of the 3PAR / Primera CPG(s) to use for " + help="List of the 3PAR/Primera/Alletra 9k CPG(s) to use for " "volume creation"), cfg.StrOpt('hpe3par_cpg_snap', default="", - help="The 3PAR / Primera CPG to use for snapshots of volumes. " - "If empty the userCPG will be used."), + help="The 3PAR/Primera/Alletra 9k CPG to use for snapshots of " + "volumes. If empty the userCPG will be used."), cfg.StrOpt('hpe3par_snapshot_retention', default="", help="The time in hours to retain a snapshot. " @@ -117,7 +117,7 @@ hpe3par_opts = [ " and is deleted. This must be larger than expiration"), cfg.BoolOpt('hpe3par_debug', default=False, - help="Enable HTTP debugging to 3PAR / Primera"), + help="Enable HTTP debugging to 3PAR/Primera/Alletra 9k"), cfg.ListOpt('hpe3par_iscsi_ips', default=[], help="List of target iSCSI addresses to use."), @@ -126,10 +126,10 @@ hpe3par_opts = [ help="Enable CHAP authentication for iSCSI connections."), cfg.StrOpt('hpe3par_target_nsp', default="", - help="The nsp of 3PAR backend to be used when: " - "(1) multipath is not enabled in cinder.conf. " + help="The nsp of 3PAR/Primera/Alletra 9k backend to be used " + "when: (1) multipath is not enabled in cinder.conf. " "(2) Fiber Channel Zone Manager is not used. " - "(3) the 3PAR backend is prezoned with this " + "(3) the backend is prezoned with this " "specific nsp only. For example if nsp is 2 1 2, the " "format of the option's value is 2:1:2"), ] diff --git a/doc/source/configuration/block-storage/drivers/hpe-3par-driver.rst b/doc/source/configuration/block-storage/drivers/hpe-3par-driver.rst index dd5e48d7373..a68da6e3d3b 100644 --- a/doc/source/configuration/block-storage/drivers/hpe-3par-driver.rst +++ b/doc/source/configuration/block-storage/drivers/hpe-3par-driver.rst @@ -1,21 +1,21 @@ -==================================================== -HPE 3PAR and HPE Primera Driver for OpenStack Cinder -==================================================== +=============================================== +HPE 3PAR, HPE Primera and HPE Alletra 9k Driver +=============================================== The ``HPE3PARFCDriver`` and ``HPE3PARISCSIDriver`` drivers, which are based on the Block Storage service (Cinder) plug-in architecture, run volume operations -by communicating with the HPE 3PAR and HPE Primera storage system over HTTP, -HTTPS, and SSH connections. The HTTP and HTTPS communications use -``python-3parclient``, which is part of PyPi. +by communicating with the HPE 3PAR, HPE Primera and HPE Alletra 9k storage +systems over HTTP, HTTPS, and SSH connections. The HTTP & HTTPS communications +use ``python-3parclient``, which is part of PyPi. -For information on HPE 3PAR and HPE Primera Driver for OpenStack Cinder, refer to +For information on HPE 3PAR, HPE Primera and HPE Alletra 9k Driver, refer to `content kit page `_. System requirements ~~~~~~~~~~~~~~~~~~~ -To use the HPE 3PAR and HPE Primera drivers, install the following software -and components on the HPE 3PAR storage system: +To use the HPE 3PAR, HPE Primera and HPE Alletra 9k drivers, install the +following software and components on the HPE 3PAR storage system: * HPE 3PAR Operating System software version 3.1.3 MU1 or higher. @@ -60,14 +60,14 @@ and components on the HPE 3PAR storage system: newer from PyPi on the system with the enabled Block Storage service volume drivers. -To use the HPE Primera backend, install the following software and components -on the HPE Primera storage system: +To use the HPE Primera and HPE Alletra 9k backends, install the following +software and components on the HPE Primera storage system: -* HPE Primera Operating System software version 4.0.0. +* HPE Primera Operating System software version 4.0.0 or higher. - * On HPE Primera storage system, Dedup & Compression is combined as single - option 'deco'. Due to this, only either 'thin' volume or 'deco' volume - can be created. + * On HPE Primera/Alletra 9k storage system, Dedup & Compression is + combined as single option 'deco'. Due to this, only either 'thin' volume + or 'deco' volume can be created. * Also, port number 443 is used instead of 8080. This only affects cinder configuration. @@ -158,7 +158,7 @@ pairs and associate them with a volume type, run the following command: Volumes that are cloned only support the extra specs keys cpg, snap_cpg, provisioning and vvs. The others are ignored. In addition the comments - section of the cloned volume in the HPE 3PAR / HPE Primera array is + section of the cloned volume in the HPE 3PAR / Primera / Alletra 9k array is not populated. If volume types are not used or a particular key is not set for a volume type, @@ -216,8 +216,8 @@ pairs and associate them with a volume type, run the following commands: $ openstack help volume qos -The following keys require that the HPE 3PAR / HPE Primera array has a -Priority Optimization enabled. +The following keys require that the HPE 3PAR / Primera / Alletra 9k array +has a Priority Optimization enabled. ``hpe3par:vvs`` The virtual volume set name that has been predefined by the Administrator @@ -254,8 +254,8 @@ Priority Optimization enabled. set I/O limits. Similarly, minBWS and maxBWS must be used together. If only one is set the other will be set to the same value. -The following key requires that the HPE 3PAR / HPE Primera array has an -Adaptive Flash Cache enabled. +The following key requires that the HPE 3PAR / Primera / Alletra 9k array has +an Adaptive Flash Cache enabled. * ``hpe3par:flash_cache`` - The flash-cache policy, which can be turned on and off by setting the value to ``true`` or ``false``. @@ -273,8 +273,8 @@ Other restrictions and considerations for ``hpe3par:compression``: if a compression is enabled and provisioning type requested is full, the resulting volume defaults to thinly provisioned compressed volume. -* While creating volume on HPE Primera storage system, only below two - combinations are supported. If any other combination is used, then +* While creating volume on HPE Primera / Alletra 9k storage system, only below + two combinations are supported. If any other combination is used, then volume is not created. * thin volume: provisioning = ``thin`` and compression = ``false`` @@ -304,10 +304,10 @@ OpenStack software. #. Verify that the HPE 3PAR Web Services API server is enabled and running on - the HPE 3PAR / HPE Primera storage system. + the HPE 3PAR / Primera / Alletra 9k storage system. - a. Log onto the HPE 3PAR / HPE Primera storage system with administrator - access. + a. Log onto the HPE 3PAR / Primera / Alletra 9k storage system with + administrator access. .. code-block:: console @@ -344,28 +344,28 @@ OpenStack software. To stop the Web Services API Server, use the :command:`stopwsapi` command. For other options run the :command:`setwsapi -h` command. -#. If you are not using an existing CPG, create a CPG on the HPE 3PAR / HPE - Primera storage system to be used as the default location for creating volumes. +#. If you are not using an existing CPG, create a CPG on the HPE 3PAR / Primera + / Alletra 9k storage system to be used as the default location for creating volumes. #. Make the following changes in the ``/etc/cinder/cinder.conf`` file. .. code-block:: ini # WSAPI Server URL. - # This setting applies to both 3PAR and Primera. + # This setting applies to all: 3PAR, Primera and Alletra 9k. # Example 1: for 3PAR, URL is: https://<3par ip>:8080/api/v1 - # Example 2: for Primera, URL is: - https://:443/api/v1 + # Example 2: for Primera/Alletra 9k, URL is: + https://:443/api/v1 - # 3PAR / Primera username with the 'edit' role + # 3PAR / Primera / Alletra 9k username with the 'edit' role hpe3par_username=edit3par - # 3PAR / Primera password for the user specified in hpe3par_username + # 3PAR / Primera / Alletra 9k password for the user specified in hpe3par_username hpe3par_password=3parpass - # 3PAR / Primera CPG to use for volume creation + # 3PAR / Primera / Alletra 9k CPG to use for volume creation hpe3par_cpg=OpenStackCPG_RAID5_NL # IP address of SAN controller for SSH access to the array @@ -396,7 +396,7 @@ OpenStack software. # Still available for single port iSCSI configuration #iscsi_ip_address=10.10.220.253 - # Enable HTTP debugging to 3PAR / Primera + # Enable HTTP debugging to 3PAR / Primera / Alletra 9k hpe3par_debug=False # Enable CHAP authentication for iSCSI connections. diff --git a/releasenotes/notes/hpe-3par-add-alletra-9k-info-5e1d09e083d3faa9.yaml b/releasenotes/notes/hpe-3par-add-alletra-9k-info-5e1d09e083d3faa9.yaml new file mode 100644 index 00000000000..ed4b8d38e96 --- /dev/null +++ b/releasenotes/notes/hpe-3par-add-alletra-9k-info-5e1d09e083d3faa9.yaml @@ -0,0 +1,5 @@ +other: + - | + HPE 3PAR: Documented that existing driver supports the new Alletra 9k + backend. HPE Alletra 9k is newer version of existing HPE Primera backend. +