summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/network-config-format-v2.rst
diff options
context:
space:
mode:
authorDaniel Watkins <oddbloke@ubuntu.com>2021-01-05 14:17:10 -0500
committerGitHub <noreply@github.com>2021-01-05 14:17:10 -0500
commitb85e4a56de8b7890309a3bfcad08e117a4b0bd16 (patch)
tree1075373d0f6c47dac53c413a9adc55008c98ce30 /doc/rtd/topics/network-config-format-v2.rst
parentc5f6c78623dd022c0ec45eb9917bbb39aafdca32 (diff)
downloadvyos-cloud-init-b85e4a56de8b7890309a3bfcad08e117a4b0bd16.tar.gz
vyos-cloud-init-b85e4a56de8b7890309a3bfcad08e117a4b0bd16.zip
network-config-format-v2.rst: add Netplan Passthrough section (#750)
We don't currently document our passthrough behaviour, which has lead to some user confusion about what they can rely upon on Ubuntu systems. This clarifies our support.
Diffstat (limited to 'doc/rtd/topics/network-config-format-v2.rst')
-rw-r--r--doc/rtd/topics/network-config-format-v2.rst21
1 files changed, 17 insertions, 4 deletions
diff --git a/doc/rtd/topics/network-config-format-v2.rst b/doc/rtd/topics/network-config-format-v2.rst
index 69c7452b..af65a4ce 100644
--- a/doc/rtd/topics/network-config-format-v2.rst
+++ b/doc/rtd/topics/network-config-format-v2.rst
@@ -8,9 +8,25 @@ version 2 format defined for the `netplan`_ tool. Cloud-init supports
both reading and writing of Version 2; the latter support requires a
distro with `netplan`_ present.
+Netplan Passthrough
+-------------------
+
+On a system with netplan present, cloud-init will pass Version 2 configuration
+through to netplan without modification. On such systems, you do not need to
+limit yourself to the below subset of netplan's configuration format.
+
+.. warning::
+ If you are writing or generating network configuration that may be used on
+ non-netplan systems, you **must** limit yourself to the subset described in
+ this document, or you will see network configuration failures on
+ non-netplan systems.
+
+Version 2 Configuration Format
+------------------------------
+
The ``network`` key has at least two required elements. First
it must include ``version: 2`` and one or more of possible device
-``types``..
+``types``.
Cloud-init will read this format from system config.
For example the following could be present in
@@ -34,9 +50,6 @@ Each type block contains device definitions as a map where the keys (called
"configuration IDs"). Each entry under the ``types`` may include IP and/or
device configuration.
-Cloud-init does not current support ``wifis`` type that is present in native
-`netplan`_.
-
Device configuration IDs
------------------------