diff options
Diffstat (limited to 'doc/rtd/reference/modules.rst')
| -rw-r--r-- | doc/rtd/reference/modules.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/rtd/reference/modules.rst b/doc/rtd/reference/modules.rst index dc3a6c59..e727f59b 100644 --- a/doc/rtd/reference/modules.rst +++ b/doc/rtd/reference/modules.rst @@ -3,6 +3,21 @@ Module reference **************** +Deprecation schedule and versions +--------------------------------- +Keys may be documented as ``deprecated``, ``new``, or ``changed``. +This allows cloud-init to evolve as requirements change, and to adopt +better practices without maintaining design decisions indefinitely. + +Keys that have been marked as deprecated or changed may be removed or +changed 5 years from the date of deprecation. For example, a key that is +deprecated in version ``22.1`` (which is the first release in 2022) is +scheduled to be removed in ``27.1`` (first release in 2027). Use of +deprecated keys may cause warnings in the logs. In the case that a +key's expected value changes, the key will be marked ``changed`` with a +date. A 5 year timeline may also be expected for changed keys. + + .. automodule:: cloudinit.config.cc_ansible .. automodule:: cloudinit.config.cc_apk_configure .. automodule:: cloudinit.config.cc_apt_configure |