RETIRED, Host network configuration tool
Go to file
wangzihao 933aaf80b1 Bump hacking min version to 3.0.1
hacking 3.0.1 fix the pinning of flake8 to avoid bringing in a new
version with new checks.

bumping the min version for hacking so that any older hacking versions
which auto adopt the new checks are not used.

Change-Id: I8d00d1e6617e556511430b8ed546a525e7e22d37
2020-09-18 10:07:18 +08:00
doc Switch to newer openstackdocstheme and reno versions 2020-06-03 20:27:18 +02:00
etc/os-net-config/samples SRIOV VF: Add min_tx_rate and max_tx_rate 2020-04-02 11:03:28 +02:00
os_net_config Merge "Add NIC Partitioning support for Mellanox VFs" 2020-07-28 06:30:34 +00:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-06-03 20:27:18 +02:00
zuul.d Missing document start "---" 2020-06-10 10:14:56 +08: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 OpenDev Migration Patch 2019-04-19 19:44:44 +00: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 setup.cfg: Cleanup 2019-10-20 23:01:49 +08:00
HACKING.rst setup.cfg: Cleanup 2019-10-20 23:01:49 +08:00
LICENSE Initial commit 2014-06-06 12:27:50 -04:00
README.rst Merge "Replace git.openstack.org URLs with opendev.org URLs" 2019-05-28 22:15:46 +00:00
babel.cfg Initial commit 2014-06-06 12:27:50 -04:00
requirements.txt Add support for python 3.8 2020-05-26 14:26:03 +02:00
setup.cfg Add support for python 3.8 2020-05-26 14:26:03 +02:00
setup.py Cleanup py27 support 2020-04-17 16:47:33 +02:00
test-requirements.txt Bump hacking min version to 3.0.1 2020-09-18 10:07:18 +08:00
tox.ini Add support for python 3.8 2020-05-26 14:26:03 +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.opendev.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.