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.

14 files changed, 65 insertions, 0 deletions

diff --git a/doc/rtd/topics/datasources/altcloud.rst b/doc/rtd/topics/datasources/altcloud.rst
index 202b0a4a..eeb197f2 100644
--- a/doc/rtd/topics/datasources/altcloud.rst
+++ b/doc/rtd/topics/datasources/altcloud.rst
@@ -1,3 +1,5 @@
+.. _datasource_alt_cloud:
+
 Alt Cloud
 =========
 
diff --git a/doc/rtd/topics/datasources/azure.rst b/doc/rtd/topics/datasources/azure.rst
index 18d7c506..4a3735b5 100644
--- a/doc/rtd/topics/datasources/azure.rst
+++ b/doc/rtd/topics/datasources/azure.rst
@@ -1,3 +1,5 @@
+.. _datasource_azure:
+
 Azure
 =====
 
diff --git a/doc/rtd/topics/datasources/cloudsigma.rst b/doc/rtd/topics/datasources/cloudsigma.rst
index 54963f61..86b834c8 100644
--- a/doc/rtd/topics/datasources/cloudsigma.rst
+++ b/doc/rtd/topics/datasources/cloudsigma.rst
@@ -1,3 +1,5 @@
+.. _datasource_cloudsigma:
+
 CloudSigma
 ==========
 
diff --git a/doc/rtd/topics/datasources/cloudstack.rst b/doc/rtd/topics/datasources/cloudstack.rst
index 04603d9c..225093a1 100644
--- a/doc/rtd/topics/datasources/cloudstack.rst
+++ b/doc/rtd/topics/datasources/cloudstack.rst
@@ -1,3 +1,5 @@
+.. _datasource_cloudstack:
+
 CloudStack
 ==========
 
diff --git a/doc/rtd/topics/datasources/configdrive.rst b/doc/rtd/topics/datasources/configdrive.rst
index 11dd52ab..f1a488a2 100644
--- a/doc/rtd/topics/datasources/configdrive.rst
+++ b/doc/rtd/topics/datasources/configdrive.rst
@@ -1,3 +1,5 @@
+.. _datasource_config_drive:
+
 Config Drive
 ============
 
diff --git a/doc/rtd/topics/datasources/digitalocean.rst b/doc/rtd/topics/datasources/digitalocean.rst
index c6f5bc74..938ede89 100644
--- a/doc/rtd/topics/datasources/digitalocean.rst
+++ b/doc/rtd/topics/datasources/digitalocean.rst
@@ -1,3 +1,5 @@
+.. _datasource_digital_ocean:
+
 Digital Ocean
 =============
 
diff --git a/doc/rtd/topics/datasources/ec2.rst b/doc/rtd/topics/datasources/ec2.rst
index 4810c984..3bc66e17 100644
--- a/doc/rtd/topics/datasources/ec2.rst
+++ b/doc/rtd/topics/datasources/ec2.rst
@@ -1,3 +1,5 @@
+.. _datasource_ec2:
+
 Amazon EC2
 ==========
 
diff --git a/doc/rtd/topics/datasources/fallback.rst b/doc/rtd/topics/datasources/fallback.rst
index 1eb01dd0..2b133fcd 100644
--- a/doc/rtd/topics/datasources/fallback.rst
+++ b/doc/rtd/topics/datasources/fallback.rst
@@ -1,3 +1,5 @@
+.. _datasource_fallback:
+
 Fallback/None
 =============
 
diff --git a/doc/rtd/topics/datasources/maas.rst b/doc/rtd/topics/datasources/maas.rst
index f495dd4b..85c853e9 100644
--- a/doc/rtd/topics/datasources/maas.rst
+++ b/doc/rtd/topics/datasources/maas.rst
@@ -1,3 +1,5 @@
+.. _datasource_maas:
+
 MAAS
 ====
 
diff --git a/doc/rtd/topics/datasources/nocloud.rst b/doc/rtd/topics/datasources/nocloud.rst
index b9ab5f11..0159e853 100644
--- a/doc/rtd/topics/datasources/nocloud.rst
+++ b/doc/rtd/topics/datasources/nocloud.rst
@@ -1,3 +1,5 @@
+.. _datasource_nocloud:
+
 NoCloud
 =======
 
@@ -70,6 +72,43 @@ Example metadata:
       gateway 192.168.1.254
     hostname: myhost
 
+
+Network configuration can also be provided to cloud-init in either
+:ref:`network_config_v1` or :ref:`network_config_v2` by providing that
+yaml formatted data in a file named ``network-config``.  If found,
+this file will override a ``network-interfaces`` file.
+
+See an example below.  Note specifically that this file does not
+have a top level ``network`` key as it it is already assumed to
+be network configuration based on the filename.
+
+.. code:: yaml
+
+  version: 1
+  config:
+     - type: physical
+       name: interface0
+       mac_address: "52:54:00:12:34:00"
+       subnets:
+          - type: static
+            address: 192.168.1.10
+            netmask: 255.255.255.0
+            gateway: 192.168.1.254
+
+
+.. code:: yaml
+
+  version: 2
+  ethernets:
+    interface0:
+       match:
+           mac_address: "52:54:00:12:34:00"
+       set-name: interface0
+       addresses:
+       - 192.168.1.10/255.255.255.0
+       gateway4: 192.168.1.254
+
+
 .. _iso9660: https://en.wikipedia.org/wiki/ISO_9660
 .. _vfat: https://en.wikipedia.org/wiki/File_Allocation_Table
 .. vi: textwidth=78
diff --git a/doc/rtd/topics/datasources/opennebula.rst b/doc/rtd/topics/datasources/opennebula.rst
index 1b90a9c7..7c0367c4 100644
--- a/doc/rtd/topics/datasources/opennebula.rst
+++ b/doc/rtd/topics/datasources/opennebula.rst
@@ -1,3 +1,5 @@
+.. _datasource_opennebula:
+
 OpenNebula
 ==========
 
diff --git a/doc/rtd/topics/datasources/openstack.rst b/doc/rtd/topics/datasources/openstack.rst
index 164b0e0c..607b70f3 100644
--- a/doc/rtd/topics/datasources/openstack.rst
+++ b/doc/rtd/topics/datasources/openstack.rst
@@ -1,3 +1,5 @@
+.. _datasource_openstack:
+
 OpenStack
 =========
 
diff --git a/doc/rtd/topics/datasources/ovf.rst b/doc/rtd/topics/datasources/ovf.rst
index a0770332..c312617f 100644
--- a/doc/rtd/topics/datasources/ovf.rst
+++ b/doc/rtd/topics/datasources/ovf.rst
@@ -1,3 +1,5 @@
+.. _datasource_ovf:
+
 OVF
 ===
 
diff --git a/doc/rtd/topics/datasources/smartos.rst b/doc/rtd/topics/datasources/smartos.rst
index a1e1542b..cb9a128e 100644
--- a/doc/rtd/topics/datasources/smartos.rst
+++ b/doc/rtd/topics/datasources/smartos.rst
@@ -1,3 +1,5 @@
+.. _datasource_smartos:
+
 SmartOS Datasource
 ==================