os-net-config/README.rst

2.4 KiB

os-net-config

Team and repository tags

image

Overview

os-net-config is a host network configuration tool which supports multiple backend configuration providers.

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