Publish documents

The documents have not been published in the past but look ready for
publishing, so publish the content.

Reviewing the content, it showed some wrong indents which lead to sphinx
formatting the pages badly, fix these.

Change-Id: I255f2b61620d998f94c782c68e0faadaca4a19d0
This commit is contained in:
Andreas Jaeger 2019-05-10 08:37:59 +02:00 committed by Andreas Jaeger
parent 8465e5c9cb
commit 53d57da596
3 changed files with 74 additions and 72 deletions

View File

@ -1,16 +1,16 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps in this page:
http://docs.openstack.org/infra/manual/developers.html
http://docs.openstack.org/infra/manual/developers.html
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/os-net-config
https://bugs.launchpad.net/os-net-config

View File

@ -7,9 +7,9 @@ Team and repository tags
.. Change things from this point on
===============================
=============
os-net-config
===============================
=============
host network configuration tool
@ -33,94 +33,95 @@ 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 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.
* A python library which provides configuration via an object model.
YAML Config Examples
--------------------
* Configure an OVS bridge with a single attached interface (port)
.. code-block:: yaml
* 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
..
.. code-block:: yaml
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
* Configure an OVS bridge on top of an OVS bond
.. code-block:: yaml
.. code-block:: yaml
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
..
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
..
* Configure a tagged VLAN interface on top of an OVS bridge
.. code-block:: yaml
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
..
.. code-block:: yaml
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
* Ifcfg: persistent network config format stored in
/etc/sysconfig/network-scripts
* ENI: persistent network config format stored in /etc/network/interfaces
* 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)
* 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.
be customized via the `--provider` CLI option.

View File

@ -6,6 +6,7 @@
- openstack-python35-jobs
- openstack-python36-jobs
- openstack-python37-jobs
- publish-openstack-docs-pti
- release-notes-jobs-python3
- tripleo-multinode-container-minimal
gate: