Host network configuration tool
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Karthik S e15af3bbb5 The default max/min tx rates shall not halt deployment 7 months ago
doc Cleanup py27 support 2 years ago
etc/os-net-config/samples basic support for Linux tap devices 1 year ago
os_net_config The default max/min tx rates shall not halt deployment 7 months ago
releasenotes Cleanup py27 support 2 years ago
zuul.d Wire up new tripleo upgrades jobs template 2 years ago
.coveragerc Update .coveragerc after the removal of respective directory 5 years ago
.gitignore Allow linux tap to use routes 10 months ago
.gitreview Update .gitreview for stable/ussuri 2 years ago
.mailmap Initial commit 8 years ago
.stestr.conf Switch to stestr 4 years ago
CONTRIBUTING.rst setup.cfg: Cleanup 3 years ago
HACKING.rst setup.cfg: Cleanup 3 years ago
LICENSE Initial commit 8 years ago
README.rst Merge "Replace git.openstack.org URLs with opendev.org URLs" 3 years ago
babel.cfg Initial commit 8 years ago
requirements.txt Uncap jsonschema 3 years ago
setup.cfg Support binding VFs after moving to switchdev 2 years ago
setup.py Cleanup py27 support 2 years ago
test-requirements.txt Cleanup py27 support 2 years ago
tox.ini Fix upper constraints 8 months ago

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.