openstack
/
os-net-config
Code Issues Proposed changes
RETIRED, Host network configuration tool
416 Commits 3 Branches 125 Tags 10 MiB
Go to file
Alex Schultz eb830e639c Fix upper constraints 
It is incorrectly pulling in master which is leading to a pyflakes
problem.

Change-Id: I1ab4ed3d7caca81b77c28b573e953af2cbaf6824
 		2021-10-27 08:18:39 -06:00
doc Blacklist sphinx 2.1.0 (autodoc bug) 2019-07-31 16:34:14 +08:00
etc/os-net-config/samples basic support for Linux tap devices 2021-01-18 10:02:19 +00:00
os_net_config Updating sriov_config.service to run before driverctl.slice and network-pre 2021-10-05 11:24:03 +00:00
releasenotes Update master for stable/stein 2019-04-18 14:55:57 +00:00
zuul.d Wire up new tripleo upgrades jobs template 2021-01-06 12:41:09 +02:00
.coveragerc Update .coveragerc after the removal of respective directory 2017-07-19 17:39:42 +05:30
.gitignore Allow linux tap to use routes 2021-09-08 16:11:09 +00:00
.gitreview Update .gitreview for stable/train 2019-10-21 14:16:53 +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 Publish documents 2019-05-24 09:50:28 +00:00
HACKING.rst Replacing the link in HACKING.rst 2018-11-16 00:49:58 +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 Uncap jsonschema 2019-04-24 13:59:41 +00:00
setup.cfg Add Python 3 Train unit tests 2019-07-12 16:19:32 -04:00
setup.py Updated from global requirements 2017-03-31 17:45:11 +00:00
test-requirements.txt Update docs testing 2019-05-24 11:49:57 +02:00
tox.ini Fix upper constraints 2021-10-27 08:18:39 -06: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.