cinder/doc/source/configuration/tables/cinder-ibm_gpfs_remote.rst
Jay S. Bryant 0395353c4b Move config-reference to configuration
It was discovered today that the 'config-reference' directory
was supposed to have been renamed to 'configuration'.  The doc
team was expecting it to be at that location so that they could
automatically link to it from contributor/index.html .

This patch just moves the directory.  I am going to be submitting
a subsequent patch that properly sets out the framework for the
additional directories so that we don't have addition problems
in the future.

Change-Id: I6729aaf4593a0b089277f6d7d0aa50fee3ca340f
2017-07-18 13:10:25 -05:00

3.0 KiB

Description of Spectrum Scale Remote volume driver configuration options
Configuration option = Default value Description
[DEFAULT]
gpfs_hosts = (List) Comma-separated list of IP address or hostnames of GPFS nodes.
gpfs_hosts_key_file = $state_path/ssh_known_hosts (String) File containing SSH host keys for the gpfs nodes with which driver needs to communicate. Default=$state_path/ssh_known_hosts
gpfs_images_dir = None (String) Specifies the path of the Image service repository in GPFS. Leave undefined if not storing images in GPFS.
gpfs_images_share_mode = None (String) Specifies the type of image copy to be used. Set this when the Image service repository also uses GPFS so that image files can be transferred efficiently from the Image service to the Block Storage service. There are two valid values: "copy" specifies that a full copy of the image is made; "copy_on_write" specifies that copy-on-write optimization strategy is used and unmodified blocks of the image file are shared efficiently.
gpfs_max_clone_depth = 0 (Integer) Specifies an upper limit on the number of indirections required to reach a specific block due to snapshots or clones. A lengthy chain of copy-on-write snapshots or clones can have a negative impact on performance, but improves space utilization. 0 indicates unlimited clone depth.
gpfs_mount_point_base = None (String) Specifies the path of the GPFS directory where Block Storage volume and snapshot files are stored.
gpfs_private_key = (String) Filename of private key to use for SSH authentication.
gpfs_sparse_volumes = True (Boolean) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time.
gpfs_ssh_port = 22 (Port number) SSH port to use.
gpfs_storage_pool = system (String) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used.
gpfs_strict_host_key_policy = False (Boolean) Option to enable strict gpfs host key checking while connecting to gpfs nodes. Default=False
gpfs_user_login = root (String) Username for GPFS nodes.
gpfs_user_password = (String) Password for GPFS node user.