openstack
/
glance_store
Code Issues Proposed changes

Merge "Improve the help text for vmware datastore driver opts"

This commit is contained in:
Jenkins 2016-08-04 23:53:19 +00:00 committed by Gerrit Code Review
parent 51f86dbe81 2a60cdf6e5
commit a4d1085216
1 changed files with 164 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

198
glance_store/_drivers/vmware_datastore.py
View File

@ -61,54 +61,184 @@ STORE_SCHEME = 'vsphere'
_VMWARE_OPTS = [
cfg.StrOpt('vmware_server_host',
help=_('ESX/ESXi or vCenter Server target system. '
'The server value can be an IP address or a DNS name.')),
sample_default='127.0.0.1',
help=_("""
Address of the ESX/ESXi or vCenter Server target system.
This configuration option sets the address of the ESX/ESXi or vCenter
Server target system. This option is required when using the VMware
storage backend. The address can contain an IP address (127.0.0.1) or
a DNS name (www.my-domain.com).
Possible Values:
* A valid IPv4 or IPv6 address
* A valid DNS name
Related options:
* vmware_server_username
* vmware_server_password
""")),
cfg.StrOpt('vmware_server_username',
help=_('Username for authenticating with '
'VMware ESX/VC server.')),
sample_default='root',
help=_("""
Server username.
This configuration option takes the username for authenticating with
the VMware ESX/ESXi or vCenter Server. This option is required when
using the VMware storage backend.
Possible Values:
* Any string that is the username for a user with appropriate
privileges
Related options:
* vmware_server_host
* vmware_server_password
""")),
cfg.StrOpt('vmware_server_password',
help=_('Password for authenticating with '
'VMware ESX/VC server.'),
sample_default='vmware',
help=_("""
Server password.
This configuration option takes the password for authenticating with
the VMware ESX/ESXi or vCenter Server. This option is required when
using the VMware storage backend.
Possible Values:
* Any string that is a password corresponding to the username
specified using the "vmware_server_username" option
Related options:
* vmware_server_host
* vmware_server_username
"""),
secret=True),
cfg.IntOpt('vmware_api_retry_count',
default=10,
help=_('Number of times VMware ESX/VC server API must be '
'retried upon connection related issues.')),
min=1,
help=_("""
The number of VMware API retries.
This configuration option specifies the number of times the VMware
ESX/VC server API must be retried upon connection related issues or
server API call overload. It is not possible to specify 'retry
forever'.
Possible Values:
* Any positive integer value
Related options:
* None
""")),
cfg.IntOpt('vmware_task_poll_interval',
default=5,
help=_('The interval used for polling remote tasks '
'invoked on VMware ESX/VC server.')),
min=1,
help=_("""
Interval in seconds used for polling remote tasks invoked on VMware
ESX/VC server.
This configuration option takes in the sleep time in seconds for polling an
on-going async task as part of the VMWare ESX/VC server API call.
Possible Values:
* Any positive integer value
Related options:
* None
""")),
cfg.StrOpt('vmware_store_image_dir',
default=DEFAULT_STORE_IMAGE_DIR,
help=_('The name of the directory where the glance images '
'will be stored in the VMware datastore.')),
help=_("""
The directory where the glance images will be stored in the datastore.
This configuration option specifies the path to the directory where the
glance images will be stored in the VMware datastore. If this option
is not set, the default directory where the glance images are stored
is openstack_glance.
Possible Values:
* Any string that is a valid path to a directory
Related options:
* None
""")),
cfg.BoolOpt('vmware_insecure',
default=False,
help=_('If true, the ESX/vCenter server certificate is not '
'verified. If false, then the default CA truststore is '
'used for verification. This option is ignored if '
'"vmware_ca_file" is set.'),
deprecated_name='vmware_api_insecure'),
deprecated_name='vmware_api_insecure',
help=_("""
Set verification of the ESX/vCenter server certificate.
This configuration option takes a boolean value to determine
whether or not to verify the ESX/vCenter server certificate. If this
option is set to True, the ESX/vCenter server certificate is not
verified. If this option is set to False, then the default CA
truststore is used for verification.
This option is ignored if the "vmware_ca_file" option is set. In that
case, the ESX/vCenter server certificate will then be verified using
the file specified using the "vmware_ca_file" option .
Possible Values:
* True
* False
Related options:
* vmware_ca_file
""")),
cfg.StrOpt('vmware_ca_file',
help=_('Specify a CA bundle file to use in verifying the '
'ESX/vCenter server certificate.')),
sample_default='/etc/ssl/certs/ca-certificates.crt',
help=_("""
Absolute path to the CA bundle file.
This configuration option enables the operator to use a custom
Cerificate Authority File to verify the ESX/vCenter certificate.
If this option is set, the "vmware_insecure" option will be ignored
and the CA file specified will be used to authenticate the ESX/vCenter
server certificate and establish a secure connection to the server.
Possible Values:
* Any string that is a valid absolute path to a CA file
Related options:
* vmware_insecure
""")),
cfg.MultiStrOpt(
'vmware_datastores',
help=_(
'A list of datastores where the image can be stored. This option '
'may be specified multiple times for specifying multiple '
'datastores. The datastore name should be specified after its '
'datacenter path, separated by ":". An optional weight may be '
'given after the datastore name, separated again by ":". Thus, '
'the required format becomes '
'<datacenter_path>:<datastore_name>:<optional_weight>. When '
'adding an image, the datastore with highest weight will be '
'selected, unless there is not enough free space available in '
'cases where the image size is already known. If no weight is '
'given, it is assumed to be zero and the directory will be '
'considered for selection last. If multiple datastores have the '
'same weight, then the one with the most free space available is '
'selected.'))]
help=_("""
The datastores where the image can be stored.
This configuration option specifies the datastores where the image can
be stored in the VMWare store backend. This option may be specified
multiple times for specifying multiple datastores. The datastore name
should be specified after its datacenter path, separated by ":". An
optional weight may be given after the datastore name, separated again
by ":" to specify the priority. Thus, the required format becomes
<datacenter_path>:<datastore_name>:<optional_weight>.
When adding an image, the datastore with highest weight will be
selected, unless there is not enough free space available in cases
where the image size is already known. If no weight is given, it is
assumed to be zero and the directory will be considered for selection
last. If multiple datastores have the same weight, then the one with
the most free space available is selected.
Possible Values:
* Any string of the format:
<datacenter_path>:<datastore_name>:<optional_weight>
Related options:
* None
"""))]
def http_response_iterator(conn, response, size):