3ff3debc14
In the first few improvements to the help text of configuration options, the section "Services which consume this" was included to clearly indicate which services consume a particular configuration option. However, this is redundant information as all glance services have their configuration files. And, the very fact that a configuration option appears in a certain file indicates that the corresponding service potentially consumes it. Hence, in this patch we drop the redundant section from the help text of configuration options it appears in. The configuration options that are impacted are: * public_endpoint (glance/api/glare/versions.py) * owner_is_tenant (glance/api/middleware/context.py) * admin_role (glance/api/middleware/context.py) * allow_anonymous_access (glance/api/middleware/context.py) * max_request_id_length (glance/api/middleware/context.py) * public_endpoint (glance/api/versions.py) * image_cache_driver (glance/image_cache/__init__.py) * image_cache_max_size (glance/image_cache/__init__.py) * image_cache_stall_time (glance/image_cache/__init__.py) * image_cache_dir (glance/image_cache/__init__.py) * image_cache_sqlite_db (glance/image_cache/drivers/sqlite.py) * admin_role (glance/scrubber.py) Change-Id: I9ea635368994a9f89bb4f19a82104499e5174b46 Partial-Bug: #1570946
94 lines
3.0 KiB
Python
94 lines
3.0 KiB
Python
# Copyright 2012 OpenStack Foundation.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from oslo_config import cfg
|
|
from oslo_serialization import jsonutils
|
|
from six.moves import http_client
|
|
import webob.dec
|
|
|
|
from glance.common import wsgi
|
|
from glance import i18n
|
|
|
|
_ = i18n._
|
|
|
|
versions_opts = [
|
|
|
|
# Note: Since both glance-api and glare-api have the same name for the
|
|
# option public_endpoint, oslo.config generator throws a DuplicateError
|
|
# exception during the conf file generation incase of differing help
|
|
# texts. Hence we have to have identical help texts for glance-api and
|
|
# glare-api's public_endpoint if not for changing the conf opt name.
|
|
|
|
cfg.StrOpt('public_endpoint',
|
|
help=_("""
|
|
Public url endpoint to use for Glance/Glare versions response.
|
|
|
|
This is the public url endpoint that will appear in the Glance/Glare
|
|
"versions" response. If no value is specified, the endpoint that is
|
|
displayed in the version's response is that of the host running the
|
|
API service. Change the endpoint to represent the proxy URL if the
|
|
API service is running behind a proxy. If the service is running
|
|
behind a load balancer, add the load balancer's URL for this value.
|
|
|
|
Possible values:
|
|
* None
|
|
* Proxy URL
|
|
* Load balancer URL
|
|
|
|
Related options:
|
|
* None
|
|
|
|
""")),
|
|
]
|
|
|
|
CONF = cfg.CONF
|
|
CONF.register_opts(versions_opts)
|
|
|
|
|
|
class Controller(object):
|
|
|
|
"""A wsgi controller that reports which API versions are supported."""
|
|
|
|
def index(self, req, explicit=False):
|
|
"""Respond to a request for all OpenStack API versions."""
|
|
def build_version_object(version, path, status):
|
|
url = CONF.public_endpoint or req.host_url
|
|
return {
|
|
'id': 'v%s' % version,
|
|
'status': status,
|
|
'links': [
|
|
{
|
|
'rel': 'self',
|
|
'href': '%s/%s/' % (url, path),
|
|
},
|
|
],
|
|
}
|
|
|
|
version_objs = [build_version_object(0.1, 'v0.1', 'EXPERIMENTAL')]
|
|
status = explicit and http_client.OK or http_client.MULTIPLE_CHOICES
|
|
response = webob.Response(request=req,
|
|
status=status,
|
|
content_type='application/json')
|
|
response.body = jsonutils.dump_as_bytes(dict(versions=version_objs))
|
|
return response
|
|
|
|
@webob.dec.wsgify(RequestClass=wsgi.Request)
|
|
def __call__(self, req):
|
|
return self.index(req)
|
|
|
|
|
|
def create_resource(conf):
|
|
return wsgi.Resource(Controller())
|