195 lines
7.7 KiB
Python
195 lines
7.7 KiB
Python
# Copyright 2010 United States Government as represented by the
|
|
# Administrator of the National Aeronautics and Space Administration.
|
|
# All Rights Reserved.
|
|
# Copyright 2012 Red Hat, Inc.
|
|
#
|
|
# 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.
|
|
|
|
"""Command-line flag library.
|
|
|
|
Emulates gflags by wrapping cfg.ConfigOpts.
|
|
|
|
The idea is to move fully to cfg eventually, and this wrapper is a
|
|
stepping stone.
|
|
|
|
"""
|
|
|
|
import socket
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log
|
|
from oslo_middleware import cors
|
|
from oslo_utils import netutils
|
|
import six
|
|
|
|
from manila.common import constants
|
|
from manila import exception
|
|
from manila.i18n import _
|
|
|
|
CONF = cfg.CONF
|
|
log.register_options(CONF)
|
|
|
|
|
|
core_opts = [
|
|
cfg.StrOpt('state_path',
|
|
default='/var/lib/manila',
|
|
help="Top-level directory for maintaining manila's state."),
|
|
]
|
|
|
|
debug_opts = [
|
|
]
|
|
|
|
CONF.register_cli_opts(core_opts)
|
|
CONF.register_cli_opts(debug_opts)
|
|
|
|
global_opts = [
|
|
cfg.HostAddressOpt('my_ip',
|
|
default=netutils.get_my_ipv4(),
|
|
sample_default='<your_ip>',
|
|
help='IP address of this host.'),
|
|
cfg.StrOpt('scheduler_topic',
|
|
default='manila-scheduler',
|
|
help='The topic scheduler nodes listen on.'),
|
|
cfg.StrOpt('share_topic',
|
|
default='manila-share',
|
|
help='The topic share nodes listen on.'),
|
|
cfg.StrOpt('data_topic',
|
|
default='manila-data',
|
|
help='The topic data nodes listen on.'),
|
|
cfg.BoolOpt('api_rate_limit',
|
|
default=True,
|
|
help='Whether to rate limit the API.'),
|
|
cfg.ListOpt('osapi_share_ext_list',
|
|
default=[],
|
|
help='Specify list of extensions to load when using osapi_'
|
|
'share_extension option with manila.api.contrib.'
|
|
'select_extensions.'),
|
|
cfg.ListOpt('osapi_share_extension',
|
|
default=['manila.api.contrib.standard_extensions'],
|
|
help='The osapi share extensions to load.'),
|
|
cfg.StrOpt('scheduler_manager',
|
|
default='manila.scheduler.manager.SchedulerManager',
|
|
help='Full class name for the scheduler manager.'),
|
|
cfg.StrOpt('share_manager',
|
|
default='manila.share.manager.ShareManager',
|
|
help='Full class name for the share manager.'),
|
|
cfg.StrOpt('data_manager',
|
|
default='manila.data.manager.DataManager',
|
|
help='Full class name for the data manager.'),
|
|
cfg.HostAddressOpt('host',
|
|
default=socket.gethostname(),
|
|
sample_default='<your_hostname>',
|
|
help='Name of this node. This can be an opaque '
|
|
'identifier. It is not necessarily a hostname, '
|
|
'FQDN, or IP address.'),
|
|
# NOTE(vish): default to nova for compatibility with nova installs
|
|
cfg.StrOpt('storage_availability_zone',
|
|
default='nova',
|
|
help='Availability zone of this node.'),
|
|
cfg.StrOpt('default_share_type',
|
|
help='Default share type to use.'),
|
|
cfg.StrOpt('default_share_group_type',
|
|
help='Default share group type to use.'),
|
|
cfg.ListOpt('memcached_servers',
|
|
help='Memcached servers or None for in process cache.'),
|
|
cfg.StrOpt('share_usage_audit_period',
|
|
default='month',
|
|
help='Time period to generate share usages for. '
|
|
'Time period must be hour, day, month or year.'),
|
|
cfg.StrOpt('root_helper',
|
|
default='sudo',
|
|
help='Deprecated: command to use for running commands as '
|
|
'root.'),
|
|
cfg.StrOpt('rootwrap_config',
|
|
help='Path to the rootwrap configuration file to use for '
|
|
'running commands as root.'),
|
|
cfg.BoolOpt('monkey_patch',
|
|
default=False,
|
|
help='Whether to log monkey patching.'),
|
|
cfg.ListOpt('monkey_patch_modules',
|
|
default=[],
|
|
help='List of modules or decorators to monkey patch.'),
|
|
cfg.IntOpt('service_down_time',
|
|
default=60,
|
|
help='Maximum time since last check-in for up service.'),
|
|
cfg.StrOpt('share_api_class',
|
|
default='manila.share.api.API',
|
|
help='The full class name of the share API class to use.'),
|
|
cfg.StrOpt('auth_strategy',
|
|
default='keystone',
|
|
help='The strategy to use for auth. Supports noauth, keystone, '
|
|
'and deprecated.'),
|
|
cfg.ListOpt('enabled_share_backends',
|
|
help='A list of share backend names to use. These backend '
|
|
'names should be backed by a unique [CONFIG] group '
|
|
'with its options.'),
|
|
cfg.ListOpt('enabled_share_protocols',
|
|
default=['NFS', 'CIFS'],
|
|
help="Specify list of protocols to be allowed for share "
|
|
"creation. Available values are '%s'" % six.text_type(
|
|
constants.SUPPORTED_SHARE_PROTOCOLS)),
|
|
]
|
|
|
|
CONF.register_opts(global_opts)
|
|
|
|
|
|
def verify_share_protocols():
|
|
"""Perform verification of 'enabled_share_protocols'."""
|
|
msg = None
|
|
supported_protocols = constants.SUPPORTED_SHARE_PROTOCOLS
|
|
data = dict(supported=', '.join(supported_protocols))
|
|
if CONF.enabled_share_protocols:
|
|
for share_proto in CONF.enabled_share_protocols:
|
|
if share_proto.upper() not in supported_protocols:
|
|
data.update({'share_proto': share_proto})
|
|
msg = ("Unsupported share protocol '%(share_proto)s' "
|
|
"is set as enabled. Available values are "
|
|
"%(supported)s. ")
|
|
break
|
|
else:
|
|
msg = ("No share protocols were specified as enabled. "
|
|
"Available values are %(supported)s. ")
|
|
if msg:
|
|
msg += ("Please specify one or more protocols using "
|
|
"configuration option 'enabled_share_protocols'.")
|
|
# NOTE(vponomaryov): use translation to unicode explicitly,
|
|
# because of 'lazy' translations.
|
|
msg = six.text_type(_(msg) % data) # noqa H701
|
|
raise exception.ManilaException(message=msg)
|
|
|
|
|
|
def set_middleware_defaults():
|
|
"""Update default configuration options for oslo.middleware."""
|
|
cors.set_defaults(
|
|
allow_headers=['X-Auth-Token',
|
|
'X-OpenStack-Request-ID',
|
|
'X-Openstack-Manila-Api-Version',
|
|
'X-OpenStack-Manila-API-Experimental',
|
|
'X-Identity-Status',
|
|
'X-Roles',
|
|
'X-Service-Catalog',
|
|
'X-User-Id',
|
|
'X-Tenant-Id'],
|
|
expose_headers=['X-Auth-Token',
|
|
'X-OpenStack-Request-ID',
|
|
'X-Openstack-Manila-Api-Version',
|
|
'X-OpenStack-Manila-API-Experimental',
|
|
'X-Subject-Token',
|
|
'X-Service-Token'],
|
|
allow_methods=['GET',
|
|
'PUT',
|
|
'POST',
|
|
'DELETE',
|
|
'PATCH']
|
|
)
|