RETIRED, Host network configuration tool
Go to file
Dan Sneddon 35832347e1 Add Policy Based Routing Support to os-net-config
Add support for routing tables and rules, as well as a
property to specify a routing table for each route to
the impl_ifcfg implementation.

This change adds a new top-level object in the
network_config with type "route_table" to specify
which route table IDs and names should be added to
the /etc/iproute2/rt_table file.

This change adds a "table" property to routes for each
interface type, that allows the selection of which
routing table to apply the route to.

This change also adds a "rules" property to each
interface type, which can be used to specify a list
of rules. Each rule contains a rule string and an
optional comment, both of which will be added to the
/etc/sysconfig/network-scripts/rule-<iface> file.

This change includes tests and changes to the schema
for validation.

Note that this change was based on the abandoned patch
https://review.openstack.org/#/c/575712
and was recreated when that patch diverged too far
from master branch.

Change-Id: I6906d3b6923845af177faba6579fa255a2195bec
Closes-bug: #1783297
2019-01-24 09:57:25 -08:00
doc/source Removes unnecessary utf-8 encoding 2017-07-19 17:35:19 +05:30
etc/os-net-config/samples Add Policy Based Routing Support to os-net-config 2019-01-24 09:57:25 -08:00
os_net_config Add Policy Based Routing Support to os-net-config 2019-01-24 09:57:25 -08:00
releasenotes Add Policy Based Routing Support to os-net-config 2019-01-24 09:57:25 -08:00
zuul.d Drop baremetal job template 2018-12-13 13:52:01 -07:00
.coveragerc Update .coveragerc after the removal of respective directory 2017-07-19 17:39:42 +05:30
.gitignore Switch to stestr 2018-07-17 08:29:14 +07:00
.gitreview Add a .gitreview file for os-net-config 2014-09-18 15:53:03 -04:00
.mailmap Initial commit 2014-06-06 12:27:50 -04:00
.stestr.conf Switch to stestr 2018-07-17 08:29:14 +07:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:38 +00:00
HACKING.rst Replacing the link in HACKING.rst 2018-11-16 00:49:58 +08:00
LICENSE Initial commit 2014-06-06 12:27:50 -04:00
README.rst Add release note link in README 2018-06-27 23:12:04 +08:00
babel.cfg Initial commit 2014-06-06 12:27:50 -04:00
requirements.txt Adding VLAN support and other configs for sriov_vf 2018-07-10 01:19:04 -04:00
setup.cfg Add network objects sriov_vf and sriov_pf 2018-02-16 00:55:52 -05:00
setup.py Updated from global requirements 2017-03-31 17:45:11 +00:00
test-requirements.txt Switch to stestr 2018-07-17 08:29:14 +07:00
tox.ini Update min tox version to 2.0 2018-11-02 06:57:19 +00:00

README.rst

Team and repository tags

image

os-net-config

host network configuration tool

An implementation of the 'network configuration' spec @ https://review.openstack.org/#/c/97859/. The intention is for this code to be moved under the tripleo project in due course.

Release Notes

Features

The core aim of this project is to allow fine grained (but extendable) configuration of the networking parameters for a network host. The project consists of:

  • A CLI (os-net-config) which provides configuration via a YAML or JSON file formats. By default os-net-config uses a YAML config file located at /etc/os-net-config/config.yaml. This can be customized via the --config-file CLI option.
  • A python library which provides configuration via an object model.

YAML Config Examples

  • Configure an OVS bridge with a single attached interface (port)
network_config:
  - 
    type: ovs_bridge
    name: br-ctlplane
    use_dhcp: true
    ovs_extra:
      - br-set-external-id br-ctlplane bridge-id br-ctlplane
    members:
      - 
        type: interface
        name: em1
  • Configure an OVS bridge on top of an OVS bond
network_config:
  - 
     type: ovs_bridge
     name: br-ctlplane
     use_dhcp: true
     members:
       - 
         type: ovs_bond
         name: bond1
         members:
           - 
             type: interface
             name: em1
           - 
             type: interface
             name: em2
  • Configure a tagged VLAN interface on top of an OVS bridge
network_config:
  - 
    type: ovs_bridge
    name: br-ctlplane
    use_dhcp: true
    members:
      - 
        type: interface
        name: em1
      - 
        type: vlan
        vlan_id: 16
        addresses:
          - 
            ip_netmask: 192.0.2.1/24

Provider Configuration

Providers are use to apply (implement) the desired configuration on the host system. By default 3 providers are implemented:

  • Ifcfg: persistent network config format stored in /etc/sysconfig/network-scripts
  • ENI: persistent network config format stored in /etc/network/interfaces
  • iproute2: non-persistent provider which implements the config using iproute2, vconfig, etc... (implementation in progress)

When using bin/os-net-config the provider is automatically selected based on the host systems perferred persistent network type (ifcfg or ENI). This can be customized via the --provider CLI option.