Merge "Auto allocated topology for OSC"

This commit is contained in:
Jenkins 2017-03-01 18:03:19 +00:00 committed by Gerrit Code Review
commit 3816433b53
7 changed files with 507 additions and 0 deletions

View File

@ -0,0 +1,69 @@
===============================
network auto allocated topology
===============================
An **auto allocated topology** allows admins to quickly set up external
connectivity for end-users. Only one auto allocated topology is allowed per
project. For more information on how to set up the resources required
for auto allocated topology review the documentation at:
http://docs.openstack.org/newton/networking-guide/config-auto-allocation.html
Network v2
network auto allocated topology create
--------------------------------------
Create the auto allocated topology for project
.. program:: network auto allocated topology create
.. code:: bash
openstack network auto allocated topology create
[--or-show]
[--check-resources]
[--project <project> [--project-domain <project-domain>]]
.. option:: --or-show
If topology exists returns the topologies information (Default).
.. option:: --check-resources
Validate the requirements for auto allocated topology.
Does not return a topology.
.. option:: --project <project>
Return the auto allocated topology for a given project.
Default is current project.
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. _network_auto_allocated_topology_create:
network auto allocated topology delete
--------------------------------------
Delete auto allocated topology for project
.. program:: network auto allocated topology delete
.. code:: bash
openstack network auto allocated topology delete
[--project <project> [--project-domain <project-domain>]]
.. option:: --project <project>
Delete auto allocated topology for a given project.
Default is the current project.
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. _network_auto_allocated_topology_delete:

View File

@ -111,6 +111,7 @@ referring to both Compute and Volume quotas.
* ``module``: (**Internal**) - installed Python modules in the OSC process
* ``network``: (**Compute**, **Network**) - a virtual network for connecting servers and other resources
* ``network agent``: (**Network**) - A network agent is an agent that handles various tasks used to implement virtual networks
* ``network auto allocated topology``: (**Network**) - an auto-allocated topology for a project
* ``network flavor``: (**Network**) - allows the user to choose the type of service by a set of advertised service capabilities (e.g., LOADBALANCER, FWAAS, L3, VPN, etc) rather than by a provider type or named vendor
* ``network meter``: (**Network**) - allow traffic metering in a network
* ``network meter rule``: (**Network**) - rules for network traffic metering

View File

@ -0,0 +1,136 @@
# 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.
#
"""Auto-allocated Topology Implementations"""
import logging
from osc_lib.command import command
from osc_lib import utils
from openstackclient.i18n import _
from openstackclient.identity import common as identity_common
from openstackclient.network import sdk_utils
LOG = logging.getLogger(__name__)
def _get_columns(item):
column_map = {
'tenant_id': 'project_id',
}
return sdk_utils.get_osc_show_columns_for_sdk_resource(item, column_map)
def _format_check_resource_columns():
return ('dry_run',)
def _format_check_resource(item):
item_id = getattr(item, 'id', False)
if item_id == 'dry-run=pass':
item.check_resource = 'pass'
return item
def _get_attrs(client_manager, parsed_args):
attrs = {}
if parsed_args.project:
identity_client = client_manager.identity
project_id = identity_common.find_project(
identity_client,
parsed_args.project,
parsed_args.project_domain,
).id
attrs['tenant_id'] = project_id
if parsed_args.check_resources:
attrs['check_resources'] = True
return attrs
# TODO(ankur-gupta-f): Use the SDK resource mapped attribute names once the
# OSC minimum requirements include SDK 1.0.
class CreateAutoAllocatedTopology(command.ShowOne):
_description = _("Create the auto allocated topology for project")
def get_parser(self, prog_name):
parser = super(CreateAutoAllocatedTopology, self).get_parser(prog_name)
parser.add_argument(
'--project',
metavar='<project>',
help=_("Return the auto allocated topology for a given project. "
"Default is current project")
)
identity_common.add_project_domain_option_to_parser(parser)
parser.add_argument(
'--check-resources',
action='store_true',
help=_("Validate the requirements for auto allocated topology. "
"Does not return a topology.")
)
parser.add_argument(
'--or-show',
action='store_true',
default=True,
help=_("If topology exists returns the topology's "
"information (Default)")
)
return parser
def check_resource_topology(self, client, parsed_args):
obj = client.validate_auto_allocated_topology(parsed_args.project)
columns = _format_check_resource_columns()
data = utils.get_item_properties(_format_check_resource(obj),
columns,
formatters={})
return (columns, data)
def get_topology(self, client, parsed_args):
obj = client.get_auto_allocated_topology(parsed_args.project)
display_columns, columns = _get_columns(obj)
data = utils.get_item_properties(obj, columns, formatters={})
return (display_columns, data)
def take_action(self, parsed_args):
client = self.app.client_manager.network
if parsed_args.check_resources:
columns, data = self.check_resource_topology(client, parsed_args)
else:
columns, data = self.get_topology(client, parsed_args)
return (columns, data)
# TODO(ankur-gupta-f): Use the SDK resource mapped attribute names once the
# OSC minimum requirements include SDK 1.0.
class DeleteAutoAllocatedTopology(command.Command):
_description = _("Delete auto allocated topology for project")
def get_parser(self, prog_name):
parser = super(DeleteAutoAllocatedTopology, self).get_parser(prog_name)
parser.add_argument(
'--project',
metavar='<project>',
help=_('Delete auto allocated topology for a given project. '
'Default is the current project')
)
identity_common.add_project_domain_option_to_parser(parser)
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.network
client.delete_auto_allocated_topology(parsed_args.project)

View File

@ -157,6 +157,31 @@ class FakeAddressScope(object):
return mock.Mock(side_effect=address_scopes)
class FakeAutoAllocatedTopology(object):
"""Fake Auto Allocated Topology"""
@staticmethod
def create_one_topology(attrs=None):
attrs = attrs or {}
auto_allocated_topology_attrs = {
'id': 'network-id-' + uuid.uuid4().hex,
'tenant_id': 'project-id-' + uuid.uuid4().hex,
}
auto_allocated_topology_attrs.update(attrs)
auto_allocated_topology = fakes.FakeResource(
info=copy.deepcopy(auto_allocated_topology_attrs),
loaded=True)
auto_allocated_topology.project_id = auto_allocated_topology_attrs[
'tenant_id'
]
return auto_allocated_topology
class FakeAvailabilityZone(object):
"""Fake one or more network availability zones (AZs)."""

View File

@ -0,0 +1,267 @@
# Copyright (c) 2016, Intel Corporation.
# 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.
import mock
from openstackclient.network.v2 import network_auto_allocated_topology
from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
from openstackclient.tests.unit.network.v2 import fakes as network_fakes
class TestAutoAllocatedTopology(network_fakes.TestNetworkV2):
def setUp(self):
super(TestAutoAllocatedTopology, self).setUp()
self.network = self.app.client_manager.network
self.projects_mock = self.app.client_manager.identity.projects
class TestCreateAutoAllocatedTopology(TestAutoAllocatedTopology):
project = identity_fakes.FakeProject.create_one_project()
network_object = network_fakes.FakeNetwork.create_one_network()
topology = network_fakes.FakeAutoAllocatedTopology.create_one_topology(
attrs={'id': network_object.id,
'tenant_id': project.id}
)
columns = (
'id',
'project_id',
)
data = (
network_object.id,
project.id,
)
def setUp(self):
super(TestCreateAutoAllocatedTopology, self).setUp()
self.cmd = network_auto_allocated_topology.CreateAutoAllocatedTopology(
self.app,
self.namespace)
self.network.get_auto_allocated_topology = mock.Mock(
return_value=self.topology)
def test_create_no_options(self):
arglist = []
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.network.get_auto_allocated_topology.assert_called_with(None)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, data)
def test_create_project_option(self):
arglist = [
'--project', self.project.id,
]
verifylist = [
('project', self.project.id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.network.get_auto_allocated_topology.assert_called_with(
self.project.id
)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, data)
def test_create_project_domain_option(self):
arglist = [
'--project', self.project.id,
'--project-domain', self.project.domain_id,
]
verifylist = [
('project', self.project.id),
('project_domain', self.project.domain_id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.network.get_auto_allocated_topology.assert_called_with(
self.project.id
)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, data)
def test_create_or_show_option(self):
arglist = [
'--or-show',
]
verifylist = [
('or_show', True),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.network.get_auto_allocated_topology.assert_called_with(None)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, data)
class TestValidateAutoAllocatedTopology(TestAutoAllocatedTopology):
project = identity_fakes.FakeProject.create_one_project()
network_object = network_fakes.FakeNetwork.create_one_network()
topology = network_fakes.FakeAutoAllocatedTopology.create_one_topology(
attrs={'id': network_object.id,
'tenant_id': project.id}
)
columns = (
'id',
'project_id',
)
data = (
network_object.id,
project.id,
)
def setUp(self):
super(TestValidateAutoAllocatedTopology, self).setUp()
self.cmd = network_auto_allocated_topology.CreateAutoAllocatedTopology(
self.app,
self.namespace)
self.network.validate_auto_allocated_topology = mock.Mock(
return_value=self.topology)
def test_show_dry_run_no_project(self):
arglist = [
'--check-resources',
]
verifylist = [
('check_resources', True),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.network.validate_auto_allocated_topology.assert_called_with(
None)
def test_show_dry_run_project_option(self):
arglist = [
'--check-resources',
'--project', self.project.id,
]
verifylist = [
('check_resources', True),
('project', self.project.id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.network.validate_auto_allocated_topology.assert_called_with(
self.project.id)
def test_show_dry_run_project_domain_option(self):
arglist = [
'--check-resources',
'--project', self.project.id,
'--project-domain', self.project.domain_id,
]
verifylist = [
('check_resources', True),
('project', self.project.id),
('project_domain', self.project.domain_id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.network.validate_auto_allocated_topology.assert_called_with(
self.project.id)
class TestDeleteAutoAllocatedTopology(TestAutoAllocatedTopology):
project = identity_fakes.FakeProject.create_one_project()
network_object = network_fakes.FakeNetwork.create_one_network()
topology = network_fakes.FakeAutoAllocatedTopology.create_one_topology(
attrs={'id': network_object.id,
'tenant_id': project.id}
)
def setUp(self):
super(TestDeleteAutoAllocatedTopology, self).setUp()
self.cmd = network_auto_allocated_topology.DeleteAutoAllocatedTopology(
self.app,
self.namespace)
self.network.delete_auto_allocated_topology = mock.Mock(
return_value=None)
def test_delete_no_project(self):
arglist = []
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.network.delete_auto_allocated_topology.assert_called_once_with(
None)
self.assertIsNone(result)
def test_delete_project_arg(self):
arglist = [
'--project', self.project.id,
]
verifylist = [
('project', self.project.id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.network.delete_auto_allocated_topology.assert_called_once_with(
self.project.id)
self.assertIsNone(result)
def test_delete_project_domain_arg(self):
arglist = [
'--project', self.project.id,
'--project-domain', self.project.domain_id,
]
verifylist = [
('project', self.project.id),
('project_domain', self.project.domain_id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.network.delete_auto_allocated_topology.assert_called_once_with(
self.project.id)
self.assertIsNone(result)

View File

@ -0,0 +1,6 @@
---
features:
- |
Add support for the ``network auto allocated topology`` command for
creating and deleting auto allocated topologies.
[Blueprint :oscbp:`network-auto-allocated-topology`]

View File

@ -360,6 +360,9 @@ openstack.network.v2 =
network_agent_set = openstackclient.network.v2.network_agent:SetNetworkAgent
network_agent_show = openstackclient.network.v2.network_agent:ShowNetworkAgent
network_auto_allocated_topology_create = openstackclient.network.v2.network_auto_allocated_topology:CreateAutoAllocatedTopology
network_auto_allocated_topology_delete = openstackclient.network.v2.network_auto_allocated_topology:DeleteAutoAllocatedTopology
network_flavor_create = openstackclient.network.v2.network_flavor:CreateNetworkFlavor
network_flavor_delete = openstackclient.network.v2.network_flavor:DeleteNetworkFlavor
network_flavor_list = openstackclient.network.v2.network_flavor:ListNetworkFlavor