openstack/glance
Code Issues Proposed changes

Merge "Add documentation for some API parameters"

Browse Source
This commit is contained in:
Jenkins 2013-12-05 08:35:59 +00:00 committed by Gerrit Code Review
commit a3a29e686f
2 changed files with 73 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
doc/source/configuring.rst
View File

@ -202,6 +202,12 @@ certificates provided during an SSL handshake. This is ignored if
Optional. Default: not enabled. Optional. Default: not enabled.
Configurating Registry Access
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are a number of configuration options in Glance that control how
the API server accesses the registry server.
* ``registry_client_protocol=PROTOCOL`` * ``registry_client_protocol=PROTOCOL``
If you run a secure Registry server, you need to set this value to ``https`` If you run a secure Registry server, you need to set this value to ``https``
@ -249,6 +255,53 @@ Optional. Default: ``600``.
The period of time, in seconds, that the API server will wait for a registry The period of time, in seconds, that the API server will wait for a registry
request to complete. A value of '0' implies no timeout. request to complete. A value of '0' implies no timeout.
* ``use_user_token=True``
Optional. Default: True
Pass the user token through for API requests to the registry.
If 'use_user_token' is not in effect then admin credentials can be
specified (see below). If admin credentials are specified then they are
used to generate a token; this token rather than the original user's
token is used for requests to the registry.
* ``admin_user=USER``
If 'use_user_token' is not in effect then admin credentials can be
specified. Use this parameter to specify the username.
Optional. Default: None
* ``admin_password=PASSWORD``
If 'use_user_token' is not in effect then admin credentials can be
specified. Use this parameter to specify the password.
Optional. Default: None
* ``admin_tenant_name=TENANTNAME``
If 'use_user_token' is not in effect then admin credentials can be
specified. Use this parameter to specify the tenant name.
Optional. Default: None
* ``auth_url=URL``
If 'use_user_token' is not in effect then admin credentials can be
specified. Use this parameter to specify the Keystone endpoint.
Optional. Default: None
* ``auth_strategy=STRATEGY``
If 'use_user_token' is not in effect then admin credentials can be
specified. Use this parameter to specify the auth strategy.
Optional. Default: keystone
* ``auth_region=REGION``
If 'use_user_token' is not in effect then admin credentials can be
specified. Use this parameter to specify the region.
Optional. Default: None
Configuring Logging in Glance Configuring Logging in Glance
----------------------------- -----------------------------

20
etc/glance-api.conf
View File

@ -204,6 +204,26 @@ registry_client_protocol = http
# Default: False # Default: False
#sqlalchemy_debug = True #sqlalchemy_debug = True
# Pass the user's token through for API requests to the registry.
# Default: True
#use_user_token = True
# If 'use_user_token' is not in effect then admin credentials
# can be specified. Requests to the registry on behalf of
# the API will use these credentials.
# Admin user name
#admin_user = None
# Admin password
#admin_password = None
# Admin tenant name
#admin_tenant_name = None
# Keystone endpoint
#auth_url = None
# Keystone region
#auth_region = None
# Auth strategy
#auth_strategy = keystone
# ============ Notification System Options ===================== # ============ Notification System Options =====================
# Notifications can be sent when images are create, updated or deleted. # Notifications can be sent when images are create, updated or deleted.