"""Manage all configuration the OpenStack way."""
# (c) Copyright 2016 Hewlett-Packard Development Company, L.P.
#
# 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.
import sys
from oslo_config import cfg
from oslo_log import log
from freezer_dr import __version__ as FREEZER_DR_VERSION
from freezer_dr.common.utils import env
CONF = cfg.CONF
_MONITORS = [
cfg.StrOpt('driver',
default='freezer_dr.monitors.drivers.default.driver.'
'StandardDriver',
help='Driver used to get a status updates of compute nodes'),
cfg.StrOpt('backend_name',
help='configuration section name. This should contain your '
'monitoring specific configuration options.')
]
_COMMON = [
cfg.IntOpt('wait',
default=30,
help='Time to wait between different operations')
]
_FENCER = [
cfg.StrOpt('credentials-file',
help='YAML File contains the required credentials for compute '
'nodes'),
cfg.IntOpt('retries',
default=1,
help='Number of retries to fence the each compute node. Must be'
' at least 1 to try first the soft shutdown'),
cfg.IntOpt('hold-period',
default=10,
help='Time in seconds to wait between retries. Should be '
'reasonable amount of time as different servers take '
'different times to shut off'),
cfg.StrOpt('driver',
default='freezer_dr.fencers.drivers.ipmi.driver.IpmiDriver',
help='Choose the best fencer driver i.e.(ipmi, libvirt, ..'),
cfg.DictOpt('options',
default={},
help='List of kwargs to customize the fencer operation. You '
'fencer driver should support these options. Options '
'should be in key:value format')
]
_KEYSTONE_AUTH_TOKEN = [
cfg.StrOpt('auth_uri',
help='OpenStack auth URI i.e. http://controller:5000',
dest='auth_uri'),
cfg.StrOpt('auth_url',
help='OpenStack auth URL i.e. http://controller:35357/v3',
dest='auth_url'),
cfg.StrOpt('auth_plugin',
help='OpenStack auth plugin i.e. ( password, token, ...) '
'password is the only available plugin for the time '
'being',
dest='auth_plugin'),
cfg.StrOpt('username',
help='OpenStack username',
dest='username'),
cfg.StrOpt('password',
help='OpenStack Password',
dest='password'),
cfg.StrOpt('project_name',
help='OpenStack Project Name.',
dest='project_name'),
cfg.StrOpt('domain_name',
help='OpenStack domain Name.',
dest='domain_name'),
cfg.StrOpt('project_domain_id',
help='OpenStack Project Domain id, default is Default',
dest='project_domain_id'),
cfg.StrOpt('user_domain_id',
help='OpenStack user Domain id, default is Default',
dest='user_domain_id'),
cfg.StrOpt('project_domain_name',
help='OpenStack Project Domain name, default is Default',
dest='project_domain_name'),
cfg.StrOpt('user_domain_name',
help='OpenStack user Domain name, default is Default',
dest='user_domain_name'),
cfg.DictOpt('kwargs',
help='OpenStack Authentication arguments you can pass it here'
' as Key:Value, Key1:Value1, ... ',
dest='kwargs',
default={})
]
_EVACUATION = [
cfg.StrOpt('driver',
default='freezer_dr.evacuators.drivers.default.standard.'
'StandardEvacuator',
help='Time in seconds to wait between retries to disable '
'compute node or put it in maintenance mode. Default '
'10 seconds',
dest='driver'),
cfg.IntOpt('wait',
default=10,
help='Time in seconds to wait between retries to disable '
'compute node or put it in maintenance mode. Default '
'10 seconds',
dest='wait'),
cfg.IntOpt('retries',
default=1,
help='Number of retries to put node in maintenance mode before'
' reporting failure to evacuate the node',
dest='retries'),
cfg.BoolOpt('shared-storage',
default=False,
help='Set this option to True in case your compute nodes are '
'running on a shared storage or False if not',
dest='shared_storage'),
cfg.DictOpt('options',
default={},
help='Dict contains kwargs to be passed to the evacuator '
'driver. In case you have additional args needs to be '
'passed to your evacuator please, list them as '
'key0:value0, key1:value1, ...',
dest='options')
]
_NOTIFIERS = [
cfg.StrOpt('driver',
default='freezer_dr.notifiers.drivers.default.default_email.'
'StandardEmail',
dest='driver',
help='Notification driver to load it to notify users '
'if something went wrong. There are two supported drivers'
': freezer_dr.notifiers.drivers.default.default_email.'
'StandardEmail and freezer_dr.notifiers.drivers.default.'
'slack.slack.SlackNotifier'),
cfg.StrOpt('endpoint',
default='localhost',
dest='endpoint',
help='Endpoint URL for the notification system. If you the '
'driver you are using doesnot require any URL just comment'
' it or use none'),
cfg.StrOpt('username',
default=None,
dest='username',
help='Username to authenticate against the notification system.'
' If the driver you are using doesnot require any '
'authentications comment or use None'),
cfg.StrOpt('password',
default=None,
dest='password',
help='Password to authenticate against the notification system. '
'If the driver you are using doesnot require any '
'authentications comment or use None'),
cfg.StrOpt('templates-dir',
dest='templates-dir',
default='/etc/freezer/templates',
help='Path to Jinja2 templates directory that contains '
'message templates'),
cfg.DictOpt('options',
default={},
dest='options',
help='Key:Value Kwargs to pass it to the notification driver, '
'if you want to pass any special arguments for your '
'driver. If you want to use the SlackNotifier driver, '
'set as: options = slack_timeout:512,'
'slack_ca_certs:/ca.crt,slack_insecured:True'),
cfg.ListOpt('notify-list',
default=[],
dest='notify-list',
help='List of emails to sent them notification if something '
'went wrong and Freezer DR wasnot able to send an email '
'to the tenant admin'),
cfg.StrOpt('notify-from',
dest='notify-from',
help='The sender address, it can be email address if we used '
'default email driver, or phone number if we use sms '
'gateway for example.')
]
[docs]def build_os_options():
"""Build oslo options related to OpenStack environment."""
osclient_opts = [
cfg.StrOpt('os-username',
default=env('OS_USERNAME'),
help='Name used for authentication with the OpenStack '
'Identity service. Defaults to env[OS_USERNAME].',
dest='os_username'),
cfg.StrOpt('os-password',
default=env('OS_PASSWORD'),
help='Password used for authentication with the OpenStack '
'Identity service. Defaults to env[OS_PASSWORD].',
dest='os_password'),
cfg.StrOpt('os-project-name',
default=env('OS_PROJECT_NAME'),
help='Project name to scope to. Defaults to '
'env[OS_PROJECT_NAME].',
dest='os_project_name'),
cfg.StrOpt('os-project-domain-name',
default=env('OS_PROJECT_DOMAIN_NAME'),
help='Domain name containing project. Defaults to '
'env[OS_PROJECT_DOMAIN_NAME].',
dest='os_project_domain_name'),
cfg.StrOpt('os-user-domain-name',
default=env('OS_USER_DOMAIN_NAME'),
help='User\'s domain name. Defaults to '
'env[OS_USER_DOMAIN_NAME].',
dest='os_user_domain_name'),
cfg.StrOpt('os-tenant-name',
default=env('OS_TENANT_NAME'),
help='Tenant to request authorization on. Defaults to '
'env[OS_TENANT_NAME].',
dest='os_tenant_name'),
cfg.StrOpt('os-tenant-id',
default=env('OS_TENANT_ID'),
help='Tenant to request authorization on. Defaults to '
'env[OS_TENANT_ID].',
dest='os_tenant_id'),
cfg.StrOpt('os-auth-url',
default=env('OS_AUTH_URL'),
help='Specify the Identity endpoint to use for '
'authentication. Defaults to env[OS_AUTH_URL].',
dest='os_auth_url'),
cfg.StrOpt('os-backup-url',
default=env('OS_BACKUP_URL'),
help='Specify the Freezer backup service endpoint to use. '
'Defaults to env[OS_BACKUP_URL].',
dest='os_backup_url'),
cfg.StrOpt('os-region-name',
default=env('OS_REGION_NAME'),
help='Specify the region to use. Defaults to '
'env[OS_REGION_NAME].',
dest='os_region_name'),
cfg.StrOpt('os-token',
default=env('OS_TOKEN'),
help='Specify an existing token to use instead of '
'retrieving one via authentication (e.g. '
'with username & password). Defaults to '
'env[OS_TOKEN].',
dest='os_token'),
cfg.StrOpt('os-identity-api-version',
default=env('OS_IDENTITY_API_VERSION'),
help='Identity API version: 2.0 or 3. '
'Defaults to env[OS_IDENTITY_API_VERSION]',
dest='os_identity_api_version'),
cfg.StrOpt('os-endpoint-type',
choices=['public', 'publicURL', 'internal', 'internalURL',
'admin', 'adminURL'],
default=env('OS_ENDPOINT_TYPE') or 'public',
help='Endpoint type to select. Valid endpoint types: '
'"public" or "publicURL", "internal" or "internalURL"'
', "admin" or "adminURL". Defaults to '
'env[OS_ENDPOINT_TYPE] or "public"',
dest='os_endpoint_type'),
]
return osclient_opts
[docs]def setup_logging():
"""Set some oslo log defaults."""
_DEFAULT_LOG_LEVELS = ['amqp=WARN', 'amqplib=WARN', 'boto=WARN',
'qpid=WARN', 'stevedore=WARN', 'oslo_log=INFO',
'iso8601=WARN',
'requests.packages.urllib3.connectionpool=WARN',
'urllib3.connectionpool=WARN', 'websocket=WARN',
'keystonemiddleware=WARN', 'freezer-dr=INFO']
_DEFAULT_LOGGING_CONTEXT_FORMAT = (
'%(asctime)s.%(msecs)03d %(process)d '
'%(levelname)s %(name)s [%(request_id)s '
'%(user_identity)s] %(instance)s'
'%(message)s')
log.set_defaults(_DEFAULT_LOGGING_CONTEXT_FORMAT, _DEFAULT_LOG_LEVELS)
log.setup(CONF, 'freezer-dr', version=FREEZER_DR_VERSION)
[docs]def list_opts():
_OPTS = {
None: _COMMON,
'monitoring': _MONITORS,
'keystone_authtoken': _KEYSTONE_AUTH_TOKEN,
'fencer': _FENCER,
'evacuation': _EVACUATION,
'notifiers': _NOTIFIERS
}
return _OPTS.items()
