Skip to main content

OpenStack network configuration

Project description

Team and repository tags

https://governance.openstack.org/tc/badges/os-net-config.svg

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.

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.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for os-net-config, version 12.1.0
Filename, size File type Python version Upload date Hashes
Filename, size os_net_config-12.1.0-py3-none-any.whl (99.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size os-net-config-12.1.0.tar.gz (111.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page