Unity Driver

Unity Driver

EMC manila driver framework (EMCShareDriver) utilizes the EMC storage products to provide the shared filesystems to OpenStack. The EMC manila driver is a plugin based driver which is designed to use different plugins to manage different EMC storage products.

Unity plugin is the plugin which manages the Unity Storage System to provide shared filesystems. EMC driver framework with Unity plugin is referred to as Unity driver in this document.

This driver performs the operations on Unity by REST API. Each backend manages one Unity Storage System. Multiple manila backends need to be configured to manage multiple Unity Storage Systems.

Requirements

  • Unity OE 4.0.1 or higher.
  • StorOps 0.2.17 or higher is installed on Manila node.
  • Following licenses are activated on Unity:
    • CIFS/SMB Support
    • Network File System (NFS)
    • Thin Provisioning
    • Fiber Channel (FC)
    • Internet Small Computer System Interface (iSCSI)

Supported Operations

In detail, users are allowed to do following operation with EMC Unity Storage Systems.

  • Create/delete a NFS share.
  • Create/delete a CIFS share.
  • Extend the size of a share.
  • Modify the host access privilege of a NFS share.
  • Modify the user access privilege of a CIFS share.
  • Take/Delete snapshot of a share.
  • Create a new share from snapshot.

Supported Network Topologies

  • flat
  • VLAN

Pre-Configurations

On Manila Node

StorOps library is required to run Unity driver. Please install it with the pip command. You may need root privilege to install python libraries.

pip install storops

On Unity System

  1. Configure System level NTP Server

Configure the NTP server for your Unity at:

Unisphere -> Settings -> Management -> System Time and NTP

Select “Enable NTP synchronization” and add your NTP server(s).

  1. Configure System level DNS Server

Configure the DNS server for your Unity at:

Unisphere -> Settings -> Management -> DNS Server

Select “Configure DNS server address manually” and add your DNS server(s).

Configurations

Following configurations need to be configured in /etc/manila/manila.conf for the Unity driver.

share_driver = manila.share.drivers.dell_emc.driver.EMCShareDriver
emc_share_backend = unity
emc_nas_server = <management IP address of the Unity system>
emc_nas_login = <user with administrator privilege>
emc_nas_password = <password>
emc_nas_server_container = [SPA|SPB]
emc_nas_pool_names = <Comma separated pool names>
emc_interface_ports = <Comma separated ports list>
  • emc_share_backend is the plugin name. Set it to unity for the Unity driver.
  • emc_nas_server is the management IP for Unity.
  • emc_nas_server_container is the SP that will be used as share server.
  • emc_nas_pool_names is the name of the pools to be used by this backend. If no name is specified, all storage pools on the system will be managed. Wild card character is supported. Examples: pool_1, pool_*, *
  • emc_interface_ports is the white list of the ports to be used for connection. Wild card character is supported. Examples: spa_eth1, spa_*, *

Restart of manila-share service is needed for the configuration changes to take effect.

Restrictions

The Unity driver has following restrictions.

  • EMC Unity does not support the same IP in different VLANs.
  • Only IP access type is supported for NFS.
  • Only user access type is supported for CIFS.

API Implementations

Following driver features are implemented in the plugin.

  • create_share: Create a share and export it based on the protocol used (NFS or CIFS).
  • create_share_from_snapshot: Create a share from a snapshot - clone a snapshot.
  • delete_share: Delete a share.
  • extend_share: Extend the maximum size of a share.
  • create_snapshot: Create a snapshot for the specified share.
  • delete_snapshot: Delete the snapshot of the share.
  • update_access: recover, add or delete user/host access to a share.
  • allow_access: Allow access (read write/read only) of a user to a CIFS share. Allow access (read write/read only) of a host to a NFS share.
  • deny_access: Remove access (read write/read only) of a user from a CIFS share. Remove access (read write/read only) of a host from a NFS share.
  • ensure_share: Check whether share exists or not.
  • update_share_stats: Retrieve share related statistics from Unity.
  • get_network_allocations_number: Returns number of network allocations for creating VIFs.
  • setup_server: Set up and configures share server with given network parameters.
  • teardown_server: Tear down the share server.

The manila.share.drivers.dell_emc.driver Module

EMC specific NAS storage driver. This driver is a pluggable driver that allows specific EMC NAS devices to be plugged-in as the underlying backend. Use the Manila configuration variable “share_backend_name” to specify, which backend plugins to use.

class EMCShareDriver(*args, **kwargs)

Bases: manila.share.driver.ShareDriver

EMC specific NAS driver. Allows for NFS and CIFS NAS storage usage.

allow_access(context, share, access, share_server=None)

Allow access to the share.

check_for_setup_error()

Check for setup error.

create_share(context, share, share_server=None)

Is called to create share.

create_share_from_snapshot(context, share, snapshot, share_server=None)

Is called to create share from snapshot.

create_snapshot(context, snapshot, share_server=None)

Is called to create snapshot.

delete_share(context, share, share_server=None)

Is called to remove share.

delete_snapshot(context, snapshot, share_server=None)

Is called to remove snapshot.

deny_access(context, share, access, share_server=None)

Deny access to the share.

do_setup(context)

Any initialization the share driver does while starting.

ensure_share(context, share, share_server=None)

Invoked to sure that share is exported.

extend_share(share, new_size, share_server=None)

Is called to extend share.

get_network_allocations_number()

Returns number of network allocations for creating VIFs.

update_access(context, share, access_rules, add_rules, delete_rules, share_server=None)

Update access to the share.

The manila.share.drivers.dell_emc.plugins.unity.connection Module

Unity backend for the EMC Manila driver.

class UnityStorageConnection(*args, **kwargs)

Bases: manila.share.drivers.dell_emc.plugins.base.StorageConnection

Implements Unity specific functionality for EMC Manila driver.

IP_ALLOCATIONS = 1
allow_access(context, share, access, share_server=None)

Allow access to a share.

check_for_setup_error()

Check for setup error.

clear_access(share, white_list=None)
connect(emc_share_driver, context)

Connect to Unity storage.

create_share(context, share, share_server=None)

Create a share and export it based on protocol used.

create_share_from_snapshot(context, share, snapshot, share_server=None)

Create a share from a snapshot - clone a snapshot.

create_snapshot(context, snapshot, share_server=None)

Create snapshot from share.

delete_share(context, share, share_server=None)

Delete a share.

delete_snapshot(context, snapshot, share_server=None)

Delete a snapshot.

deny_access(context, share, access, share_server)

Deny access to a share.

ensure_share(context, share, share_server)

Ensure that the share is exported.

extend_share(share, new_size, share_server=None)
get_network_allocations_number()

Returns number of network allocations for creating VIFs.

get_pool(share)

Get the pool name of the share.

setup_server(network_info, metadata=None)

Set up and configures share server with given network parameters.

teardown_server(server_details, security_services=None)

Teardown share server.

update_access(context, share, access_rules, add_rules, delete_rules, share_server=None)
update_share_stats(stats_dict)

Communicate with EMCNASClient to get the stats.

static validate_network(network_info)
validate_port_configuration(port_ids_conf)

Initializes the SP and ports based on the port option.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.