openstack/os-net-config
Code Issues Proposed changes
RETIRED, Host network configuration tool
55 Commits 3 Branches 125 Tags 10 MiB
2178678064
Go to file
Dan Prince 2178678064 Add a .gitreview file for os-net-config 
Change-Id: I3eedbacc359bf6209392b2e69a5a65a055d81390
2014-09-18 15:53:03 -04:00
doc/source Initial commit 2014-06-06 12:27:50 -04:00
etc/os-net-config/samples Add ovs_extra to some of the sample configs. 2014-08-22 15:55:01 -04:00
os_net_config Update child_members to use a Set 2014-09-18 15:52:49 -04:00
.coveragerc Initial commit 2014-06-06 12:27:50 -04: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
babel.cfg Initial commit 2014-06-06 12:27:50 -04:00
CONTRIBUTING.rst Initial commit 2014-06-06 12:27:50 -04: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
openstack-common.conf Import processutils from oslo-incubator. 2014-06-09 17:13:57 -04:00
README.rst Updated description in README.rst 2014-09-04 09:51:05 -04:00
requirements.txt Add support for parsing YAML 2014-08-20 21:46:46 -04:00
setup.cfg Correct the setup.cfg OS. 2014-09-04 10:29:12 -04:00
setup.py Add interface, address, and route objects 2014-06-09 10:42:19 -04:00
test-requirements.txt Add interface, address, and route objects 2014-06-09 10:42:19 -04:00
tox.ini Initial commit 2014-06-06 12:27:50 -04:00

README.rst

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.