openstack
/
openstack-manuals
Code Issues Proposed changes

Update glance configuration tables 

Closes-Bug: #1367050

Change-Id: I4300479eae542f61c7d244b54f59b5617c65c20d
This commit is contained in:
Gauvain Pocentek 2014-09-16 08:40:27 +02:00
parent 38d20bd5a8
commit 2f85b3f325
11 changed files with 136 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/common/tables/glance-api.xml
View File

@ -29,14 +29,6 @@
<td>default_publisher_id = image.localhost</td>
<td>(StrOpt) Default publisher_id for outgoing notifications.</td>
</tr>
<tr>
<td>default_store = file</td>
<td>(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'known_stores' config option.</td>
</tr>
<tr>
<td>default_swift_reference = ref1</td>
<td>(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.</td>
</tr>
<tr>
<td>enable_v1_api = True</td>
<td>(BoolOpt) Deploy the v1 OpenStack Images API.</td>
@ -57,10 +49,6 @@
<td>image_size_cap = 1099511627776</td>
<td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
</tr>
<tr>
<td>known_stores = glance.store.filesystem.Store, glance.store.http.Store</td>
<td>(ListOpt) List of which store classes and store class locations are currently known to glance at startup.</td>
</tr>
<tr>
<td>location_strategy = location_order</td>
<td>(StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'.</td>
@ -81,6 +69,17 @@
<td>use_user_token = True</td>
<td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td>
</tr>
<tr>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>default_store = file</td>
<td>(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'stores' config option.</td>
</tr>
<tr>
<td>stores = file, http</td>
<td>(ListOpt) List of stores enabled</td>
</tr>
<tr>
<th colspan="2">[store_type_location_strategy]</th>
</tr>

12
doc/common/tables/glance-cinder.xml
View File

@ -15,27 +15,27 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>cinder_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL requests to cinder.</td>
<td>(BoolOpt) Allow to perform insecure SSL requests to cinder</td>
</tr>
<tr>
<td>cinder_ca_certificates_file = None</td>
<td>(StrOpt) Location of CA certicates file to use for cinder client requests.</td>
<td>(StrOpt) Location of ca certicates file to use for cinder client requests.</td>
</tr>
<tr>
<td>cinder_catalog_info = volume:cinder:publicURL</td>
<td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;.</td>
<td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;</td>
</tr>
<tr>
<td>cinder_endpoint_template = None</td>
<td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s.</td>
<td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s</td>
</tr>
<tr>
<td>cinder_http_retries = 3</td>
<td>(IntOpt) Number of cinderclient retries on failed http calls.</td>
<td>(IntOpt) Number of cinderclient retries on failed http calls</td>
</tr>
</tbody>
</table>

19
doc/common/tables/glance-common.xml
View File

@ -74,8 +74,8 @@
<td>(StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database.</td>
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) Region name of this node.</td>
<td>metadata_source_path = /etc/glance/metadefs/</td>
<td>(StrOpt) Path to the directory where json metadata files are stored</td>
</tr>
<tr>
<td>property_protection_file = None</td>
@ -97,6 +97,13 @@
<td>workers = 4</td>
<td>(IntOpt) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available.</td>
</tr>
<tr>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>os_region_name = None</td>
<td>(StrOpt) Region name of this node</td>
</tr>
<tr>
<th colspan="2">[image_format]</th>
</tr>
@ -111,6 +118,14 @@
<tr>
<th colspan="2">[task]</th>
</tr>
<tr>
<td>eventlet_executor_pool_size = 1000</td>
<td>(IntOpt) Specifies the maximum number of eventlet threads which can be spun up by the eventlet based task executor to perform execution of Glance tasks.</td>
</tr>
<tr>
<td>task_executor = eventlet</td>
<td>(StrOpt) Specifies which task executor to be used to run the task scripts.</td>
</tr>
<tr>
<td>task_time_to_live = 48</td>
<td>(IntOpt) Time in hours for which a task lives after, either succeeding or failing</td>

6
doc/common/tables/glance-filesystem.xml
View File

@ -15,7 +15,7 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>filesystem_store_datadir = None</td>
@ -25,6 +25,10 @@
<td>filesystem_store_datadirs = None</td>
<td>(MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images.</td>
</tr>
<tr>
<td>filesystem_store_file_perm = 0</td>
<td>(IntOpt) The required permission for created image file. In this way the user other service used, e.g. Nova, who consumes the image could be the exclusive member of the group that owns the files created. Assigning it less then or equal to zero means don't change the default permission of the file. This value will be decoded as an octal digit.</td>
</tr>
<tr>
<td>filesystem_store_metadata_file = None</td>
<td>(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict.</td>

6
doc/common/tables/glance-gridfs.xml
View File

@ -15,15 +15,15 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>mongodb_store_db = None</td>
<td>(StrOpt) Database to use.</td>
<td>(StrOpt) Database to use</td>
</tr>
<tr>
<td>mongodb_store_uri = None</td>
<td>(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost).</td>
<td>(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost)</td>
</tr>
</tbody>
</table>

6
doc/common/tables/glance-rbd.xml
View File

@ -15,11 +15,11 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>rbd_store_ceph_conf = /etc/ceph/ceph.conf</td>
<td>(StrOpt) Ceph configuration file path. If &lt;None&gt;, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.&lt;USER&gt; section.</td>
<td>(StrOpt) Ceph configuration file path. If &lt;None&gt;, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.&lt;USER&gt; section</td>
</tr>
<tr>
<td>rbd_store_chunk_size = 8</td>
@ -31,7 +31,7 @@
</tr>
<tr>
<td>rbd_store_user = None</td>
<td>(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If &lt;None&gt;, a default will be chosen based on the client. section in rbd_store_ceph_conf).</td>
<td>(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If &lt;None&gt;, a default will be chosen based on the client. section in rbd_store_ceph_conf)</td>
</tr>
</tbody>
</table>

14
doc/common/tables/glance-s3.xml
View File

@ -15,7 +15,7 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>s3_store_access_key = None</td>
@ -37,14 +37,6 @@
<td>s3_store_host = None</td>
<td>(StrOpt) The host where the S3 server is listening.</td>
</tr>
<tr>
<td>s3_store_large_object_chunk_size = 10</td>
<td>(IntOpt) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M.</td>
</tr>
<tr>
<td>s3_store_large_object_size = 100</td>
<td>(IntOpt) What size, in MB, should S3 start chunking image files and do a multipart upload in S3.</td>
</tr>
<tr>
<td>s3_store_object_buffer_dir = None</td>
<td>(StrOpt) The local directory where uploads will be staged before they are transferred into S3.</td>
@ -53,10 +45,6 @@
<td>s3_store_secret_key = None</td>
<td>(StrOpt) The S3 query token secret key.</td>
</tr>
<tr>
<td>s3_store_thread_pools = 10</td>
<td>(IntOpt) The number of thread pools to perform a multipart upload in S3.</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/glance-sheepdog.xml
View File

@ -15,10 +15,10 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>sheepdog_store_address = 127.0.0.1</td>
<td>sheepdog_store_address = localhost</td>
<td>(StrOpt) IP address of sheep daemon.</td>
</tr>
<tr>

27
doc/common/tables/glance-swift.xml
View File

@ -17,6 +17,33 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>default_swift_reference = ref1</td>
<td>(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.</td>
</tr>
<tr>
<td>swift_store_auth_address = None</td>
<td>(StrOpt) The address where the Swift authentication service is listening.(deprecated)</td>
</tr>
<tr>
<td>swift_store_config_file = None</td>
<td>(StrOpt) The config file that has the swift account(s)configs.</td>
</tr>
<tr>
<td>swift_store_key = None</td>
<td>(StrOpt) Auth key for the user authenticating against the Swift authentication service. (deprecated)</td>
</tr>
<tr>
<td>swift_store_user = None</td>
<td>(StrOpt) The user to authenticate against the Swift authentication service (deprecated)</td>
</tr>
<tr>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>default_swift_reference = ref1</td>
<td>(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.</td>
</tr>
<tr>
<td>swift_enable_snet = False</td>
<td>(BoolOpt) Whether to use ServiceNET to communicate with the Swift storage servers.</td>

2
doc/common/tables/glance-vmware.xml
View File

@ -15,7 +15,7 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[glance_store]</th>
</tr>
<tr>
<td>vmware_api_insecure = False</td>

114
tools/autogenerate-config-flagmappings/glance.flagmappings
View File

@ -16,11 +16,6 @@ bind_host common
bind_port common
ca_file ca
cert_file ca
cinder_api_insecure cinder
cinder_ca_certificates_file cinder
cinder_catalog_info cinder
cinder_endpoint_template cinder
cinder_http_retries cinder
cleanup_scrubber imagecache
cleanup_scrubber_time imagecache
control_exchange rabbitmq
@ -28,8 +23,7 @@ data_api common
debug logging
default_log_levels logging
default_publisher_id api
default_store api
default_swift_reference api
default_swift_reference swift
delayed_delete imagecache
disable_process_locking common
enable_v1_api api
@ -39,9 +33,6 @@ enable_v2_registry api
eventlet_hub wsgi
fake_rabbit rabbitmq
fatal_deprecations logging
filesystem_store_datadir filesystem
filesystem_store_datadirs filesystem
filesystem_store_metadata_file filesystem
image_cache_dir imagecache
image_cache_driver imagecache
image_cache_max_size imagecache
@ -55,7 +46,6 @@ image_tag_quota common
instance_format logging
instance_uuid_format logging
key_file ca
known_stores api
kombu_reconnect_delay rabbitmq
kombu_ssl_ca_certs rabbitmq
kombu_ssl_certfile rabbitmq
@ -78,11 +68,9 @@ matchmaker_heartbeat_ttl matchmaker
max_header_line wsgi
memcached_servers auth_token
metadata_encryption_key common
mongodb_store_db gridfs
mongodb_store_uri gridfs
metadata_source_path common
notification_driver amqp
notification_topics amqp
os_region_name common
owner_is_tenant api
policy_default_rule policy
policy_file policy
@ -113,10 +101,6 @@ rabbit_retry_interval rabbitmq
rabbit_use_ssl rabbitmq
rabbit_userid rabbitmq
rabbit_virtual_host rabbitmq
rbd_store_ceph_conf rbd
rbd_store_chunk_size rbd
rbd_store_pool rbd
rbd_store_user rbd
registry_client_ca_file registry
registry_client_cert_file registry
registry_client_insecure registry
@ -137,41 +121,14 @@ rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
s3_store_access_key s3
s3_store_bucket s3
s3_store_bucket_url_format s3
s3_store_create_bucket_on_put s3
s3_store_host s3
s3_store_large_object_chunk_size s3
s3_store_large_object_size s3
s3_store_object_buffer_dir s3
s3_store_secret_key s3
s3_store_thread_pools s3
scrub_time imagecache
scrubber_datadir imagecache
send_identity_headers api
sheepdog_store_address sheepdog
sheepdog_store_chunk_size sheepdog
sheepdog_store_port sheepdog
show_image_direct_url common
show_multiple_locations api
swift_enable_snet swift
swift_store_admin_tenants swift
swift_store_auth_address swift
swift_store_auth_insecure swift
swift_store_auth_version swift
swift_store_config_file swift
swift_store_container swift
swift_store_create_container_on_put swift
swift_store_endpoint_type swift
swift_store_key swift
swift_store_large_object_chunk_size swift
swift_store_large_object_size swift
swift_store_multi_tenant swift
swift_store_region swift
swift_store_retry_get_count swift
swift_store_service_type swift
swift_store_ssl_compression swift
swift_store_user swift
syslog_log_facility logging
tcp_keepidle wsgi
@ -182,15 +139,6 @@ use_syslog_rfc_format logging
use_user_token api
user_storage_quota common
verbose logging
vmware_api_insecure vmware
vmware_api_retry_count vmware
vmware_datacenter_path vmware
vmware_datastore_name vmware
vmware_server_host vmware
vmware_server_password vmware
vmware_server_username vmware
vmware_store_image_dir vmware
vmware_task_poll_interval vmware
workers common
database/backend database
database/connection database
@ -212,6 +160,62 @@ database/slave_connection database
database/sqlite_db database
database/sqlite_synchronous database
database/use_db_reconnect database
glance_store/cinder_api_insecure cinder
glance_store/cinder_ca_certificates_file cinder
glance_store/cinder_catalog_info cinder
glance_store/cinder_endpoint_template cinder
glance_store/cinder_http_retries cinder
glance_store/default_store api
glance_store/default_swift_reference swift
glance_store/filesystem_store_datadir filesystem
glance_store/filesystem_store_datadirs filesystem
glance_store/filesystem_store_file_perm filesystem
glance_store/filesystem_store_metadata_file filesystem
glance_store/mongodb_store_db gridfs
glance_store/mongodb_store_uri gridfs
glance_store/os_region_name common
glance_store/rbd_store_ceph_conf rbd
glance_store/rbd_store_chunk_size rbd
glance_store/rbd_store_pool rbd
glance_store/rbd_store_user rbd
glance_store/s3_store_access_key s3
glance_store/s3_store_bucket s3
glance_store/s3_store_bucket_url_format s3
glance_store/s3_store_create_bucket_on_put s3
glance_store/s3_store_host s3
glance_store/s3_store_object_buffer_dir s3
glance_store/s3_store_secret_key s3
glance_store/sheepdog_store_address sheepdog
glance_store/sheepdog_store_chunk_size sheepdog
glance_store/sheepdog_store_port sheepdog
glance_store/stores api
glance_store/swift_enable_snet swift
glance_store/swift_store_admin_tenants swift
glance_store/swift_store_auth_address swift
glance_store/swift_store_auth_insecure swift
glance_store/swift_store_auth_version swift
glance_store/swift_store_config_file swift
glance_store/swift_store_container swift
glance_store/swift_store_create_container_on_put swift
glance_store/swift_store_endpoint_type swift
glance_store/swift_store_key swift
glance_store/swift_store_large_object_chunk_size swift
glance_store/swift_store_large_object_size swift
glance_store/swift_store_multi_tenant swift
glance_store/swift_store_region swift
glance_store/swift_store_retry_get_count swift
glance_store/swift_store_service_type swift
glance_store/swift_store_ssl_compression swift
glance_store/swift_store_user swift
glance_store/vmware_api_insecure vmware
glance_store/vmware_api_retry_count vmware
glance_store/vmware_datacenter_path vmware
glance_store/vmware_datastore_name vmware
glance_store/vmware_server_host vmware
glance_store/vmware_server_password vmware
glance_store/vmware_server_username vmware
glance_store/vmware_store_image_dir vmware
glance_store/vmware_task_poll_interval vmware
image_format/container_formats common
image_format/disk_formats common
keystone_authtoken/admin_password auth_token
@ -252,4 +256,6 @@ paste_deploy/flavor paste
profiler/enabled profiler
profiler/trace_sqlalchemy profiler
store_type_location_strategy/store_type_preference api
task/eventlet_executor_pool_size common
task/task_executor common
task/task_time_to_live common