Deploying NetApp ONTAP Cinder driver in a Red Hat OpenStack Platform 16

updated: 2024-10-11 11:24
Contents

Deploying NetApp ONTAP Cinder driver in a Red Hat OpenStack Platform 16

Overview

This guide shows how to configure and deploy NetApp ONTAP Cinder driver in a Red Hat OpenStack Platform (RHOSP) 16 Overcloud, using RHOSP Director. After reading this, you’ll be able to define the proper environment files and deploy single or multiple ONTAP Cinder back ends in RHOSP Overcloud Controller nodes.

Note

For more information about RHOSP, please refer to its documentation pages.

Warning

RHOSP16 is based on OpenStack Train release. Features included after Train release are not available in RHOSP16.

Requirements

In order to deploy NetApp Cinder back ends, you should have the following requirements satisfied:

  • NetApp ONTAP storage controllers deployed and ready to be used as Cinder back ends. See ONTAP Configuration for more details.

  • RHOSP Director user credentials to deploy Overcloud.

  • RHOSP Overcloud Controller nodes where Cinder services will be installed.

Deployment Steps

Prepare the environment files

RHOSP makes use of TripleO Heat Templates (THT), which allows you to define the Overcloud resources by creating environment files.

Single back end configuration

To configure a single NetApp Cinder back end, define an environment file as in the following example:

  • /home/stack/templates/cinder-netapp-nfs-backend1.yaml

    resource_registry:
  OS::TripleO::Services::CinderBackendNetApp: /usr/share/openstack-tripleo-heat-templates/deployment/cinder/cinder-backend-netapp-puppet.yaml

parameter_defaults:
  CinderEnableNetappBackend: true
  CinderNetappBackendName: 'tripleo_netapp_nfs_1'
  CinderNetappLogin: 'admin_username'
  CinderNetappPassword: 'admin_password'
  CinderNetappServerHostname: 'hostname'
  CinderNetappServerPort: '80'
  CinderNetappStorageFamily: 'ontap_cluster'
  CinderNetappStorageProtocol: 'nfs'
  CinderNetappTransportType: 'http'
  CinderNetappVserver: 'vserver_name'
  CinderNetappNfsShares: 'lif1_ip:/flexvol_1,lif2_ip:/flexvol_1'
  CinderNetappNfsSharesConfig: '/etc/cinder/nfs_shares'
  CinderNetappNfsMountOptions: ''

    Refer the following example for iSCSI/FC backend:

  • /home/stack/templates/cinder-netapp-fc-backend1.yaml

    resource_registry:
  OS::TripleO::Services::CinderBackendNetApp: /usr/share/openstack-tripleo-heat-templates/deployment/cinder/cinder-backend-netapp-puppet.yaml

parameter_defaults:
  CinderEnableNetappBackend: true
  CinderNetappBackendName: 'tripleo_netapp_fc_1'
  CinderNetappLogin: 'admin_username'
  CinderNetappPassword: 'admin_password'
  CinderNetappStorageProtocol: 'fc'
  #Set above protocol to iscsi in case of iscsi backend
  CinderNetappServerHostname: 'hostname'
  CinderNetappServerPort: '80'
  CinderNetappStorageFamily: 'ontap_cluster'
  CinderNetappTransportType: 'http'
  CinderNetappVserver: 'vserver_name'

    Modify the parameter values according to your NetApp ONTAP back end configuration.

Note

Most THT Configuration Parameters correspond to a Cinder Configuration Option. See Table 8.1, “NetApp Cinder THT Configuration Parameters” for a complete list of the THT Configuration Parameters and their correspondence to Cinder Configuration Options.

Note

There are some Cinder Configuration Options that have no correspondent THT Configuration Parameter. If you need to set such options, you can define Custom Configuration Parameters.

You can define arbitrary Custom Configurations using the following syntax:

parameter_defaults:
  ControllerExtraConfig:
    cinder::config::cinder_config:
      <backend_name>/<configuration_name>:
        value: <value>

Each configuration will be rendered in cinder.conf file as:

[backend_name]
configuration_name=value

See Configuration options for ONTAP with NFS (Train) and Configuration options for ONTAP with iSCSI (Train) for a complete list of the available Cinder Configuration Options.

Warning

RHOSP16 is based on OpenStack Train release. Features and Configuration Options included after Train release are not available in RHOSP16.

Most THT Configuration Parameters correspond to a Cinder Configuration Option. The following table maps each THT Configuration Parameter to the corresponding Cinder Configuration Option:

THT Parameter Name

Cinder Configuration Option

Required/Optional

Description

CinderNetappBackendName

volume_backend_name

Required

The name used by Cinder to refer to the Cinder backend.

CinderNetappLogin

netapp_login

Required

Administrative user account name used to access the storage system.

CinderNetappPassword

netapp_password

Required

Password for the administrative user account specified in the netapp_login option.

CinderNetappServerHostname

netapp_server_hostname

Required

The hostname or IP address for the storage system or proxy server. The value of this option should be the IP address of the cluster management LIF.

CinderNetappServerPort

netapp_server_port

Optional

The TCP port to use for communication with the storage system or proxy server. If not specified, ONTAP drivers will use 80 for HTTP and 443 for HTTPS.

CinderNetappStorageFamily

netapp_storage_family

Required

The storage family type used on the storage system; valid values are ontap_cluster for ONTAP.

CinderNetappStorageProtocol

netapp_storage_protocol

Required

The storage protocol to be used. Valid options are nfs, iscsi, or fc.

CinderNetappTransportType

netapp_transport_type

Required

Transport protocol for communicating with the storage system or proxy server. Valid options include http and https.

CinderNetappVserver

netapp_vserver

Required

This option specifies the storage virtual machine (previously called a Vserver) name on the storage cluster on which provisioning of block storage volumes should occur.

CinderNetappNfsSharesConfig

nfs_shares_config

Optional

The file referenced by this configuration option will contain a list of NFS shares specified by CinderNetappNfsShares THT Parameter, each on their own line, to which the driver should attempt to provision new Cinder volumes into.

CinderNetappNfsMountOptions

nfs_mount_options

Optional

For NFS protocol only. Mount options passed to the nfs client. See section of the nfs man page for details.

CinderNetappCopyOffloadToolPath

netapp_copyoffload_tool_path

Optional

For NFS protocol only. This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file.

CinderNetappNasSecureFileOperations

nas_secure_file_operations

Optional

For NFS protocol only. If ‘false’, operations on the backing files run as root; if ‘true’, operations on the backing files for cinder volumes run unprivileged, as the cinder user, and are allowed to succeed even when root is squashed. If ‘auto’ and there are existing Cinder volumes, value will be set to ‘false’ (for backwards compatibility); if ‘auto’ and there are no existing Cinder volumes, the value will be set to ‘true’. Default is ‘auto’.

CinderNetappNasSecureFilePermissions

nas_secure_file_permissions

Optional

For NFS protocol only. If ‘false’, backing files for cinder volumes are readable by owner, group, and world; if ‘true’, only by owner and group. If ‘auto’ and there are existing Cinder volumes, value will be set to ‘false’ (for backwards compatibility); if ‘auto’ and there are no existing Cinder volumes, the value will be set to ‘true’. Default is ‘auto’.

CinderNetappHostType

netapp_host_type

Optional

This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts. Default is ‘linux’.

CinderNetappPoolNameSearchPattern

netapp_pool_name_search_pattern

Optional

This option is only utilized when the Cinder driver is configured to use iSCSI off Fibre Channel. It is used to restrict provisioning to the specified FlexVol volumes. Specify the value of this option as a regular expression which will be applied to the names of FlexVol volumes from the storage backend which represent pools in Cinder. ^ (beginning of string) and $ (end of string) are implicitly wrapped around the regular expression specified before filtering. Default is (.+).

CinderNetappAvailabilityZone

backend_availability_zone

Optional

Availability zone for this volume backend. If not set, the storage_availability_zone option value is used as the default for all backends.

Table 8.1. NetApp Cinder THT Configuration Parameters

Multiple back end configuration

THT has no templates for configuring multiple NetApp Cinder back ends. In order to configure multiple NetApp Cinder back ends, you need to define the first back end with THT, and the additional back ends with Custom Configurations.

It’s possible to define all the back ends in a single environment file, but for sake of clarity, the following example organizes the back ends in multiple smaller environment files:

  • /home/stack/templates/cinder-netapp-nfs-backend1.yaml

    This file defines the first Cinder volume back end tripleo_netapp_nfs_1 and its parameters. The definition of the first back end is the same for both single and multiple back end configuration:

    resource_registry:
  OS::TripleO::Services::CinderBackendNetApp: /usr/share/openstack-tripleo-heat-templates/deployment/cinder/cinder-backend-netapp-puppet.yaml

parameter_defaults:
  CinderEnableNetappBackend: true
  CinderNetappBackendName: 'tripleo_netapp_nfs_1'
  CinderNetappLogin: 'admin_username'
  CinderNetappPassword: 'admin_password'
  CinderNetappServerHostname: 'hostname'
  CinderNetappServerPort: '80'
  CinderNetappStorageFamily: 'ontap_cluster'
  CinderNetappStorageProtocol: 'nfs'
  CinderNetappTransportType: 'http'
  CinderNetappVserver: 'vserver_name'
  CinderNetappNfsShares: 'lif1_ip:/flexvol_1,lif2_ip:/flexvol_1'
  CinderNetappNfsSharesConfig: '/etc/cinder/nfs_shares'
  CinderNetappNfsMountOptions: ''

    Modify the parameter values according to your NetApp ONTAP back end configuration.

  • /home/stack/templates/cinder-netapp-nfs-backend2.yaml

    parameter_defaults:
  ControllerExtraConfig:
    cinder::config::cinder_config:
      tripleo_netapp_nfs_2/volume_backend_name:
        value: tripleo_netapp_nfs_2
      tripleo_netapp_nfs_2/volume_driver:
        value: cinder.volume.drivers.netapp.common.NetAppDriver
      tripleo_netapp_nfs_2/netapp_login:
        value: admin_username
      tripleo_netapp_nfs_2/netapp_password:
        value: admin_password
      tripleo_netapp_nfs_2/netapp_server_hostname:
        value: hostname
      tripleo_netapp_nfs_2/netapp_server_port:
        value: 80
      tripleo_netapp_nfs_2/netapp_transport_type:
        value: http
      tripleo_netapp_nfs_2/netapp_vserver:
        value: vserver_name
      tripleo_netapp_nfs_2/netapp_storage_protocol:
        value: nfs
      tripleo_netapp_nfs_2/nfs_shares_config:
        value: '/etc/cinder/nfs_shares'
      tripleo_netapp_nfs_2/netapp_storage_family:
        value: ontap_cluster

    Modify the parameter values according to your NetApp ONTAP back end configuration.

  • /home/stack/templates/cinder-netapp-iscsi-backend1.yaml

    This file defines the second Cinder volume back end tripleo_netapp_iscsi_1 and its parameters:

    parameter_defaults:
  ControllerExtraConfig:
    cinder::config::cinder_config:
      tripleo_netapp_iscsi_1/volume_backend_name:
        value: tripleo_netapp_iscsi_1
      tripleo_netapp_iscsi_1/volume_driver:
        value: cinder.volume.drivers.netapp.common.NetAppDriver
      tripleo_netapp_iscsi_1/netapp_login:
        value: admin_username
      tripleo_netapp_iscsi_1/netapp_password:
        value: admin_password
      tripleo_netapp_iscsi_1/netapp_server_hostname:
        value: hostname
      tripleo_netapp_iscsi_1/netapp_server_port:
        value: 80
      tripleo_netapp_iscsi_1/netapp_transport_type:
        value: http
      tripleo_netapp_iscsi_1/netapp_vserver:
        value: vserver_name
      tripleo_netapp_iscsi_1/netapp_storage_protocol:
        value: iscsi
      tripleo_netapp_iscsi_1/netapp_storage_family:
        value: ontap_cluster

  • /home/stack/templates/cinder-netapp-fc-backend1.yaml

    This file defines the third Cinder volume back end tripleo_netapp_fc_1 and its parameters:

    parameter_defaults:
  ControllerExtraConfig:
    cinder::config::cinder_config:
      tripleo_netapp_fc_1/volume_backend_name:
        value: tripleo_netapp_fc_1
      tripleo_netapp_fc_1/volume_driver:
        value: cinder.volume.drivers.netapp.common.NetAppDriver
      tripleo_netapp_fc_1/netapp_login:
        value: admin_username
      tripleo_netapp_fc_1/netapp_password:
        value: admin_password
      tripleo_netapp_fc_1/netapp_server_hostname:
        value: hostname
      tripleo_netapp_fc_1/netapp_server_port:
        value: 80
      tripleo_netapp_fc_1/netapp_transport_type:
        value: http
      tripleo_netapp_fc_1/netapp_vserver:
        value: vserver_name
      tripleo_netapp_fc_1/netapp_storage_protocol:
        value: fc
      tripleo_netapp_fc_1/netapp_storage_family:
        value: ontap_cluster

  • /home/stack/templates/cinder-enabled-backends.yaml

    This file defines which additional back ends will be enabled. In this example, the additional back ends tripleo_netapp_nfs_2 and tripleo_netapp_iscsi_1 and tripleo_netapp_fc_1 will be enabled:

    parameter_defaults:
  ControllerExtraConfig:
    cinder_user_enabled_backends:
      - 'tripleo_netapp_nfs_2'
      - 'tripleo_netapp_iscsi_1'
      - 'tripleo_netapp_fc_1'

    Note

    The first back end tripleo_netapp_nfs_1 was defined using NetApp THT resource registry, and therefore doesn’t need to be added to cinder_user_enabled_backends.

Deploy Overcloud

Now that you have the Cinder back end environment files defined, you can run the command to deploy RHOSP Overcloud. Run the following command as stack user in the RHOSP Director command line, specifying the YAML file(s) you defined:

 (undercloud) [stack@rhosp16-undercloud ~]$ openstack overcloud deploy \
 --templates \
 -e /home/stack/containers-prepare-parameter.yaml \
 -e /home/stack/templates/cinder-netapp-nfs-backend1.yaml \
 -e /home/stack/templates/cinder-netapp-nfs-backend2.yaml \
 -e /home/stack/templates/cinder-netapp-iscsi-backend1.yaml \
 -e /home/stack/templates/cinder-netapp-fc-backend1.yaml \
 -e /home/stack/templates/cinder-enabled-backends.yaml \
 --stack overcloud

Note

Alternatively, you can use --environment-directory parameter and specify the whole directory to the deployment command. It will consider all the YAML files within this directory:

 (undercloud) [stack@rhosp16-undercloud ~]$ openstack overcloud deploy \
 --templates \
 -e /home/stack/containers-prepare-parameter.yaml \
 --environment-directory /home/stack/templates \
 --stack overcloud

Test the Deployed Back Ends

After RHOSP Overcloud is deployed, run the following command to check if the Cinder services are up:

[stack@rhosp16-undercloud ~]$ source ~/overcloudrc
(overcloud) [stack@rhosp16-undercloud ~]$ cinder service-list

Run the following commands as stack user in the RHOSP Director command line to create the volume types mapped to the deployed back ends:

[stack@rhosp16-undercloud ~]$ source ~/overcloudrc
(overcloud) [stack@rhosp16-undercloud ~]$ cinder type-create tripleo_netapp_nfs_1
(overcloud) [stack@rhosp16-undercloud ~]$ cinder type-key tripleo_netapp_nfs_1 set volume_backend_name=tripleo_netapp_nfs_1
(overcloud) [stack@rhosp16-undercloud ~]$ cinder type-create tripleo_netapp_nfs_2
(overcloud) [stack@rhosp16-undercloud ~]$ cinder type-key tripleo_netapp_nfs_2 set volume_backend_name=tripleo_netapp_nfs_2
(overcloud) [stack@rhosp16-undercloud ~]$ cinder type-create tripleo_netapp_iscsi_1
(overcloud) [stack@rhosp16-undercloud ~]$ cinder type-key tripleo_netapp_iscsi_1 set volume_backend_name=tripleo_netapp_iscsi_1
(overcloud) [stack@rhosp16-undercloud ~]$ cinder type-create tripleo_netapp_fc_1
(overcloud) [stack@rhosp16-undercloud ~]$ cinder type-key tripleo_netapp_fc_1 set volume_backend_name=tripleo_netapp_fc_1

Make sure that you’re able to create Cinder volumes with the configured volume types:

[stack@rhosp16-undercloud ~]$ source ~/overcloudrc
(overcloud) [stack@rhosp16-undercloud ~]$ cinder create --volume-type tripleo_netapp_nfs_1 --name v1 1
(overcloud) [stack@rhosp16-undercloud ~]$ cinder create --volume-type tripleo_netapp_nfs_2 --name v2 1
(overcloud) [stack@rhosp16-undercloud ~]$ cinder create --volume-type tripleo_netapp_iscsi_1 --name v3 1
(overcloud) [stack@rhosp16-undercloud ~]$ cinder create --volume-type tripleo_netapp_fc_1 --name v4 1
updated: 2024-10-11 11:24

This document is licensed under Apache 2.0 license.

found an error? report a bug questions?