RETIRED, Host network configuration tool
Go to file
Zuul 4f9c63652f Merge "Remove mox usage" 2018-03-28 22:29:51 +00:00
doc/source Removes unnecessary utf-8 encoding 2017-07-19 17:35:19 +05:30
etc/os-net-config/samples Add network objects sriov_vf and sriov_pf 2018-02-16 00:55:52 -05:00
os_net_config Merge "Remove mox usage" 2018-03-28 22:29:51 +00:00
releasenotes Merge "Adding the class and mac approach as dpdk-devargs in mellanox ConnectX-3" 2018-03-07 16:21:53 +00:00
zuul.d Zuul: Remove project name 2018-01-31 12:09:32 -08:00
.coveragerc Update .coveragerc after the removal of respective directory 2017-07-19 17:39:42 +05:30
.gitignore Merge "Update .gitignore" 2018-01-18 06:12:44 +00: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
README.rst Update links in README 2018-03-02 17:58:50 +08: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 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 Remove mox usage 2018-03-08 14:58:32 -05:00
tox.ini Fix 'tox -e cover' 2017-07-09 11:15:41 +02: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.