RETIRED, Host network configuration tool
Go to file
OpenDev Sysadmins 19d05f3dc8 OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:44:44 +00:00
doc/source Removes unnecessary utf-8 encoding 2017-07-19 17:35:19 +05:30
etc/os-net-config/samples Merge "Add ovs_options and ovs_extra parameters to VLAN object" 2019-04-02 23:31:18 +00:00
os_net_config Merge "Add ovs_options and ovs_extra parameters to VLAN object" 2019-04-02 23:31:18 +00:00
releasenotes Update master for stable/stein 2019-04-18 14:55:57 +00:00
zuul.d Drop baremetal job template 2018-12-13 13:52:01 -07: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 Workflow documentation is now in infra-manual 2014-12-05 03:30:38 +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 Add release note link in README 2018-06-27 23:12:04 +08:00
babel.cfg Initial commit 2014-06-06 12:27:50 -04:00
requirements.txt Updating requirements for pyudev 2019-01-21 17:49:08 +05:30
setup.cfg Change openstack-dev to openstack-discuss 2018-12-05 00:11:22 +08:00
setup.py Updated from global requirements 2017-03-31 17:45:11 +00:00
test-requirements.txt Update hacking version to latest 2019-01-05 00:42:57 +08:00
tox.ini Update min tox version to 2.0 2018-11-02 06:57:19 +00: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.

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.