Rewrite fields description in UI

- Rewritten labels and descriptions of fields in UI
- Fixed wrong links to fuel documentation
- Fixed typos

Change-Id: If33ff51b47d43c3fe897a9425b240d524be35c1f
This commit is contained in:
Andrey Volochay 2016-05-10 15:57:40 +03:00
parent bdbe838983
commit 7d70c93c37
12 changed files with 64 additions and 66 deletions

View File

@ -7,7 +7,7 @@ Overview
NetApp plugin can replace the Cinder LVM backend by Cinder Netapp Backend or work in parallel when deployed with multi-backend enabled.
LVM is the default volume backend that uses local volumes managed by LVM.
The plugin support following storage familly mode:
The plugin support following storage family mode:
- ONTAP 7-Mode
- ONTAP Cluster Mode
- E-Series
@ -21,19 +21,23 @@ Requirements
| Requirement | Version/Comment |
|------------------------------------------------------------------------------------------|---------------------------------------------------------|
| Mirantis Openstack compatibility | 8.0 |
| Netapp filer or appliance is reacheble via one of the Mirantis OpenStack networks | ONTAP or E-Series storage family with NTF\iSCSI enabled |
| Netapp filer or appliance is reachable via one of the Mirantis OpenStack networks | ONTAP or E-Series storage family with NTF\iSCSI enabled |
Release Notes
-------------
**4.1.0**
* Rewrite fields in UI
**4.0.0**
* add MOS 8.0 support
**3.2.0**
* add E-Series storage familly support
* add E-Series storage family support
* fix the plugin UI
@ -59,7 +63,7 @@ Release Notes
**1.1.0**
* add 7 mode storage familly support
* add 7 mode storage family support
**1.0.0**

View File

@ -11,7 +11,7 @@ create OpenStack environments that use NetApp storage as a Cinder backend.
:width: 90%
#. Finish environment creation following
`the instructions <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#create-a-new-openstack-environment>`_.
`the instructions <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_.
#. Once the environment is created, open the **Settings** tab of the Fuel Web UI
and then **Storage**. Scroll down the page. Select the **Cinder and NetApp integration**
@ -29,7 +29,7 @@ create OpenStack environments that use NetApp storage as a Cinder backend.
#. Choose storage family and storage protocol. Several options are available.
- If you plan to use ONTAP cluster mode through NFS, click **Ontap Cluster**
radiobutton and select *nfs* option in **Netapp storage protocol**.
radio button and select *nfs* option in **Netapp storage protocol**.
You should also choose NetApp transport type (http or https).
Specify the following parameters in the text fields:
@ -97,7 +97,7 @@ create OpenStack environments that use NetApp storage as a Cinder backend.
:width: 100%
#. Using *Nodes* tab,
`add nodes and assign roles to them <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#add-nodes-to-the-environment>`_.
`add nodes and assign roles to them <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/add-nodes.html>`_.
Please, note that all controller nodes should be configured with Cinder role.
#. This step is needed only when local fuel mirrors are used
@ -110,7 +110,7 @@ create OpenStack environments that use NetApp storage as a Cinder backend.
- "open-iscsi"
- "multipath-tools"
#. Press `Deploy button <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#deploy-changes>`_
#. Press `Deploy button <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment/deploy-changes.html>`_
once you are done with environment configuration.
#. When the deployment is done, you may perform functional testing.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 98 KiB

View File

@ -1,11 +1,5 @@
.. NetApp plugin for Fuel documentation master file, created by
sphinx-quickstart on Wed Feb 17 20:38:48 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
============================================
Guide to the Cinder NetApp plugin ver. 4.0.0
Guide to the Cinder NetApp plugin ver. 4.1.0
============================================
This document will guide you through the steps to install,

View File

@ -8,21 +8,21 @@ To install the Cinder Netapp plugin, follow these steps:
#. Copy the plugin's RPM to the Fuel Master node (if you don't
have the Fuel Master node, please see `the official
Mirantis OpenStack documentation <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html#installing-mirantis-openstack-manually>`_)::
Mirantis OpenStack documentation <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_)::
[root@home ~]# scp cinder_netapp-4.0-4.0.0-1.noarch.rpm root@fuel-master:/tmp
[root@home ~]# scp cinder_netapp-4.1-4.1.0-1.noarch.rpm root@fuel-master:/tmp
#. Log into Fuel Master node and install the plugin using the
`Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#using-fuel-cli>`_::
`Fuel CLI <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/cli.html>`_::
[root@fuel-master ~]# fuel plugins --install cinder_netapp-4.0-4.0.0-1.noarch.rpm
[root@fuel-master ~]# fuel plugins --install cinder_netapp-4.1-4.1.0-1.noarch.rpm
#. Verify that the plugin is installed correctly::
[root@fuel-master ~]# fuel plugins
id | name | version | package_version
---|---------------|---------|----------------
1 | cinder_netapp | 4.0.0 | 4.0.0
1 | cinder_netapp | 4.1.0 | 4.0.0
.. _Fuel Plugins Catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/

View File

@ -13,15 +13,15 @@ attributes:
value: 'ontap_cluster'
values:
- data: 'ontap_cluster'
label: 'Ontap Cluster'
description: 'Data ONTAP operating in Clustered storage family'
label: 'Clustered Data ONTAP'
description: ''
- data: 'ontap_7mode'
label: 'Ontap 7-Mode'
description: 'Data ONTAP operating in 7-Mode storage family'
label: 'Data ONTAP 7-Mode'
description: ''
- data: 'eseries'
label: 'E-Series'
description: 'E-Series storage family'
label: 'Netapp Storage Family'
label: 'E-Series/EF-Series'
description: ''
label: 'NetApp Storage Family'
weight: 11
type: 'radio'
netapp_storage_protocol:
@ -36,7 +36,7 @@ attributes:
restrictions:
- condition: "settings:cinder_netapp.netapp_storage_family.value == 'eseries'"
action: 'hide'
label: 'Netapp Storage Protocol'
label: 'NetApp Storage Protocol'
description: 'The storage protocol to be used on the data path with the storage system'
weight: 12
type: 'radio'
@ -58,13 +58,13 @@ attributes:
# Connection
netapp_server_hostname:
value: ''
label: 'NetApp Hostname'
label: 'NetApp Storage Hostname/IP'
description: 'The hostname or IP address for the storage system or proxy server'
weight: 31
type: 'text'
netapp_server_port:
value: ''
label: 'NetApp Server Port'
label: 'NetApp Storage Port'
description: 'The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS'
weight: 32
type: 'text'
@ -77,7 +77,7 @@ attributes:
- data: 'https'
label: 'https'
description: ''
label: 'Netapp Transport Type'
label: 'Transport Type'
description: 'The transport protocol used for communication with the storage system or proxy server'
weight: 33
type: 'radio'
@ -85,8 +85,8 @@ attributes:
# NFS Shares
nfs_server_ip:
value: ''
label: 'NetApp NFS server'
description: 'The hostname or IP address for NFS server started on NetApp apliance'
label: 'CDOT Data LIF IP address'
description: 'The Data LIF IP address is part of the NFS export location (e.g. If the export is 10.10.10.10:/cinder_flexvol, this value will be 10.10.10.10)'
weight: 41
type: 'text'
restrictions:
@ -112,8 +112,8 @@ attributes:
action: 'hide'
nfs_server_share1:
value: ''
label: 'NFS share'
description: 'The NFS share path (e.g. /vol1)'
label: 'CDOT FlexVol volume junction path'
description: 'The junction path is part of the NFS export location and specifies the path for the FlexVol volume in which Cinder volumes should be placed (e.g. If the export is 10.10.10.10:/cinder_flexvol, this value will be /cinder_flexvol)'
weight: 43
type: 'text'
restrictions:
@ -121,8 +121,8 @@ attributes:
action: 'hide'
nfs_server_share2:
value: ''
label: 'NFS share 2'
description: 'The NFS share path (e.g. /vol2)'
label: 'CDOT FlexVol volume junction path 2'
description: 'The junction path is part of the NFS export location and specifies the path for the FlexVol volume in which Cinder volumes should be placed (e.g. If the export is 10.10.10.10:/cinder_flexvol_2, this value will be /cinder_flexvol_2)'
weight: 44
type: 'text'
restrictions:
@ -130,8 +130,8 @@ attributes:
action: 'hide'
nfs_server_share3:
value: ''
label: 'NFS share 3'
description: 'The NFS share path (e.g. /vol3)'
label: 'CDOT FlexVol volume junction path 3'
description: 'The junction path is part of the NFS export location and specifies the path for the FlexVol volume in which Cinder volumes should be placed (e.g. If the export is 10.10.10.10:/cinder_flexvol_3, this value will be /cinder_flexvol_3)'
weight: 45
type: 'text'
restrictions:
@ -139,8 +139,8 @@ attributes:
action: "hide"
nfs_server_share4:
value: ''
label: 'NFS share 4'
description: 'The NFS share path (e.g. /vol4)'
label: 'CDOT FlexVol volume junction path 4'
description: 'The junction path is part of the NFS export location and specifies the path for the FlexVol volume in which Cinder volumes should be placed (e.g. If the export is 10.10.10.10:/cinder_flexvol_4, this value will be /cinder_flexvol_4)'
weight: 46
type: 'text'
restrictions:
@ -150,8 +150,8 @@ attributes:
# Ontap Cluster
netapp_vserver:
value: ''
label: 'Vserver'
description: 'This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur'
label: 'Storage Virtual Machine'
description: 'This option specifies the storage virtual machine (vserver) name in which provisioning of block storage volumes should occur'
weight: 51
type: 'text'
restrictions:
@ -162,7 +162,7 @@ attributes:
netapp_vfiler:
value: ''
label: 'vFiler'
description: '(Optionnal) The vFiler unit on which provisioning of block storage volumes will be done'
description: '(Optional) The vFiler unit on which provisioning of block storage volumes will be done'
weight: 51
type: 'text'
restrictions:
@ -191,7 +191,7 @@ attributes:
netapp_eseries_host_type:
value: 'linux_dm_mp'
label: 'Host Type'
description: '(Optionnal) This option defines the type of operating system for all initiators that can access a LUN'
description: '(Optional) This option defines the type of operating system for all initiators that can access a LUN'
weight: 62
type: 'text'
restrictions:
@ -200,7 +200,7 @@ attributes:
netapp_enable_multiattach:
value: false
label: 'Multiattach'
description: '(Optionnal) This option specifies whether the driver should allow operations that require multiple attachments to a volume'
description: '(Optional) This option specifies whether the driver should allow operations that require multiple attachments to a volume'
weight: 63
type: 'checkbox'
restrictions:
@ -211,7 +211,7 @@ attributes:
nfs_mount_options:
value: ''
label: 'NFS Mount Options'
description: '(Optional) Will be used when mouning shares on the Storage and Compute nodes'
description: '(Optional) This option will be used when mounting shares on the Storage and Compute nodes'
weight: 61
type: 'text'
restrictions:
@ -219,8 +219,8 @@ attributes:
action: 'hide'
thres_avl_size_perc_start:
value: '20'
label: 'Thres Avl Size Perc Start'
description: '(Optionnal) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned'
label: 'Threshold Available Size (% Start)'
description: '(Optional) If the percentage of available space for an NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned'
weight: 62
type: 'text'
restrictions:
@ -228,8 +228,8 @@ attributes:
action: "hide"
thres_avl_size_perc_stop:
value: '60'
label: 'Thres Avl Size Perc Stop'
description: '(Optionnal) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache'
label: 'Threshold Available Size (% Stop)'
description: '(Optional) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache'
weight: 63
type: 'text'
restrictions:
@ -237,8 +237,8 @@ attributes:
action: 'hide'
expiry_thres_minutes:
value: '720'
label: 'Expiry Thres Minutes'
description: '(Optionnal) This option specifies the threshold for last access time for images in the NFS image cache'
label: 'Expiry Threshold (Minutes)'
description: '(Optional) This option specifies the threshold for last access time for images in the NFS image cache'
weight: 64
type: 'text'
restrictions:
@ -248,8 +248,8 @@ attributes:
# Ontap Cluster with NFS
netapp_copyoffload_tool_path:
value: ''
label: 'Copyoffload Tool Path'
description: '(Optionnal) This option specifies the path of the NetApp copy offload tool binary'
label: 'Copy Offload Tool Path'
description: '(Optional) This option specifies the path of the NetApp copy offload tool binary'
weight: 65
type: 'text'
restrictions:
@ -260,7 +260,7 @@ attributes:
netapp_pool_name_search_pattern:
value: '(.+)'
label: 'Pool Search Pattern'
description: '(Optionnal) It is used to restrict provisioning to the specified volume groups or disk pools. Specify the value of this option as a regular expression which will be applied to the names of volume groups or disk pools from the storage backend which represent pools in Cinder'
description: '(Optional) This option is used to restrict provisioning to the specified volume groups or disk pools. Specify the value of this option as a regular expression which will be applied to the names of volume groups or disk pools from the storage backend which represent pools in Cinder'
weight: 61
type: 'text'
restrictions:
@ -268,8 +268,8 @@ attributes:
action: "hide"
use_multipath_for_image_xfer:
value: true
label: 'Multipath for Image Xfer'
description: '(Optionnal) Using this option will permit Cinder to use multiple paths for increased bandwidth. It affects Nova settings'
label: 'Multipath for Image Transfer'
description: '(Optional) If multipath has been enabled on your OpenStack hosts, then setting this option will permit Cinder to use multiple paths for increased bandwidth'
weight: 65
type: 'checkbox'
restrictions:
@ -280,7 +280,7 @@ attributes:
netapp_host_type:
value: 'linux'
label: 'Host Type'
description: '(Optionnal) This option defines the type of operating system for all initiators that can access a LUN'
description: '(Optional) This option defines the type of operating system for all initiators that can access a LUN'
weight: 62
type: 'text'
restrictions:
@ -289,7 +289,7 @@ attributes:
netapp_lun_ostype:
value: 'linux'
label: 'LUN OS type'
description: '(Optionnal) This option defines the type of operating system that will access a LUN exported from Data ONTAP'
description: '(Optional) This option defines the type of operating system that will access a LUN exported from Data ONTAP'
weight: 63
type: 'text'
restrictions:
@ -298,7 +298,7 @@ attributes:
netapp_lun_space_reservation:
value: true
label: 'LUN Space Reservation'
description: '(Optionnal) This option specifies whether space will be reserved when creating Cinder volumes on NetApp backends using the iSCSI protocol'
description: '(Optional) This option specifies whether space will be reserved when creating Cinder volumes on NetApp backends using the iSCSI protocol'
weight: 64
type: 'checkbox'
restrictions:
@ -309,12 +309,12 @@ attributes:
reserved_percentage:
value: '0'
label: 'Reserved Percentage'
description: '(Optionnal) This option represents the amount of total capacity of a storage pool that will be reserved and cannot be utilized for provisioning Cinder volumes'
description: '(Optional) This option represents the amount of total capacity of a storage pool that will be reserved and cannot be utilized for provisioning Cinder volumes'
weight: 71
type: 'text'
max_oversubscription_ratio:
value: '1.0'
label: 'Oversubscription Ratio'
description: '(Optionnal) This option is defined as a float, and specifies the amount of over-provisioning to allow when thin provisioning is being used in the storage pool. A value of 1.0 will mean that the provisioned capacity will not be able to exceed the total capacity, while larger values will result in increased levels of allowed over-provisioning'
description: '(Optional) This option specifies the amount of over-provisioning to allow when thin provisioning is used in the storage pool. A value of 1.0 will mean that the provisioned capacity will not be able to exceed the total capacity, while larger values will result in increased levels of over-provisioning'
weight: 72
type: 'text'

View File

@ -3,7 +3,7 @@ name: cinder_netapp
# Human-readable name for your plugin
title: Cinder and NetApp integration
# Plugin version
version: '4.0.0'
version: '4.1.0'
# Description
description: Enables using NetApp as a Cinder backend
# Required fuel version

View File

@ -20,7 +20,7 @@ Problem description
This integration should be supported with the upstream version of Fuel product. Mirantis Openstack 8.0 release has Pluggable Architecture feature, that prevents developers from bringing any changes to the core product. Instead, the NetApp integration functionality can be implemented as a plugin for Fuel.
The plugin support following storage famillies:
The plugin support following storage families:
- ONTAP with Cluster Mode and 7 Mode
- E-series
@ -167,7 +167,7 @@ Upgrading should be tested explicitly with this plugin installed and NetApp stor
Security impact
---------------
This plugin uses credentials that were used during NetApp cluster setup. No inpact on OpenStack services.
This plugin uses credentials that were used during NetApp cluster setup. No impact on OpenStack services.
Notifications impact
--------------------