glusterfs: Edit doc and comments
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
This commit is contained in:
parent
78ab3e078f
commit
4dbe429408
@ -32,12 +32,17 @@ Supported Operations
|
|||||||
- Create NFS Share
|
- Create NFS Share
|
||||||
- Delete NFS Share
|
- Delete NFS Share
|
||||||
- Allow NFS Share access
|
- Allow NFS Share access
|
||||||
|
|
||||||
|
* only 'rw' access
|
||||||
|
|
||||||
- Deny NFS Share access
|
- Deny NFS Share access
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
------------
|
------------
|
||||||
|
|
||||||
- Install glusterfs-server package, version >= 3.5.x, on the storage backend.
|
- 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
|
- Install glusterfs and glusterfs-fuse package, version >=3.5.x, on the Manila
|
||||||
host.
|
host.
|
||||||
- Establish network connection between the Manila host and the storage backend.
|
- Establish network connection between the Manila host and the storage backend.
|
||||||
@ -51,12 +56,17 @@ set:
|
|||||||
|
|
||||||
- `share_driver` = manila.share.drivers.glusterfs.GlusterfsShareDriver
|
- `share_driver` = manila.share.drivers.glusterfs.GlusterfsShareDriver
|
||||||
- If the backend GlusterFS server runs on the Manila host machine,
|
- If the backend GlusterFS server runs on the Manila host machine,
|
||||||
- `glusterfs_target` = <glustervolserver>:/<glustervolid>
|
|
||||||
|
* `glusterfs_target` = <glustervolserver>:/<glustervolid>
|
||||||
|
|
||||||
And if the backend GlusterFS server runs remotely,
|
And if the backend GlusterFS server runs remotely,
|
||||||
- `glusterfs_target` = <username>@<glustervolserver>:/<glustervolid>
|
|
||||||
|
* `glusterfs_target` = <username>@<glustervolserver>:/<glustervolid>
|
||||||
|
|
||||||
The following configuration parameters are optional:
|
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
|
- `glusterfs_mount_point_base` = <base path of GlusterFS volume mounted on
|
||||||
Manila host>
|
Manila host>
|
||||||
- `glusterfs_path_to_private_key` = <path to Manila host's private key file>
|
- `glusterfs_path_to_private_key` = <path to Manila host's private key file>
|
||||||
@ -66,14 +76,16 @@ The following configuration parameters are optional:
|
|||||||
Known Restrictions
|
Known Restrictions
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
- The driver does not support network segmented multi-tenancy model instead
|
- The driver does not support network segmented multi-tenancy model, but
|
||||||
works over a flat network, where the tenants share a network.
|
instead works over a flat network, where the tenants share a network.
|
||||||
- NFSv3 is the only protocol that can be used to access the shares. This is
|
- If NFS Ganesha is the NFS server used by the GlusterFS backend, then the
|
||||||
because the shares are mediated in the backend GlusterFS by the Gluster-NFS
|
shares can be accessed by NFSv3 and v4 protocols. However, if Gluster NFS is
|
||||||
server that supports only NFSv3 protocol.
|
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
|
- All Manila shares, which map to subdirectories within a GlusterFS volume, are
|
||||||
currently created within a single GlusterFS volume of a GlusterFS storage
|
currently created within a single GlusterFS volume of a GlusterFS storage
|
||||||
pool.
|
pool.
|
||||||
|
- The driver does not provide read-only access level for shares.
|
||||||
|
|
||||||
The :mod:`manila.share.drivers.glusterfs` Module
|
The :mod:`manila.share.drivers.glusterfs` Module
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -15,10 +15,11 @@
|
|||||||
|
|
||||||
"""Flat network GlusterFS Driver.
|
"""Flat network GlusterFS Driver.
|
||||||
|
|
||||||
Manila shares are subdirectories within a GlusterFS volume. The access to the
|
Manila shares are subdirectories within a GlusterFS volume. The backend,
|
||||||
shares is currently mediated by the Gluster-NFS server running in the GlusterFS
|
a GlusterFS cluster, uses one of the two NFS servers, Gluster-NFS or
|
||||||
backend storage pool. The Gluster-NFS server supports only NFSv3 protocol so
|
NFS-Ganesha, based on a configuration option, to mediate access to the shares.
|
||||||
it's the only protocol that can be used to access the shares.
|
NFS-Ganesha server supports NFSv3 and v4 protocols, while Gluster-NFS
|
||||||
|
server supports only NFSv3 protocol.
|
||||||
|
|
||||||
TODO(rraja): support SMB protocol.
|
TODO(rraja): support SMB protocol.
|
||||||
"""
|
"""
|
||||||
|
Loading…
Reference in New Issue
Block a user