Clarify the release and maintenance cycle (#32402)
* Clarify the release and maintenance cycle * Namespace refs a little * Fix an unrelated problem with plugin return docs to fix docs build
This commit is contained in:
parent
fc4580b4cc
commit
42655f737a
2 changed files with 42 additions and 34 deletions
|
@ -4,7 +4,7 @@ Release and maintenance
|
||||||
.. contents:: Topics
|
.. contents:: Topics
|
||||||
:local:
|
:local:
|
||||||
|
|
||||||
.. _schedule:
|
.. _release_cycle:
|
||||||
|
|
||||||
Release cycle
|
Release cycle
|
||||||
`````````````
|
`````````````
|
||||||
|
@ -13,15 +13,18 @@ Ansible is developed and released on a flexible 4 months release cycle.
|
||||||
This cycle can be extended in order to allow for larger changes to be properly
|
This cycle can be extended in order to allow for larger changes to be properly
|
||||||
implemented and tested before a new release is made available.
|
implemented and tested before a new release is made available.
|
||||||
|
|
||||||
Ansible supports the two most recent major stable releases.
|
Ansible has a graduated support structure that extends to three major releases.
|
||||||
For more information, read about the
|
For more information, read about the `development and stable version maintenance workflow`_ or see
|
||||||
`development and stable version maintenance workflow`_.
|
the chart in :ref:`schedule` for the degrees to which current releases are supported.
|
||||||
|
|
||||||
|
.. note:: Support for three major releases began with Ansible-2.4. Ansible-2.3 and older versions
|
||||||
|
are only supported for two releases.
|
||||||
|
|
||||||
If you are using a release of Ansible that is no longer supported, we strongly
|
If you are using a release of Ansible that is no longer supported, we strongly
|
||||||
encourage you to upgrade as soon as possible in order to benefit from the
|
encourage you to upgrade as soon as possible in order to benefit from the
|
||||||
latest features and security fixes.
|
latest features and security fixes.
|
||||||
|
|
||||||
Older unsupported versions of Ansible can contain unfixed security
|
Older, unsupported versions of Ansible can contain unfixed security
|
||||||
vulnerabilities (*CVE*).
|
vulnerabilities (*CVE*).
|
||||||
|
|
||||||
You can refer to the `porting guides`_ for tips on updating your Ansible
|
You can refer to the `porting guides`_ for tips on updating your Ansible
|
||||||
|
@ -29,28 +32,27 @@ playbooks to run on newer versions.
|
||||||
|
|
||||||
.. _porting guides: https://docs.ansible.com/ansible/porting_guides.html
|
.. _porting guides: https://docs.ansible.com/ansible/porting_guides.html
|
||||||
|
|
||||||
|
.. _release_schedule:
|
||||||
|
|
||||||
Release status
|
Release status
|
||||||
``````````````
|
``````````````
|
||||||
|
|
||||||
+-----------------+----------------------------+----------------------------------------+
|
=============== ========================== =================================================
|
||||||
| Ansible Release | Latest Version | Status |
|
Ansible Release Latest Version Status
|
||||||
+=================+============================+========================================+
|
=============== ========================== =================================================
|
||||||
| devel | `2.5`_ (unreleased, trunk) | In development |
|
devel `2.5`_ (unreleased, trunk) In development
|
||||||
+-----------------+----------------------------+----------------------------------------+
|
2.4 `2.4.1`_ (2017-10-25) Supported (security **and** general bug fixes)
|
||||||
| 2.4 | `2.4.1`_ (2017-10-25) | Supported (bug **and** security fixes) |
|
2.3 `2.3.2`_ (2017-08-08) Supported (security **and** critical bug fixes)
|
||||||
+-----------------+----------------------------+----------------------------------------+
|
2.2 `2.2.3`_ (2017-05-09) Unsupported (end of life)
|
||||||
| 2.3 | `2.3.2`_ (2017-08-08) | Supported (bug **and** security fixes) |
|
2.1 `2.1.6`_ (2017-06-01) Unsupported (end of life)
|
||||||
+-----------------+----------------------------+----------------------------------------+
|
2.0 `2.0.2`_ (2016-04-19) Unsupported (end of life)
|
||||||
| 2.2 | `2.2.3`_ (2017-05-09) | Supported (**only** security fixes) |
|
1.9 `1.9.6`_ (2016-04-15) Unsupported (end of life)
|
||||||
+-----------------+----------------------------+----------------------------------------+
|
<1.9 n/a Unsupported (end of life)
|
||||||
| 2.1 | `2.1.6`_ (2017-06-01) | Unsupported (end of life) |
|
=============== ========================== =================================================
|
||||||
+-----------------+----------------------------+----------------------------------------+
|
|
||||||
| 2.0 | `2.0.2`_ (2016-04-19) | Unsupported (end of life) |
|
.. note:: Starting with Ansible-2.4, support lasts for 3 releases. Thus Ansible-2.4 will receive
|
||||||
+-----------------+----------------------------+----------------------------------------+
|
security and general bug fixes when it is first released, security and critical bug fixes when
|
||||||
| 1.9 | `1.9.6`_ (2016-04-15) | Unsupported (end of life) |
|
2.5 is released, and **only** security fixes once 2.6 is released.
|
||||||
+-----------------+----------------------------+----------------------------------------+
|
|
||||||
| <1.9 | n/a | Unsupported (end of life) |
|
|
||||||
+-----------------+----------------------------+----------------------------------------+
|
|
||||||
|
|
||||||
.. _2.5: https://github.com/ansible/ansible/blob/devel/CHANGELOG.md
|
.. _2.5: https://github.com/ansible/ansible/blob/devel/CHANGELOG.md
|
||||||
.. _2.4.1: https://github.com/ansible/ansible/blob/stable-2.4/CHANGELOG.md
|
.. _2.4.1: https://github.com/ansible/ansible/blob/stable-2.4/CHANGELOG.md
|
||||||
|
@ -63,18 +65,23 @@ Release status
|
||||||
.. _support_life:
|
.. _support_life:
|
||||||
.. _methods:
|
.. _methods:
|
||||||
|
|
||||||
|
|
||||||
Development and stable version maintenance workflow
|
Development and stable version maintenance workflow
|
||||||
```````````````````````````````````````````````````
|
```````````````````````````````````````````````````
|
||||||
|
|
||||||
The Ansible community develops and maintains Ansible on GitHub_.
|
The Ansible community develops and maintains Ansible on GitHub_.
|
||||||
|
|
||||||
New modules, plugins, features and bugfixes will always be integrated in what
|
New modules, plugins, features and bugfixes will always be integrated in what will become the next
|
||||||
will become the next major version of Ansible.
|
major version of Ansible. This work is tracked on the ``devel`` git branch.
|
||||||
This work is tracked on the ``devel`` git branch.
|
|
||||||
|
|
||||||
Ansible provides bugfixes and security improvements for the most recent major
|
Ansible provides bugfixes and security improvements for the most recent major release. The previous
|
||||||
release while the previous major release will only receive security patches.
|
major release will only receive fixes for security issues and critical bugs. Ansible only applies
|
||||||
This work is tracked on the ``stable-<version>`` git branches.
|
security fixes to releases which are two releases old. This work is tracked on the
|
||||||
|
``stable-<version>`` git branches.
|
||||||
|
|
||||||
|
.. note:: Support for three major releases began with Ansible-2.4. Ansible-2.3 and older versions
|
||||||
|
are only supported for two releases with the first stage including both security and general bug
|
||||||
|
fixes while the second stage includes security and critical bug fixes
|
||||||
|
|
||||||
The fixes that land in supported stable branches will eventually be released
|
The fixes that land in supported stable branches will eventually be released
|
||||||
as a new version when necessary.
|
as a new version when necessary.
|
||||||
|
@ -88,6 +95,7 @@ releases of Ansible, there can sometimes be exceptions for critical issues.
|
||||||
.. _GitHub: https://github.com/ansible/ansible
|
.. _GitHub: https://github.com/ansible/ansible
|
||||||
.. _changelog: https://github.com/ansible/ansible/blob/devel/CHANGELOG.md
|
.. _changelog: https://github.com/ansible/ansible/blob/devel/CHANGELOG.md
|
||||||
|
|
||||||
|
|
||||||
Release candidates
|
Release candidates
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -111,7 +119,7 @@ More release candidates can be tagged as required, so long as there are
|
||||||
bugs that the Ansible core maintainers consider should be fixed before the
|
bugs that the Ansible core maintainers consider should be fixed before the
|
||||||
final release.
|
final release.
|
||||||
|
|
||||||
.. _freezing:
|
.. _release_freezing:
|
||||||
|
|
||||||
Feature freeze
|
Feature freeze
|
||||||
~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~
|
||||||
|
|
|
@ -178,7 +178,7 @@ set:
|
||||||
type: bool
|
type: bool
|
||||||
sample: false
|
sample: false
|
||||||
failover:
|
failover:
|
||||||
description:
|
description: ""
|
||||||
returned: always
|
returned: always
|
||||||
type: NoneType
|
type: NoneType
|
||||||
sample: null
|
sample: null
|
||||||
|
@ -188,7 +188,7 @@ set:
|
||||||
type: NoneType
|
type: NoneType
|
||||||
sample: null
|
sample: null
|
||||||
identifier:
|
identifier:
|
||||||
description:
|
description: ""
|
||||||
returned: always
|
returned: always
|
||||||
type: NoneType
|
type: NoneType
|
||||||
sample: null
|
sample: null
|
||||||
|
@ -198,7 +198,7 @@ set:
|
||||||
type: string
|
type: string
|
||||||
sample: new.foo.com.
|
sample: new.foo.com.
|
||||||
region:
|
region:
|
||||||
description:
|
description: ""
|
||||||
returned: always
|
returned: always
|
||||||
type:
|
type:
|
||||||
sample:
|
sample:
|
||||||
|
|
Loading…
Reference in a new issue