cc_apt_pipelining: Update docs, deprecate options

In f2f530e the default was changed. This was never reflected to the docs and may mislead users.
canonical · Nov 2, 2023 · 70d9375 · 70d9375
1 parent d78ff37
commit 70d9375
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 6 deletions.
diff --git a/cloudinit/config/cc_apt_pipelining.py b/cloudinit/config/cc_apt_pipelining.py
@@ -42,8 +42,8 @@
 
         Value configuration options for this module are:
 
-        * ``false`` (Default): disable pipelining altogether
-        * ``none``, ``unchanged``, or ``os``: use distro default
+        * ``os``: (Default) use distro default
+        * ``false`` disable pipelining altogether
         * ``<number>``: Manually specify pipeline depth. This is not recommended."""  # noqa: E501
     ),
     "distros": distros,

diff --git a/cloudinit/config/schemas/schema-cloud-config-v1.json b/cloudinit/config/schemas/schema-cloud-config-v1.json
@@ -883,10 +883,21 @@
             },
             {
               "type": "string",
-              "enum": [
-                "none",
-                "unchanged",
-                "os"
+              "oneOf": [
+                {
+                  "enum": [
+                    "os"
+                  ]
+                },
+                {
+                  "deprecated": true,
+                  "deprecated_version": "22.4",
+                  "deprecated_description": "Use ``os`` instead.",
+                  "enum": [
+                    "none",
+                    "unchanged"
+                  ]
+                }
               ]
             }
           ]