(cloudstack-documentation) branch main updated: Document network support for configdrive (#412)

[dahn]

This is an automated email from the ASF dual-hosted git repository.

dahn pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git


The following commit(s) were added to refs/heads/main by this push:
     new 38ef7e7  Document network support for configdrive (#412)
38ef7e7 is described below

commit 38ef7e7353426f662ace554cbf1fedf5c744b15d
Author: Vishesh <vishes...@gmail.com>
AuthorDate: Mon Aug 26 14:26:06 2024 +0530

    Document network support for configdrive (#412)
---
 source/adminguide/api.rst                     |  2 +-
 source/adminguide/networking/dns_and_dhcp.rst | 13 ++++++++++---
 source/adminguide/templates/_cloud_init.rst   | 15 +++++++++++++++
 3 files changed, 26 insertions(+), 4 deletions(-)

diff --git a/source/adminguide/api.rst b/source/adminguide/api.rst
index 2f65f4f..b4139a8 100644
--- a/source/adminguide/api.rst
+++ b/source/adminguide/api.rst
@@ -169,7 +169,7 @@ VMdata - a list of String arrays representing [“directory”, 
“filename”,
 
     - meta_data.json
 
-    - Network_data.json
+    - network_data.json
 
   - label, which is configurable in global settings:
 
diff --git a/source/adminguide/networking/dns_and_dhcp.rst 
b/source/adminguide/networking/dns_and_dhcp.rst
index c84cffa..928c151 100644
--- a/source/adminguide/networking/dns_and_dhcp.rst
+++ b/source/adminguide/networking/dns_and_dhcp.rst
@@ -17,6 +17,13 @@
 DNS and DHCP
 ------------
 
-The Virtual Router provides DNS and DHCP services to the guests. It
-proxies DNS requests to the DNS server configured on the Availability
-Zone.
+The Virtual Router & ConfigDrive (since Apache CloudStack 4.20) provides
+DNS and DHCP services to the guests. It proxies DNS requests to the DNS
+server configured on the Availability Zone.
+
+.. note::
+   In case of a network with ConfigDrive, adding/removing nic to/from an
+   instance or updating the ip address of a nic will not be reflected in the
+   instance if the instance is already running. To do so, run
+   `cloud-init clean --machine-id -s` to clean the machine id and seed data.
+   Then reboot the instance to apply the changes.
\ No newline at end of file
diff --git a/source/adminguide/templates/_cloud_init.rst 
b/source/adminguide/templates/_cloud_init.rst
index 33e4968..91793c1 100644
--- a/source/adminguide/templates/_cloud_init.rst
+++ b/source/adminguide/templates/_cloud_init.rst
@@ -215,6 +215,21 @@ These features can be implemented in `“Linux Template 
creation process” <_cr
 
    Cloud-init can parse and execute user-data form Cloud-stack during Instance 
creation. This feature works as is without additional configuration.
         
+#. **Network configuration with ConfigDrive**
+
+    Cloud-init can fetch network configuration from ConfigDrive. To enable 
this,
+    ensure network configuration is not disabled in cloud-init configuration.
+    
+    .. code:: bash
+
+      echo -e "\nnetwork: {}" >> /etc/cloud/cloud.cfg
+
+    .. note::
+      Adding/removing nic to/from an instance or updating the ip address of a 
nic
+      will not be reflected in the instance if the instance is already 
running. To
+      do so, run `cloud-init clean --machine-id -s` to clean the machine id and
+      seed data. Then reboot the instance to apply the changes.
+
 #. **Cleanup**
 
    Once desired cloud-init features are implemented, clean cloud-init tracker 
files.