Laura Mooreandvsaienko
e5c5ddbdc8
Ironic should be able to provide the requisite connectivity information to the Neutron ML2 plugin to allow drivers to provision the top-of-rack switch for the bare metal server. The addition of portgroups in Ironic allows the concept of link aggregation to be handled in Ironic in order to provide support for cases where multiple interfaces on the bare metal server connect to switch ports of a single LAG. This commit includes changes to: - the port vif mapping to also use portgroups Partial-bug: #1526403 DocImpact Co-Authored-By: Jenny Moorehead (jenny.moorehead@sap.com) Co-Authored-By: Will Stevenson (will.stevenson@sap.com) Co-Authored-By: Vasyl Saienko (vsaienko@mirantis.com) Change-Id: I7f1cba65275078da750aa49ae83ba7345d6fd5e0
108 lines
3.5 KiB
Python
108 lines
3.5 KiB
Python
# Copyright 2014 Rackspace, 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.
|
|
|
|
"""
|
|
Abstract base class for dhcp providers.
|
|
"""
|
|
|
|
import abc
|
|
|
|
import six
|
|
|
|
|
|
@six.add_metaclass(abc.ABCMeta)
|
|
class BaseDHCP(object):
|
|
"""Base class for DHCP provider APIs."""
|
|
|
|
@abc.abstractmethod
|
|
def update_port_dhcp_opts(self, port_id, dhcp_options, token=None):
|
|
"""Update one or more DHCP options on the specified port.
|
|
|
|
:param port_id: designate which port these attributes
|
|
will be applied to.
|
|
:param dhcp_options: this will be a list of dicts, e.g.
|
|
|
|
::
|
|
|
|
[{'opt_name': 'bootfile-name',
|
|
'opt_value': 'pxelinux.0'},
|
|
{'opt_name': 'server-ip-address',
|
|
'opt_value': '123.123.123.456'},
|
|
{'opt_name': 'tftp-server',
|
|
'opt_value': '123.123.123.123'}]
|
|
:param token: An optional authenticaiton token.
|
|
|
|
:raises: FailedToUpdateDHCPOptOnPort
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def update_port_address(self, port_id, address, token=None):
|
|
"""Update a port's MAC address.
|
|
|
|
:param port_id: port id.
|
|
:param address: new MAC address.
|
|
:param token: An optional authenticaiton token.
|
|
|
|
:raises: FailedToUpdateMacOnPort
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def update_dhcp_opts(self, task, options, vifs=None):
|
|
"""Send or update the DHCP BOOT options for this node.
|
|
|
|
:param task: A TaskManager instance.
|
|
:param options: this will be a list of dicts, e.g.
|
|
|
|
::
|
|
|
|
[{'opt_name': 'bootfile-name',
|
|
'opt_value': 'pxelinux.0'},
|
|
{'opt_name': 'server-ip-address',
|
|
'opt_value': '123.123.123.456'},
|
|
{'opt_name': 'tftp-server',
|
|
'opt_value': '123.123.123.123'}]
|
|
|
|
:param vifs: A dict with keys 'ports' and 'portgroups' and
|
|
dicts as values. Each dict has key/value pairs of the form
|
|
<ironic UUID>:<neutron port UUID>. e.g.
|
|
|
|
::
|
|
|
|
{'ports': {'port.uuid': vif.id},
|
|
'portgroups': {'portgroup.uuid': vif.id}}
|
|
|
|
If the value is None, will get the list of ports/portgroups
|
|
from the Ironic port/portgroup objects.
|
|
:raises: FailedToUpdateDHCPOptOnPort
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def get_ip_addresses(self, task):
|
|
"""Get IP addresses for all ports/portgroups in `task`.
|
|
|
|
:param task: A TaskManager instance.
|
|
:returns: List of IP addresses associated with
|
|
task's ports and portgroups.
|
|
"""
|
|
|
|
def clean_dhcp_opts(self, task):
|
|
"""Clean up the DHCP BOOT options for all ports in `task`.
|
|
|
|
:param task: A TaskManager instance.
|
|
|
|
:raises: FailedToCleanDHCPOpts
|
|
"""
|
|
pass
|