Browse Source

Populate network ports env module

Add ansible module which creates/adds instnace network
ports information to a triple heat environment file.

The NodePortMap is added to 'parameter_defaults' and
resource registry overrides for overcloud port resouces
to use the network/ports/deployed_{{network.name}}.yaml
templates.

Partial-Implements: blueprint network-data-v2-ports
Change-Id: I87d66050f04bd467583990fc97ffa12d457b7d15
changes/38/764638/9
Harald Jensås 6 months ago
parent
commit
7aefbb550c
3 changed files with 315 additions and 0 deletions
  1. +14
    -0
      doc/source/modules/modules-tripleo_network_ports_populate_environment.rst
  2. +203
    -0
      tripleo_ansible/ansible_plugins/modules/tripleo_network_ports_populate_environment.py
  3. +98
    -0
      tripleo_ansible/tests/modules/test_tripleo_network_ports_populate_environment.py

+ 14
- 0
doc/source/modules/modules-tripleo_network_ports_populate_environment.rst View File

@ -0,0 +1,14 @@
===================================================
Module - tripleo_network_ports_populate_environment
===================================================
This module provides for the following ansible plugin:
* tripleo_network_ports_populate_environment
.. ansibleautoplugin::
:module: tripleo_ansible/ansible_plugins/modules/tripleo_network_ports_populate_environment.py
:documentation: true
:examples: true

+ 203
- 0
tripleo_ansible/ansible_plugins/modules/tripleo_network_ports_populate_environment.py View File

@ -0,0 +1,203 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2020 OpenStack Foundation
# 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 os
import yaml
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.openstack import openstack_full_argument_spec
from ansible.module_utils.openstack import openstack_module_kwargs
from ansible.module_utils.openstack import openstack_cloud_from_module
ANSIBLE_METADATA = {
'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'
}
DOCUMENTATION = '''
---
module: tripleo_network_ports_populate_environment
short_description: Create TripleO network port environment
version_added: "2.8"
description:
- "Create TripleO network port environment by extending the beremetal environment"
options:
environment:
description:
- Existing heat environment data to add to
type: dict
default: {}
role_net_map:
description:
- Structure with role network association
type: dict
default: {}
node_port_map:
description:
- Structure with port data mapped by node and network
type: dict
default: {}
author:
- Harald Jensås <hjensas@redhat.com>
'''
RETURN = '''
'''
EXAMPLES = '''
- name: Populate environment with network port data
tripleo_network_ports_populate_environment:
environment: {}
role_net_map:
Controller:
- external
- internal_api
- storage
- tenant
Compute:
- internal_api
- storage
- tenant
node_port_map:
controller-0:
internal_api:
ip_address: 172.18.0.9
ip_subnet: 172.18.0.9/24
ip_address_uri: 172.18.0.9
tenant:
ip_address: 172.19.0.9
ip_subnet: 172.19.0.9/24
ip_address_uri: 172.19.0.9
compute-0:
internal_api:
ip_address: 172.18.0.15
ip_subnet: 172.18.0.15/24
ip_address_uri: 172.18.0.15
tenant:
ip_address: 172.19.0.15
ip_subnet: 172.19.0.15/24
ip_address_uri: 172.19.0.15
register: environment
'''
CTLPLANE_NETWORK = 'ctlplane'
DEFAULT_THT_DIR = '/usr/share/openstack-tripleo-heat-templates'
REGISTRY_KEY_TPL = 'OS::TripleO::{role}::Ports::{net_name}Port'
PORT_PATH_TPL = 'network/ports/deployed_{net_name_lower}.yaml'
def get_net_name_map(conn, role_net_map):
map = {}
networks = set()
for role, nets in role_net_map.items():
networks.update(nets)
for name_lower in networks:
if name_lower == CTLPLANE_NETWORK:
map[name_lower] = name_lower
continue
net = conn.network.find_network(name_or_id=name_lower)
if not net:
raise Exception('Network {} not found'.format(name_lower))
name_upper = [x.split('=').pop() for x in net.tags
if x.startswith('tripleo_network_name')]
if not name_upper:
raise Exception(
'Unable to find network name for network with name_lower: {}, '
'please make sure the network tag tripleo_network_name'
'=$NET_NAME is set.'.format(name_lower))
map[name_lower] = name_upper.pop()
return map
def update_environment(environment, node_port_map, role_net_map, net_name_map):
resource_registry = environment.setdefault('resource_registry', {})
parameter_defaults = environment.setdefault('parameter_defaults', {})
for role, nets in role_net_map.items():
for net in nets:
if net == CTLPLANE_NETWORK:
continue
registry_key = REGISTRY_KEY_TPL.format(role=role,
net_name=net_name_map[net])
template_path = os.path.join(
DEFAULT_THT_DIR, PORT_PATH_TPL.format(net_name_lower=net))
resource_registry.update({registry_key: template_path})
p_map = parameter_defaults.setdefault('NodePortMap', {})
p_map.update(node_port_map)
def run_module():
result = dict(
success=False,
changed=False,
error="",
environment={},
)
argument_spec = openstack_full_argument_spec(
**yaml.safe_load(DOCUMENTATION)['options']
)
module = AnsibleModule(
argument_spec,
supports_check_mode=False,
**openstack_module_kwargs()
)
environment = result['environment'] = module.params['environment']
role_net_map = module.params['role_net_map']
node_port_map = module.params['node_port_map']
try:
_, conn = openstack_cloud_from_module(module)
net_name_map = get_net_name_map(conn, role_net_map)
update_environment(environment, node_port_map, role_net_map,
net_name_map)
result['success'] = True
module.exit_json(**result)
except Exception as err:
result['error'] = str(err)
result['msg'] = ("Error overcloud network provision failed!")
module.fail_json(**result)
def main():
run_module()
if __name__ == '__main__':
main()

+ 98
- 0
tripleo_ansible/tests/modules/test_tripleo_network_ports_populate_environment.py View File

@ -0,0 +1,98 @@
# Copyright 2020 Red Hat, 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.
import mock
import openstack
from tripleo_ansible.ansible_plugins.modules import (
tripleo_network_ports_populate_environment as plugin)
from tripleo_ansible.tests import base as tests_base
from tripleo_ansible.tests import stubs
class TestTripleoNetworkPortsPopulateEnvironment(tests_base.TestCase):
def test_update_environment(self):
env = {
'parameter_defaults': {
'FooParam': 'foo',
'BarParam': 'bar'},
'resource_registry': {
'OS::Some::Existing::Resource': '/foo/bar/some_resource.yaml'}
}
node_port_map = {
'role-a-0': {'foo': {'ip_address': '1.1.1.1'},
'bar': {'ip_address': '1.1.2.1'},
'baz': {'ip_address': '1.1.3.1'}},
'role-b-0': {'foo': {'ip_address': '1.1.1.2'},
'bar': {'ip_address': '1.1.2.2'}},
}
role_net_map = {
'RoleA': ['ctlplane', 'foo', 'bar', 'baz'],
'RoleB': ['ctlplane', 'foo', 'bar']
}
net_name_map = {'foo': 'Foo', 'bar': 'Bar', 'baz': 'Baz'}
plugin.update_environment(env, node_port_map, role_net_map,
net_name_map)
self.assertEqual(
{'FooParam': 'foo',
'BarParam': 'bar',
'NodePortMap': {
'role-a-0': {'bar': {'ip_address': '1.1.2.1'},
'baz': {'ip_address': '1.1.3.1'},
'foo': {'ip_address': '1.1.1.1'}},
'role-b-0': {'bar': {'ip_address': '1.1.2.2'},
'foo': {'ip_address': '1.1.1.2'}},
}}, env['parameter_defaults'])
self.assertEqual(
{'OS::Some::Existing::Resource': '/foo/bar/some_resource.yaml',
'OS::TripleO::RoleA::Ports::BarPort':
'/usr/share/openstack-tripleo-heat-templates/'
'network/ports/deployed_bar.yaml',
'OS::TripleO::RoleA::Ports::BazPort':
'/usr/share/openstack-tripleo-heat-templates/'
'network/ports/deployed_baz.yaml',
'OS::TripleO::RoleA::Ports::FooPort':
'/usr/share/openstack-tripleo-heat-templates/'
'network/ports/deployed_foo.yaml',
'OS::TripleO::RoleB::Ports::BarPort':
'/usr/share/openstack-tripleo-heat-templates/'
'network/ports/deployed_bar.yaml',
'OS::TripleO::RoleB::Ports::FooPort':
'/usr/share/openstack-tripleo-heat-templates/'
'network/ports/deployed_foo.yaml'}, env['resource_registry'])
@mock.patch.object(openstack.connection, 'Connection', autospec=True)
def test_get_net_name_map(self, mock_conn):
fake_networks = [
stubs.FakeNeutronNetwork(id='bar', name='bar',
tags=['tripleo_network_name=UPPERNAME']),
stubs.FakeNeutronNetwork(id='baz', name='baz',
tags=['tripleo_network_name=UPPERNAME']),
stubs.FakeNeutronNetwork(id='foo', name='foo',
tags=['tripleo_network_name=UPPERNAME']),
]
mock_conn.network.find_network.side_effect = fake_networks
role_net_map = {
'RoleA': [plugin.CTLPLANE_NETWORK, 'foo', 'bar', 'baz'],
'RoleB': [plugin.CTLPLANE_NETWORK, 'foo', 'bar']
}
# NOTE(hjensas): Different tripleo_network_name in stubs would require
# set to list conversion and sorting.
self.assertEqual({plugin.CTLPLANE_NETWORK: plugin.CTLPLANE_NETWORK,
'foo': 'UPPERNAME',
'bar': 'UPPERNAME',
'baz': 'UPPERNAME'},
plugin.get_net_name_map(mock_conn, role_net_map))

Loading…
Cancel
Save