manila/doc/source/admin/gpfs_driver.rst
Tom Barron 5af3b8e68b Remove deprecated config and auth
Remove manila configuration options
and auth classes that were deprecated
before the Ussuri release.

Change-Id: I148225926cd249a0dd8d1f8c02b22ed06487f405
2021-04-26 11:53:58 -04:00

3.4 KiB

GPFS Driver

GPFS driver uses IBM General Parallel File System (GPFS), a high-performance, clustered file system, developed by IBM, as the storage backend for serving file shares to the manila clients.

Supported shared filesystems

  • NFS (access by IP)

Supported Operations

  • Create NFS Share
  • Delete NFS Share
  • Create Share Snapshot
  • Delete Share Snapshot
  • Create Share from a Share Snapshot
  • Allow NFS Share access
    • Currently only 'rw' access level is supported
  • Deny NFS Share access

Requirements

  • Install GPFS with server license, version >= 2.0, on the storage backend.
  • Install Kernel NFS or Ganesha NFS server on the storage backend servers.
  • If using Ganesha NFS, currently NFS Ganesha v1.5 and v2.0 are supported.
  • Create a GPFS cluster and create a filesystem on the cluster, that will be used to create the manila shares.
  • Enable quotas for the GPFS file system (mmchfs -Q yes).
  • Establish network connection between the manila host and the storage backend.

Manila driver configuration setting

The following parameters in the manila configuration file need to be set:

  • share_driver = manila.share.drivers.ibm.gpfs.GPFSShareDriver
  • gpfs_share_export_ip = <IP to be added to GPFS export string>
  • If the backend GPFS server is not running on the manila host machine, the following options are required to SSH to the remote GPFS backend server:
    • gpfs_ssh_login = <GPFS server SSH login name>

      and one of the following settings is required to execute commands over SSH:

    • gpfs_ssh_private_key = <path to GPFS server SSH private key for login>

    • gpfs_ssh_password = <GPFS server SSH login password>

The following configuration parameters are optional:

  • gpfs_mount_point_base = <base folder where exported shares are located>
  • gpfs_nfs_server_type = <KNFS|GNFS>
  • gpfs_nfs_server_list = <list of the fully qualified NFS server names>
  • gpfs_ssh_port = <ssh port number>

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

Known Restrictions

  • The driver does not support a segmented-network multi-tenancy model but instead works over a flat network where the tenants share a network.
  • While using remote GPFS node, with Ganesha NFS, 'gpfs_ssh_private_key' for remote login to the GPFS node must be specified and there must be a passwordless authentication already setup between the manila share service and the remote GPFS node.

The manila.share.drivers.ibm.gpfs Module

manila.share.drivers.ibm.gpfs