4dbe429408
Edit doc and comments to mention that the driver - can work with NFS-Ganesha, used by the GlusterFS backend to serve NFS shares. - does not provide read-only access level for shares. And add some minor cosmetic fixes to the doc. Change-Id: Ib0e53befbd48e5cbfea98a52876f381384beb268
98 lines
3.2 KiB
ReStructuredText
98 lines
3.2 KiB
ReStructuredText
..
|
|
Copyright 2015 Red Hat, Inc.
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
GlusterFS driver
|
|
================
|
|
|
|
GlusterFS driver uses GlusterFS, an open source distributed file system,
|
|
as the storage backend for serving file shares to Manila clients.
|
|
|
|
Supported shared filesystems
|
|
----------------------------
|
|
|
|
- NFS (access by IP)
|
|
|
|
|
|
Supported Operations
|
|
--------------------
|
|
|
|
- Create NFS Share
|
|
- Delete NFS Share
|
|
- Allow NFS Share access
|
|
|
|
* only 'rw' access
|
|
|
|
- Deny NFS Share access
|
|
|
|
Requirements
|
|
------------
|
|
|
|
- Install glusterfs-server package, version >= 3.5.x, on the storage backend.
|
|
- Install NFS-Ganesha, version >=2.1, if using NFS-Ganesha as the NFS server
|
|
for the GlusterFS backend.
|
|
- Install glusterfs and glusterfs-fuse package, version >=3.5.x, on the Manila
|
|
host.
|
|
- Establish network connection between the Manila host and the storage backend.
|
|
|
|
|
|
Manila driver configuration setting
|
|
-----------------------------------
|
|
|
|
The following parameters in the Manila's configuration file need to be
|
|
set:
|
|
|
|
- `share_driver` = manila.share.drivers.glusterfs.GlusterfsShareDriver
|
|
- If the backend GlusterFS server runs on the Manila host machine,
|
|
|
|
* `glusterfs_target` = <glustervolserver>:/<glustervolid>
|
|
|
|
And if the backend GlusterFS server runs remotely,
|
|
|
|
* `glusterfs_target` = <username>@<glustervolserver>:/<glustervolid>
|
|
|
|
The following configuration parameters are optional:
|
|
|
|
- `glusterfs_nfs_server_type` = <NFS server type used by the GlusterFS
|
|
backend, `Gluster` or `Ganesha`. `Gluster` is the default type>
|
|
- `glusterfs_mount_point_base` = <base path of GlusterFS volume mounted on
|
|
Manila host>
|
|
- `glusterfs_path_to_private_key` = <path to Manila host's private key file>
|
|
- `glusterfs_server_password` = <password of remote GlusterFS server machine>
|
|
|
|
|
|
Known Restrictions
|
|
------------------
|
|
|
|
- The driver does not support network segmented multi-tenancy model, but
|
|
instead works over a flat network, where the tenants share a network.
|
|
- If NFS Ganesha is the NFS server used by the GlusterFS backend, then the
|
|
shares can be accessed by NFSv3 and v4 protocols. However, if Gluster NFS is
|
|
used by the GlusterFS backend, then the shares can only be accessed by NFSv3
|
|
protocol.
|
|
- All Manila shares, which map to subdirectories within a GlusterFS volume, are
|
|
currently created within a single GlusterFS volume of a GlusterFS storage
|
|
pool.
|
|
- The driver does not provide read-only access level for shares.
|
|
|
|
The :mod:`manila.share.drivers.glusterfs` Module
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. automodule:: manila.share.drivers.glusterfs
|
|
:noindex:
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|