Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

NetApp Back End Guide for the Shared File System Service

Red Hat OpenStack Platform 13

Deploying Multiple NetApp Back Ends for the Shared File System Service in a Red Hat OpenStack Platform Overcloud

OpenStack Documentation Team


This document describes how to configure and deploy the OpenStack Shared File System Service using a NetApp storage controller (running Data ONTAP) as a back end. The scenario described herein uses the `manila.share.drivers.netapp.common.NetAppDriver` in a custom environment file to enable the NetApp back end and allow it to provision and manage shared file system storage.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.

Chapter 1. Introduction

The OpenStack Shared File Systems service (manila) enables users to provision shared file systems that can be consumed by multiple compute instances.

This release supports the use of the NetApp unified driver (manila.share.drivers.netapp.common.NetAppDriver). This driver allows the Shared File System service to use NetApp storage controllers (running Data ONTAP) as a back end.

The recommended method for configuring a Shared File System back end is through the director. Doing so involves writing a custom environment file.

Chapter 2. Requirements

The following sections assume that:

  • A NetApp storage controller is deployed and ready to be used as a back end.
  • You intend to use only one NetApp storage controller as a back end for your Shared File System service.
  • You can use the director installation user account, which is created as part of the overcloud deployment. For more information, see Creating the stack user in the Director Installation and Usage guide.
  • The Shared File System service will still be installed on the Controller nodes, as is the default behavior.

This document does discuss the different deployment configurations possible for your NetApp back end. To learn more about possible NetApp storage deployment configurations suitable for the Shared File System service, consult the upstream NetApp documentation (in particular, see Theory of Operation and Deployment Choices).

After mapping your target configuration (the settings you want for each NetApp back end), you can translate your configuration to a custom environment file. The director uses this file to orchestrate the configuration of your back ends and makes them persistent across overcloud updates.

Chapter 3. Create the Environment File

The director already includes Heat templates to configure most of the necessary settings to integrate a NetApp back end. An environment file allows you to define settings specific to your deployment.

To start, log in as the stack user on the undercloud and create an environment file with the following contents:


  ManilaNetappLogin: 'NETAPP_USER'  # 1
  ManilaNetappPassword: 'NETAPP_USER_PASSWORD'
  ManilaNetappServerHostname: 'HOSTNAME' # 2
  ManilaNetappVserver: 'SVM' # 3
  ManilaNetappRootVolumeAggr: 'ROOTVAGGR' # 4
  ManilaNetappTraceFlags: 'TRFLAGS' # 5
  ManilaNetappDriverHandlesShareServers: 'false' # 6

Replace NETAPP_USER and NETAPP_USER_PASSWORD with the credentials of the administrative account used to access the storage system (specifically, HOSTNAME).
Replace HOSTNAME with the storage system or proxy server. The value of this option should be the IP address or hostname of either the cluster management logical interface (LIF) or Storage Virtual Machine (SVM) LIF.
SVM specifies the storage virtual machine (previously called a vserver) name on the storage cluster on which provisioning of shared file systems should occur. This parameter is required if the driver should operate without managing share servers (that is, be limited to the scope of a single SVM).
ROOTVAGGR specifies the name of the aggregate upon which the root volume should be placed when a new storage virtual machine (SVM) is created to correspond to a manila share server. This parameter is required if the value of ManilaNetappDriverHandlesShareServers is set to true, which means the driver manages the life cycle of share servers. This value is not required if the value of ManilaNetappDriverHandlesShareServers is `false`.
Replace TRFLAGS with a comma-separated list of options that control which trace info is written to the Shared File System service logs when the debug level is set to True. Supported values include method and api.
The ManilaNetappDriverHandlesShareServers parameter sets whether the driver should handle the lifecycle of the share server (false means it should not).

For example:


   ManilaNetappLogin: 'netapp_user'
   ManilaNetappPassword: 'netapp_user_password'
   ManilaNetappServerHostname: ''
   ManilaNetappVserver: 'vserver_1'
   ManilaNetappTraceFlags: 'method,api'
   ManilaNetappDriverHandlesShareServers: 'false'

The next section describes how to use the /home/stack/templates/netapp-config.yaml environment file to orchestrate the configuration of your NetApp back end.

Chapter 4. Deploy the Shared File System Service with NetApp Back Ends

After you create /home/stack/templates/netapp-config.yaml, log in as the stack user on the undercloud and deploy the configured back end by running:

$ source ~/stackrc
$ openstack overcloud deploy --templates -e /usr/share/openstack-tripleo-heat-templates/environments/manila-netapp-config.yaml -e /home/stack/templates/netapp-config.yaml

The /usr/share/openstack-tripleo-heat-templates/environments/manila-netapp-config.yaml used here is the environment file provided with the director for deploying NetApp back ends for the Shared File System service. The /home/stack/templates/netapp-config.yaml file created in the previous section allows you to override the default settings to suit your deployment.


If you passed any extra environment files when you created the overcloud, pass them again here by using the -e option to avoid making undesired changes to the overcloud. For more information, see Modifying the Overcloud Environment in the Director Installation and Usage guide.

Chapter 5. Create a Basic Share Type

Whenever you create a new share, you must specify a share type. If you don’t specify one, the share creation will fail.

Director does not support automatically configuring or creating the default share type during installation. However, director does set the manila.conf configuration option default_share_type to default. Deployers must create the default share type after the overcloud has been deployed.

To create a basic share type named default, run the following as the stack user on the undercloud:

$ source ~/overcloudrc
$ manila type-create default false

In the example, manila type-create default is false because there is no need for the NetApp driver to handle the life cycle of share servers. This is because we set ManilaNetappDriverHandlesShareServers to false in Chapter 3, Create the Environment File. Otherwise, if ManilaNetappDriverHandlesShareServers is set to true you can match the default share type to this. For more information about share types, see Creating and Managing Share Types in the Storage Guide.

Legal Notice

Copyright © 2023 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.