chore: Deprecate ENI as an input configuration format (canonical#5561)

holmanb · Aug 2, 2024 · 3bf9c7a · 3bf9c7a
1 parent 5487b87
commit 3bf9c7a
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 28 deletions.
diff --git a/cloudinit/sources/DataSourceConfigDrive.py b/cloudinit/sources/DataSourceConfigDrive.py
@@ -176,6 +176,14 @@ def network_config(self):
             elif self.network_eni is not None:
                 self._network_config = eni.convert_eni_data(self.network_eni)
                 LOG.debug("network config provided via converted eni data")
+                util.deprecate(
+                    deprecated="Eni network configuration in ConfigDrive",
+                    deprecated_version="24.3",
+                    extra_message=(
+                        "You can use openstack's network "
+                        "configuration format instead"
+                    ),
+                )
             else:
                 LOG.debug("no network configuration available")
         return self._network_config

diff --git a/cloudinit/sources/DataSourceNoCloud.py b/cloudinit/sources/DataSourceNoCloud.py
@@ -271,6 +271,13 @@ def check_instance_id(self, sys_cfg):
     def network_config(self):
         if self._network_config is None:
             if self._network_eni is not None:
+                util.deprecate(
+                    deprecated="Eni network configuration in NoCloud",
+                    deprecated_version="24.3",
+                    extra_message=(
+                        "You can use network v1 or network v2 instead"
+                    ),
+                )
                 self._network_config = eni.convert_eni_data(self._network_eni)
         return self._network_config
 

diff --git a/doc/rtd/reference/network-config-format-eni.rst b/doc/rtd/reference/network-config-format-eni.rst
diff --git a/doc/rtd/reference/network-config.rst b/doc/rtd/reference/network-config.rst
@@ -126,7 +126,6 @@ The following datasources optionally provide network configuration:
 - :ref:`datasource_config_drive`
 
   - `OpenStack Metadata Service Network`_
-  - :ref:`network_config_eni`
 
 - :ref:`datasource_digital_ocean`
 
@@ -140,15 +139,9 @@ The following datasources optionally provide network configuration:
 
   - :ref:`network_config_v1`
   - :ref:`network_config_v2`
-  - :ref:`network_config_eni`
-
-- :ref:`datasource_opennebula`
-
-  - :ref:`network_config_eni`
 
 - :ref:`datasource_openstack`
 
-  - :ref:`network_config_eni`
   - `OpenStack Metadata Service Network`_
 
 - :ref:`datasource_smartos`
@@ -168,7 +161,6 @@ For more information on network configuration formats:
 .. toctree::
    :maxdepth: 1
 
-   network-config-format-eni.rst
    network-config-format-v1.rst
    network-config-format-v2.rst