summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/network-config-format-eni.rst
diff options
context:
space:
mode:
authorRyan Harper <ryan.harper@canonical.com>2017-03-29 22:03:04 -0500
committerScott Moser <smoser@ubuntu.com>2017-05-03 21:13:28 -0400
commit99faf3ece1badc566e7e75e769ff374250196197 (patch)
tree5ff87201abe5d3dbc7bdffbe63b55aae1780d66c /doc/rtd/topics/network-config-format-eni.rst
parent653fda98a56c63d11d65ef08c4991d0425fc3f91 (diff)
downloadvyos-cloud-init-99faf3ece1badc566e7e75e769ff374250196197.tar.gz
vyos-cloud-init-99faf3ece1badc566e7e75e769ff374250196197.zip
doc: document network configuration defaults policy and formats.
Add documentation for cloud-init networking configuration formats, default behavior, policy and other specific details about how network config is consumed and utilized.
Diffstat (limited to 'doc/rtd/topics/network-config-format-eni.rst')
-rw-r--r--doc/rtd/topics/network-config-format-eni.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/rtd/topics/network-config-format-eni.rst b/doc/rtd/topics/network-config-format-eni.rst
new file mode 100644
index 00000000..b0904952
--- /dev/null
+++ b/doc/rtd/topics/network-config-format-eni.rst
@@ -0,0 +1,20 @@
+.. _network_config_eni:
+
+Network Configuration ENI (Legacy)
+----------------------------------
+
+`Cloud-init`_ supports reading and writing network config in the ``ENI``
+format which is consumed by the ``ifupdown`` tool to parse and apply network
+configuration.
+
+As an input format this is **legacy**. In cases where ENI format is available
+and another format is also available, it will prefer to use the other format.
+This can happen in either :ref:`datasource_nocloud` or
+:ref:`datasource_openstack` datasources.
+
+Please reference existing `documentation`_ for the
+``/etc/network/interfaces(5)`` format.
+
+.. _Cloud-init: https://launchpad.net/cloud-init
+.. _documentation: http://manpages.ubuntu.com/manpages/trusty/en/man5/interfaces.5.html
+.. vi: textwidth=78