openstack
/
cinder
Code Issues Proposed changes

Merge "Update manage with cluster related commands"

This commit is contained in:
Jenkins 2016-07-26 10:47:31 +00:00 committed by Gerrit Code Review
parent 0f55be694f 62f761ff16
commit 9a3cdc7ff0
4 changed files with 301 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
cinder/cmd/manage.py
View File

@ -436,13 +436,23 @@ class BackupCommands(object):
bk.save()
class ServiceCommands(object):
class BaseCommand(object):
@staticmethod
def _normalize_time(time_field):
return time_field and timeutils.normalize_time(time_field)
@staticmethod
def _state_repr(is_up):
return ':-)' if is_up else 'XXX'
class ServiceCommands(BaseCommand):
"""Methods for managing services."""
def list(self):
"""Show a list of all cinder services."""
ctxt = context.get_admin_context()
services = objects.ServiceList.get_all(ctxt)
print_format = "%-16s %-36s %-16s %-10s %-5s %-20s %-12s %-15s"
print_format = "%-16s %-36s %-16s %-10s %-5s %-20s %-12s %-15s %-36s"
print(print_format % (_('Binary'),
_('Host'),
_('Zone'),
@ -450,23 +460,20 @@ class ServiceCommands(object):
_('State'),
_('Updated At'),
_('RPC Version'),
_('Object Version')))
_('Object Version'),
_('Cluster')))
for svc in services:
alive = utils.service_is_up(svc)
art = ":-)" if alive else "XXX"
status = 'enabled'
if svc.disabled:
status = 'disabled'
updated_at = svc.updated_at
if updated_at:
updated_at = timeutils.normalize_time(updated_at)
art = self._state_repr(utils.service_is_up(svc))
status = 'disabled' if svc.disabled else 'enabled'
updated_at = self._normalize_time(svc.updated_at)
rpc_version = (svc.rpc_current_version or
rpc.LIBERTY_RPC_VERSIONS.get(svc.binary, ''))
object_version = (svc.object_current_version or 'liberty')
cluster = svc.cluster_name or ''
print(print_format % (svc.binary, svc.host.partition('.')[0],
svc.availability_zone, status, art,
updated_at, rpc_version,
object_version))
updated_at, rpc_version, object_version,
cluster))
@args('binary', type=str,
help='Service to delete from the host.')
@ -487,9 +494,109 @@ class ServiceCommands(object):
print(_("Service %(service)s on host %(host)s removed.") %
{'service': binary, 'host': host_name})
class ClusterCommands(BaseCommand):
"""Methods for managing clusters."""
def list(self):
"""Show a list of all cinder services."""
ctxt = context.get_admin_context()
clusters = objects.ClusterList.get_all(ctxt, services_summary=True)
print_format = "%-36s %-16s %-10s %-5s %-20s %-7s %-12s %-20s"
print(print_format % (_('Name'),
_('Binary'),
_('Status'),
_('State'),
_('Heartbeat'),
_('Hosts'),
_('Down Hosts'),
_('Updated At')))
for cluster in clusters:
art = self._state_repr(cluster.is_up())
status = 'disabled' if cluster.disabled else 'enabled'
heartbeat = self._normalize_time(cluster.last_heartbeat)
updated_at = self._normalize_time(cluster.updated_at)
print(print_format % (cluster.name, cluster.binary, status, art,
heartbeat, cluster.num_hosts,
cluster.num_down_hosts, updated_at))
@args('--recursive', action='store_true', default=False,
help='Delete associated hosts.')
@args('binary', type=str,
help='Service to delete from the cluster.')
@args('cluster-name', type=str, help='Cluster to delete.')
def remove(self, recursive, binary, cluster_name):
"""Completely removes a cluster."""
ctxt = context.get_admin_context()
try:
cluster = objects.Cluster.get_by_id(ctxt, None, name=cluster_name,
binary=binary,
get_services=recursive)
except exception.ClusterNotFound:
print(_("Couldn't remove cluster %s because it doesn't exist.") %
cluster_name)
return 2
if recursive:
for service in cluster.services:
service.destroy()
try:
cluster.destroy()
except exception.ClusterHasHosts:
print(_("Couldn't remove cluster %s because it still has hosts.") %
cluster_name)
return 2
msg = _('Cluster %s successfully removed.') % cluster_name
if recursive:
msg = (_('%(msg)s And %(num)s services from the cluster were also '
'removed.') % {'msg': msg, 'num': len(cluster.services)})
print(msg)
@args('--full-rename', dest='partial',
action='store_false', default=True,
help='Do full cluster rename instead of just replacing provided '
'current cluster name and preserving backend and/or pool info.')
@args('current', help='Current cluster name.')
@args('new', help='New cluster name.')
def rename(self, partial, current, new):
"""Rename cluster name for Volumes and Consistency Groups.
Useful when you want to rename a cluster, particularly when the
backend_name has been modified in a multi-backend config or we have
moved from a single backend to multi-backend.
"""
ctxt = context.get_admin_context()
# Convert empty strings to None
current = current or None
new = new or None
# Update Volumes
num_vols = objects.VolumeList.include_in_cluster(
ctxt, new, partial_rename=partial, cluster_name=current)
# Update Consistency Groups
num_cgs = objects.ConsistencyGroupList.include_in_cluster(
ctxt, new, partial_rename=partial, cluster_name=current)
if num_vols or num_cgs:
msg = _('Successfully renamed %(num_vols)s volumes and '
'%(num_cgs)s consistency groups from cluster %(current)s '
'to %(new)s')
print(msg % {'num_vols': num_vols, 'num_cgs': num_cgs, 'new': new,
'current': current})
else:
msg = _('No volumes or consistency groups exist in cluster '
'%(current)s.')
print(msg % {'current': current})
return 2
CATEGORIES = {
'backup': BackupCommands,
'config': ConfigCommands,
'cluster': ClusterCommands,
'db': DbCommands,
'host': HostCommands,
'logs': GetLogCommands,

8
cinder/tests/unit/fake_service.py
View File

@ -15,9 +15,17 @@
from oslo_utils import timeutils
from oslo_versionedobjects import fields
from cinder.db.sqlalchemy import models
from cinder import objects
def fake_service_orm(**updates):
"""Create a fake ORM service instance."""
db_service = fake_db_service(**updates)
service = models.Service(**db_service)
return service
def fake_db_service(**updates):
NOW = timeutils.utcnow().replace(microsecond=0)
db_service = {

174
cinder/tests/unit/test_cmd.py
View File

@ -16,6 +16,7 @@ import sys
import ddt
import mock
from oslo_config import cfg
from oslo_utils import timeutils
import six
from cinder import rpc
@ -38,7 +39,9 @@ from cinder import context
from cinder import exception
from cinder.objects import fields
from cinder import test
from cinder.tests.unit import fake_cluster
from cinder.tests.unit import fake_constants as fake
from cinder.tests.unit import fake_service
from cinder.tests.unit import fake_volume
from cinder import version
@ -722,7 +725,7 @@ class TestCinderManageCmd(test.TestCase):
service_get_all.return_value = [service]
service_is_up.return_value = True
with mock.patch('sys.stdout', new=six.StringIO()) as fake_out:
format = "%-16s %-36s %-16s %-10s %-5s %-20s %-12s %-15s"
format = "%-16s %-36s %-16s %-10s %-5s %-20s %-12s %-15s %-36s"
print_format = format % ('Binary',
'Host',
'Zone',
@ -730,13 +733,15 @@ class TestCinderManageCmd(test.TestCase):
'State',
'Updated At',
'RPC Version',
'Object Version')
'Object Version',
'Cluster')
rpc_version = service['rpc_current_version']
if not rpc_version:
rpc_version = rpc.LIBERTY_RPC_VERSIONS[service['binary']]
object_version = service['object_current_version']
if not object_version:
object_version = 'liberty'
cluster = service.get('cluster_name', '')
service_format = format % (service['binary'],
service['host'].partition('.')[0],
service['availability_zone'],
@ -744,7 +749,8 @@ class TestCinderManageCmd(test.TestCase):
':-)',
service['updated_at'],
rpc_version,
object_version)
object_version,
cluster)
expected_out = print_format + '\n' + service_format + '\n'
service_cmds = cinder_manage.ServiceCommands()
@ -761,12 +767,13 @@ class TestCinderManageCmd(test.TestCase):
'updated_at': '2014-06-30 11:22:33',
'disabled': False,
'rpc_current_version': '1.1',
'object_current_version': '1.1'}
'object_current_version': '1.1',
'cluster_name': 'my_cluster'}
for binary in ('volume', 'scheduler', 'backup'):
service['binary'] = 'cinder-%s' % binary
self._test_service_commands_list(service)
def test_service_commands_list_no_updated_at(self):
def test_service_commands_list_no_updated_at_or_cluster(self):
service = {'binary': 'cinder-binary',
'host': 'fake-host.fake-domain',
'availability_zone': 'fake-zone',
@ -801,6 +808,163 @@ class TestCinderManageCmd(test.TestCase):
self.assertDictEqual(expected,
cinder_manage.fetch_func_args(my_func))
@mock.patch('cinder.context.get_admin_context')
@mock.patch('cinder.db.cluster_get_all')
def tests_cluster_commands_list(self, get_all_mock, get_admin_mock,
):
now = timeutils.utcnow()
cluster = fake_cluster.fake_cluster_orm(num_hosts=4, num_down_hosts=2,
created_at=now,
last_heartbeat=now)
get_all_mock.return_value = [cluster]
ctxt = context.RequestContext(fake.USER_ID, fake.PROJECT_ID)
get_admin_mock.return_value = ctxt
with mock.patch('sys.stdout', new=six.StringIO()) as fake_out:
format_ = "%-36s %-16s %-10s %-5s %-20s %-7s %-12s %-20s"
print_format = format_ % ('Name',
'Binary',
'Status',
'State',
'Heartbeat',
'Hosts',
'Down Hosts',
'Updated At')
cluster_format = format_ % (cluster.name, cluster.binary,
'enabled', ':-)',
cluster.last_heartbeat,
cluster.num_hosts,
cluster.num_down_hosts,
None)
expected_out = print_format + '\n' + cluster_format + '\n'
cluster_cmds = cinder_manage.ClusterCommands()
cluster_cmds.list()
self.assertEqual(expected_out, fake_out.getvalue())
get_admin_mock.assert_called_with()
get_all_mock.assert_called_with(ctxt, is_up=None,
get_services=False,
services_summary=True,
read_deleted='no')
@mock.patch('cinder.db.sqlalchemy.api.cluster_get', auto_specs=True)
@mock.patch('cinder.context.get_admin_context')
def test_cluster_commands_remove_not_found(self, admin_ctxt_mock,
cluster_get_mock):
cluster_get_mock.side_effect = exception.ClusterNotFound(id=1)
cluster_commands = cinder_manage.ClusterCommands()
exit = cluster_commands.remove(False, 'abinary', 'acluster')
self.assertEqual(2, exit)
cluster_get_mock.assert_called_once_with(admin_ctxt_mock.return_value,
None, name='acluster',
binary='abinary',
get_services=False)
@mock.patch('cinder.db.sqlalchemy.api.service_destroy', auto_specs=True)
@mock.patch('cinder.db.sqlalchemy.api.cluster_destroy', auto_specs=True)
@mock.patch('cinder.db.sqlalchemy.api.cluster_get', auto_specs=True)
@mock.patch('cinder.context.get_admin_context')
def test_cluster_commands_remove_fail_has_hosts(self, admin_ctxt_mock,
cluster_get_mock,
cluster_destroy_mock,
service_destroy_mock):
cluster = fake_cluster.fake_cluster_ovo(mock.Mock())
cluster_get_mock.return_value = cluster
cluster_destroy_mock.side_effect = exception.ClusterHasHosts(id=1)
cluster_commands = cinder_manage.ClusterCommands()
exit = cluster_commands.remove(False, 'abinary', 'acluster')
self.assertEqual(2, exit)
cluster_get_mock.assert_called_once_with(admin_ctxt_mock.return_value,
None, name='acluster',
binary='abinary',
get_services=False)
cluster_destroy_mock.assert_called_once_with(
admin_ctxt_mock.return_value.elevated.return_value, cluster.id)
service_destroy_mock.assert_not_called()
@mock.patch('cinder.db.sqlalchemy.api.service_destroy', auto_specs=True)
@mock.patch('cinder.db.sqlalchemy.api.cluster_destroy', auto_specs=True)
@mock.patch('cinder.db.sqlalchemy.api.cluster_get', auto_specs=True)
@mock.patch('cinder.context.get_admin_context')
def test_cluster_commands_remove_success_no_hosts(self, admin_ctxt_mock,
cluster_get_mock,
cluster_destroy_mock,
service_destroy_mock):
cluster = fake_cluster.fake_cluster_orm()
cluster_get_mock.return_value = cluster
cluster_commands = cinder_manage.ClusterCommands()
exit = cluster_commands.remove(False, 'abinary', 'acluster')
self.assertIsNone(exit)
cluster_get_mock.assert_called_once_with(admin_ctxt_mock.return_value,
None, name='acluster',
binary='abinary',
get_services=False)
cluster_destroy_mock.assert_called_once_with(
admin_ctxt_mock.return_value.elevated.return_value, cluster.id)
service_destroy_mock.assert_not_called()
@mock.patch('cinder.db.sqlalchemy.api.service_destroy', auto_specs=True)
@mock.patch('cinder.db.sqlalchemy.api.cluster_destroy', auto_specs=True)
@mock.patch('cinder.db.sqlalchemy.api.cluster_get', auto_specs=True)
@mock.patch('cinder.context.get_admin_context')
def test_cluster_commands_remove_recursive(self, admin_ctxt_mock,
cluster_get_mock,
cluster_destroy_mock,
service_destroy_mock):
cluster = fake_cluster.fake_cluster_orm()
cluster.services = [fake_service.fake_service_orm()]
cluster_get_mock.return_value = cluster
cluster_commands = cinder_manage.ClusterCommands()
exit = cluster_commands.remove(True, 'abinary', 'acluster')
self.assertIsNone(exit)
cluster_get_mock.assert_called_once_with(admin_ctxt_mock.return_value,
None, name='acluster',
binary='abinary',
get_services=True)
cluster_destroy_mock.assert_called_once_with(
admin_ctxt_mock.return_value.elevated.return_value, cluster.id)
service_destroy_mock.assert_called_once_with(
admin_ctxt_mock.return_value.elevated.return_value,
cluster.services[0]['id'])
@mock.patch('cinder.db.sqlalchemy.api.volume_include_in_cluster',
auto_specs=True, return_value=1)
@mock.patch('cinder.db.sqlalchemy.api.consistencygroup_include_in_cluster',
auto_specs=True, return_value=2)
@mock.patch('cinder.context.get_admin_context')
def test_cluster_commands_rename(self, admin_ctxt_mock,
volume_include_mock, cg_include_mock):
"""Test that cluster rename changes volumes and cgs."""
current_cluster_name = mock.sentinel.old_cluster_name
new_cluster_name = mock.sentinel.new_cluster_name
partial = mock.sentinel.partial
cluster_commands = cinder_manage.ClusterCommands()
exit = cluster_commands.rename(partial, current_cluster_name,
new_cluster_name)
self.assertIsNone(exit)
volume_include_mock.assert_called_once_with(
admin_ctxt_mock.return_value, new_cluster_name, partial,
cluster_name=current_cluster_name)
cg_include_mock.assert_called_once_with(
admin_ctxt_mock.return_value, new_cluster_name, partial,
cluster_name=current_cluster_name)
@mock.patch('cinder.db.sqlalchemy.api.volume_include_in_cluster',
auto_specs=True, return_value=0)
@mock.patch('cinder.db.sqlalchemy.api.consistencygroup_include_in_cluster',
auto_specs=True, return_value=0)
@mock.patch('cinder.context.get_admin_context')
def test_cluster_commands_rename_no_changes(self, admin_ctxt_mock,
volume_include_mock,
cg_include_mock):
"""Test that we return an error when cluster rename has no effect."""
cluster_commands = cinder_manage.ClusterCommands()
exit = cluster_commands.rename(False, 'cluster', 'new_cluster')
self.assertEqual(2, exit)
@mock.patch('oslo_config.cfg.ConfigOpts.register_cli_opt')
def test_main_argv_lt_2(self, register_cli_opt):
script_name = 'cinder-manage'

4
releasenotes/notes/cluster_job_distribution-f916dd2e4cce6c1b.yaml
View File

@ -10,3 +10,7 @@ features:
- "HA A-A: Add cluster configuration option to allow grouping hosts that
share the same backend configurations and should work in Active-Active
fashion."
- "HA A-A: Updated manage command to display cluster information on service
listings."
- "HA A-A: Added cluster subcommand in manage command to list, remove, and
rename clusters."