python-novaclient/novaclient/v2/server_groups.py
Yikun Jiang 6c398058a6 Microversion 2.64 - Use new format policy in server group
Added support for microversion 2.64, which includes the
following changes:

- The ``--rule`` option is added to the
``nova server-group-create`` CLI that enables user to create
server group with specific policy rules.

- Remove ``metadata`` column in the output of
``nova server-group-create``, ``nova server-group-get``,
``nova server-group-list``.

- Remove ``policies`` column, , add ``policy`` and ``rules``
columns in the output of ``nova server-group-create``,
``nova server-group-get``, ``nova server-group-list``.

Depends-On: 3cd26f1e68b09ba7925e794ac8912566c239b6df
blueprint: complex-anti-affinity-policies

Change-Id: I903f4b5544806b9d3c8bac529448abbc9dd3cee9
2018-07-18 10:30:00 -04:00

125 lines
4.2 KiB
Python

# Copyright (c) 2014 VMware, Inc.
# 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.
"""
Server group interface.
"""
from novaclient import api_versions
from novaclient import base
from novaclient import exceptions
from novaclient.i18n import _
class ServerGroup(base.Resource):
"""
A server group.
"""
def __repr__(self):
return '<ServerGroup: %s>' % self.id
def delete(self):
"""
Delete this server group.
:returns: An instance of novaclient.base.TupleWithMeta
"""
return self.manager.delete(self.id)
class ServerGroupsManager(base.ManagerWithFind):
"""
Manage :class:`ServerGroup` resources.
"""
resource_class = ServerGroup
def list(self, all_projects=False, limit=None, offset=None):
"""Get a list of all server groups.
:param all_projects: Lists server groups for all projects. (optional)
:param limit: Maximum number of server groups to return. (optional)
:param offset: Use with `limit` to return a slice of server
groups. `offset` is where to start in the groups
list. (optional)
:returns: list of :class:`ServerGroup`.
"""
qparams = {}
if all_projects:
qparams['all_projects'] = bool(all_projects)
if limit:
qparams['limit'] = int(limit)
if offset:
qparams['offset'] = int(offset)
return self._list('/os-server-groups', 'server_groups',
filters=qparams)
def get(self, id):
"""Get a specific server group.
:param id: The ID of the :class:`ServerGroup` to get.
:rtype: :class:`ServerGroup`
"""
return self._get('/os-server-groups/%s' % id,
'server_group')
def delete(self, id):
"""Delete a specific server group.
:param id: The ID of the :class:`ServerGroup` to delete.
:returns: An instance of novaclient.base.TupleWithMeta
"""
return self._delete('/os-server-groups/%s' % id)
@api_versions.wraps("2.0", "2.63")
def create(self, name, policies):
"""Create (allocate) a server group.
:param name: The name of the server group.
:param policies: Policy name or a list of exactly one policy name to
associate with the server group.
:rtype: list of :class:`ServerGroup`
"""
policies = policies if isinstance(policies, list) else [policies]
body = {'server_group': {'name': name,
'policies': policies}}
return self._create('/os-server-groups', body, 'server_group')
@api_versions.wraps("2.64")
def create(self, name, policy, rules=None):
"""Create (allocate) a server group.
:param name: The name of the server group.
:param policy: Policy name to associate with the server group.
:param rules: The rules of policy which is a dict, can be applied to
the policy, now only ``max_server_per_host`` for ``anti-affinity``
policy would be supported (optional).
:rtype: list of :class:`ServerGroup`
"""
body = {'server_group': {
'name': name, 'policy': policy
}}
if rules:
key = 'max_server_per_host'
try:
if key in rules:
rules[key] = int(rules[key])
except ValueError:
msg = _("Invalid '%(key)s' value: %(value)s")
raise exceptions.CommandError(msg % {
'key': key, 'value': rules[key]})
body['server_group']['rules'] = rules
return self._create('/os-server-groups', body, 'server_group')