python-troveclient/troveclient/osc/v1/database_configurations.py

454 lines
16 KiB
Python

# 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.
"""Database v1 Configurations action implementations"""
import json
from osc_lib.command import command
from osc_lib import utils as osc_utils
from oslo_utils import uuidutils
from troveclient import exceptions
from troveclient.i18n import _
def set_attributes_for_print_detail(configuration):
info = configuration._info.copy()
info['values'] = json.dumps(configuration.values)
del info['datastore_version_id']
return info
class ListDatabaseConfigurations(command.Lister):
_description = _("List database configurations")
columns = ['ID', 'Name', 'Description', 'Datastore Name',
'Datastore Version Name', 'Datastore Version Number']
def get_parser(self, prog_name):
parser = super(ListDatabaseConfigurations, self).get_parser(prog_name)
parser.add_argument(
'--limit',
dest='limit',
metavar='<limit>',
type=int,
default=None,
help=_('Limit the number of results displayed.')
)
parser.add_argument(
'--marker',
dest='marker',
metavar='<ID>',
help=_('Begin displaying the results for IDs greater than the '
'specified marker. When used with --limit, set this to '
'the last ID displayed in the previous run.')
)
return parser
def take_action(self, parsed_args):
db_configurations = self.app.client_manager.database.configurations
config = db_configurations.list(limit=parsed_args.limit,
marker=parsed_args.marker)
config = [osc_utils.get_item_properties(c, self.columns)
for c in config]
return self.columns, config
class ShowDatabaseConfiguration(command.ShowOne):
_description = _("Shows details of a database configuration group.")
def get_parser(self, prog_name):
parser = super(ShowDatabaseConfiguration, self).get_parser(prog_name)
parser.add_argument(
'configuration_group',
metavar='<configuration_group>',
help=_('ID or name of the configuration group'),
)
return parser
def take_action(self, parsed_args):
db_configurations = self.app.client_manager.database.configurations
configuration = osc_utils.find_resource(
db_configurations, parsed_args.configuration_group)
configuration = set_attributes_for_print_detail(configuration)
return zip(*sorted(configuration.items()))
class ListDatabaseConfigurationParameters(command.Lister):
_description = _("Lists available parameters for a configuration group.")
columns = ['Name', 'Type', 'Min Size', 'Max Size', 'Restart Required']
def get_parser(self, prog_name):
parser = super(ListDatabaseConfigurationParameters, self).\
get_parser(prog_name)
parser.add_argument(
'datastore_version',
metavar='<datastore_version>',
help=_('Datastore version name or ID assigned to the '
'configuration group. ID is preferred if more than one '
'datastore versions have the same name.')
)
parser.add_argument(
'--datastore',
metavar='<datastore>',
default=None,
help=_('ID or name of the datastore to list configuration'
'parameters for. Optional if the ID of the'
'datastore_version is provided.')
)
return parser
def take_action(self, parsed_args):
db_configuration_parameters = self.app.client_manager.\
database.configuration_parameters
if uuidutils.is_uuid_like(parsed_args.datastore_version):
params = db_configuration_parameters.parameters_by_version(
parsed_args.datastore_version)
elif parsed_args.datastore:
params = db_configuration_parameters.parameters(
parsed_args.datastore,
parsed_args.datastore_version)
else:
raise exceptions.NoUniqueMatch(_('Either datastore version ID or '
'datastore name needs to be '
'specified.'))
for param in params:
setattr(param, 'min_size', getattr(param, 'min', '-'))
setattr(param, 'max_size', getattr(param, 'max', '-'))
params = [osc_utils.get_item_properties(p, self.columns)
for p in params]
return self.columns, params
class ShowDatabaseConfigurationParameter(command.ShowOne):
_description = _("Shows details of a database configuration parameter.")
def get_parser(self, prog_name):
parser = super(ShowDatabaseConfigurationParameter, self).\
get_parser(prog_name)
parser.add_argument(
'datastore_version',
metavar='<datastore_version>',
help=_('Datastore version name or ID assigned to the '
'configuration group. ID is preferred if more than one '
'datastore versions have the same name.')
)
parser.add_argument(
'parameter',
metavar='<parameter>',
help=_('Name of the configuration parameter.'),
)
parser.add_argument(
'--datastore',
metavar='<datastore>',
default=None,
help=_('ID or name of the datastore to list configuration'
' parameters for. Optional if the ID of the'
' datastore_version is provided.'),
)
return parser
def take_action(self, parsed_args):
db_configuration_parameters = self.app.client_manager.database. \
configuration_parameters
if uuidutils.is_uuid_like(parsed_args.datastore_version):
param = db_configuration_parameters.get_parameter_by_version(
parsed_args.datastore_version,
parsed_args.parameter)
elif parsed_args.datastore:
param = db_configuration_parameters.get_parameter(
parsed_args.datastore,
parsed_args.datastore_version,
parsed_args.parameter)
else:
raise exceptions.NoUniqueMatch(_('Either datastore version ID or '
'datastore name needs to be '
'specified.'))
return zip(*sorted(param._info.items()))
class DeleteDatabaseConfiguration(command.Command):
_description = _("Deletes a configuration group.")
def get_parser(self, prog_name):
parser = super(DeleteDatabaseConfiguration, self).get_parser(prog_name)
parser.add_argument(
'configuration_group',
metavar='<configuration_group>',
help=_('ID or name of the configuration group'),
)
return parser
def take_action(self, parsed_args):
db_configurations = self.app.client_manager.database.configurations
try:
configuration = osc_utils.find_resource(
db_configurations, parsed_args.configuration_group)
db_configurations.delete(configuration)
except Exception as e:
msg = (_("Failed to delete configuration %(c_group)s: %(e)s")
% {'c_group': parsed_args.configuration_group, 'e': e})
raise exceptions.CommandError(msg)
class CreateDatabaseConfiguration(command.ShowOne):
_description = _("Creates a configuration group.")
def get_parser(self, prog_name):
parser = super(CreateDatabaseConfiguration, self).get_parser(prog_name)
parser.add_argument(
'name',
metavar='<name>',
help=_('Name of the configuration group.'),
)
parser.add_argument(
'values',
metavar='<values>',
help=_('Dictionary of the values to set.'),
)
parser.add_argument(
'--datastore',
metavar='<datastore>',
default=None,
help=_('Datastore assigned to the configuration group. Required '
'if default datastore is not configured.'),
)
parser.add_argument(
'--datastore-version',
metavar='<datastore_version>',
default=None,
help=_('Datastore version ID assigned to the '
'configuration group.'),
)
parser.add_argument(
'--datastore-version-number',
default=None,
help=_('The version number for the database. The version number '
'is needed for the datastore versions with the same name.'),
)
parser.add_argument(
'--description',
metavar='<description>',
default=None,
help=_('An optional description for the configuration group.'),
)
return parser
def take_action(self, parsed_args):
db_configurations = self.app.client_manager.database.configurations
config_grp = db_configurations.create(
parsed_args.name,
parsed_args.values,
description=parsed_args.description,
datastore=parsed_args.datastore,
datastore_version=parsed_args.datastore_version,
datastore_version_number=parsed_args.datastore_version_number)
config_grp = set_attributes_for_print_detail(config_grp)
return zip(*sorted(config_grp.items()))
class AttachDatabaseConfiguration(command.Command):
_description = _("Attaches a configuration group to an instance.")
def get_parser(self, prog_name):
parser = super(AttachDatabaseConfiguration, self).get_parser(prog_name)
parser.add_argument(
'instance',
metavar='<instance>',
type=str,
help=_('ID or name of the instance'),
)
parser.add_argument(
'configuration',
metavar='<configuration>',
type=str,
help=_('ID or name of the configuration group to attach to the '
'instance.'),
)
return parser
def take_action(self, parsed_args):
manager = self.app.client_manager.database
db_instances = manager.instances
db_configurations = manager.configurations
instance_id = parsed_args.instance
config_id = parsed_args.configuration
if not uuidutils.is_uuid_like(instance_id):
instance_id = osc_utils.find_resource(db_instances, instance_id)
if not uuidutils.is_uuid_like(config_id):
config_id = osc_utils.find_resource(db_configurations, config_id)
db_instances.update(instance_id, configuration=config_id)
class DetachDatabaseConfiguration(command.Command):
_description = _("Detaches a configuration group from an instance.")
def get_parser(self, prog_name):
parser = super(DetachDatabaseConfiguration, self).get_parser(prog_name)
parser.add_argument(
'instance',
metavar='<instance>',
type=str,
help=_('ID or name of the instance.'),
)
return parser
def take_action(self, parsed_args):
db_instances = self.app.client_manager.database.instances
instance_id = parsed_args.instance
if not uuidutils.is_uuid_like(instance_id):
instance_id = osc_utils.find_resource(db_instances, instance_id)
db_instances.update(instance_id, remove_configuration=True)
class ListDatabaseConfigurationInstances(command.Lister):
_description = _("Lists all instances associated "
"with a configuration group.")
columns = ['ID', 'Name']
def get_parser(self, prog_name):
parser = super(ListDatabaseConfigurationInstances, self).\
get_parser(prog_name)
parser.add_argument(
'configuration_group',
metavar='<configuration_group>',
help=_('ID or name of the configuration group.')
)
parser.add_argument(
'--limit',
metavar='<limit>',
default=None,
type=int,
help=_('Limit the number of results displayed.')
)
parser.add_argument(
'--marker',
metavar='<ID>',
default=None,
type=str,
help=_('Begin displaying the results for IDs greater than the '
'specified marker. When used with --limit, set this to '
'the last ID displayed in the previous run.')
)
return parser
def take_action(self, parsed_args):
db_configurations = self.app.client_manager.database.configurations
configuration = osc_utils.find_resource(
db_configurations, parsed_args.configuration_group)
params = db_configurations.instances(configuration,
limit=parsed_args.limit,
marker=parsed_args.marker)
instance = [osc_utils.get_item_properties(p, self.columns)
for p in params]
return self.columns, instance
class DefaultDatabaseConfiguration(command.ShowOne):
_description = _("Shows the default configuration of an instance.")
def get_parser(self, prog_name):
parser = super(DefaultDatabaseConfiguration, self).get_parser(
prog_name)
parser.add_argument(
'instance',
metavar='<instance>',
type=str,
help=_('ID or name of the instance.'),
)
return parser
def take_action(self, parsed_args):
db_instances = self.app.client_manager.database.instances
instance = osc_utils.find_resource(db_instances,
parsed_args.instance)
configs = db_instances.configuration(instance)
return zip(*sorted(configs._info['configuration'].items()))
class SetDatabaseConfiguration(command.Command):
_description = _("Change parameters for a configuration group.")
def get_parser(self, prog_name):
parser = super(SetDatabaseConfiguration, self).get_parser(prog_name)
parser.add_argument(
'configuration_group_id',
help=_('Configuration group ID.'),
)
parser.add_argument(
'values',
metavar='<values>',
help=_('Dictionary of the new values to set.'),
)
return parser
def take_action(self, parsed_args):
db_configurations = self.app.client_manager.database.configurations
db_configurations.edit(
parsed_args.configuration_group_id,
parsed_args.values
)
class UpdateDatabaseConfiguration(command.Command):
_description = _("Update a configuration group.")
def get_parser(self, prog_name):
parser = super(UpdateDatabaseConfiguration, self).get_parser(prog_name)
parser.add_argument(
'configuration_group_id',
help=_('Configuration group ID.'),
)
parser.add_argument(
'values',
metavar='<values>',
help=_('Dictionary of the values to set.'),
)
parser.add_argument(
'--name',
metavar='<name>',
help=_('New name of the configuration group.'),
)
parser.add_argument(
'--description',
metavar='<description>',
default=None,
help=_('An optional description for the configuration group.'),
)
return parser
def take_action(self, parsed_args):
db_configurations = self.app.client_manager.database.configurations
db_configurations.update(
parsed_args.configuration_group_id,
parsed_args.values,
name=parsed_args.name,
description=parsed_args.description
)