openstack
/
os-net-config
Code Issues Proposed changes
RETIRED, Host network configuration tool
213 Commits 3 Branches 125 Tags 10 MiB
Go to file
Frank A. Zdarsky 9ef9a7a92d Add schema-based config data validation 
This patch adds a jsonschema for os-net-config's configuration data
and a library function to validate configuration data based on this
schema. Adding schema-based validation allows catching a larger class of
errors (typos, missing required parameters, etc.) for all devices
configurable through os-net-config.

The validation is run in the os-net-config CLI after loading the config
file. If the config file fails to validate, the current default is to
just log a warning and try to continue. By providing the new CLI option
'--exit-on-validation-errors', this can be changed to log an error and
exist instead.

This validation is meant to be reusable, for example for pre-deployment
validation of network environments (see change
Ic16ee0bc353c46f8fe512454176a07ee95347346). Packaging with os-net-config
makes it easier to keep object model and schema in sync.

Change-Id: Ie4a905863b2d46c88d9cd6c3afc50e7d0a877090
Signed-off-by: Frank A. Zdarsky <fzdarsky@redhat.com>
 		2017-07-12 22:57:34 +02:00
doc/source Initial commit 2014-06-06 12:27:50 -04:00
etc/os-net-config/samples Merge "Multiqueue support for OvsDpdkBond" 2017-06-09 10:56:12 +00:00
os_net_config Add schema-based config data validation 2017-07-12 22:57:34 +02:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:41:51 +00:00
.gitignore Initial commit 2014-06-06 12:27:50 -04: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
.testr.conf Initial commit 2014-06-06 12:27:50 -04:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:38 +00:00
HACKING.rst Initial commit 2014-06-06 12:27:50 -04:00
LICENSE Initial commit 2014-06-06 12:27:50 -04:00
MANIFEST.in Initial commit 2014-06-06 12:27:50 -04:00
README.rst Show team and repo badges on README 2016-11-25 14:28:12 +01:00
babel.cfg Initial commit 2014-06-06 12:27:50 -04:00
requirements.txt Add schema-based config data validation 2017-07-12 22:57:34 +02:00
setup.cfg Remove unused Babel setup 2017-05-16 14:54:58 +02:00
setup.py Updated from global requirements 2017-03-31 17:45:11 +00:00
test-requirements.txt Updated from global requirements 2017-03-31 17:45:11 +00:00
tox.ini Fix coverage tox config 2017-03-31 17:45:11 +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.

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.