glance/releasenotes/notes/deprecate-v1-api-6c7dbefb90fd8772.yaml
Mike Fedosin 63e6dbb1eb Deprecate the Images (Glance) v1 API
This patch deprecates the Images (Glance) v1 API and sets up a warning
message for the operators if they have enabled it. It also indicates
that we intend to remove the v1 API on or after the Pike release and
operators are encouraged to deploy only the v2 API. The message also
states that after removal of the v1 API, the only option to deploy and
use will be the Images v2 API.

The commit includes:

  * Deprecation warning of the v1 API if it's enabled
  * Deprecation warning for the following configuration options and
    release they have been deprecated since:
      * enable_v1_api
      * enable_v2_api
      * enable_v1_registry
  * Reason why the v1 API has still been kept enabled by default via
    the corresponding configuration option
  * Reason for deprecating the configuration option enable_v2_api, even
    though we are only deprecating the v1 API
  * Necessary test changes to ensure the deprecated API is checked
    accordingly
  * Release notes for this change

DocImpact
UpgradeImpact

Co-Authored-By: Mike Fedosin <mfedosin@mirantis.com>
Co-Authored-By: Nikhil Komawar <nik.komawar@gmail.com>

Implements blueprint deprecate-glance-v1-api

Change-Id: Iab0c4abaea247044fee545342ac450e3415432f7
2016-08-27 03:34:00 +00:00

20 lines
887 B
YAML

---
prelude: >
- The Images (Glance) version 1 API has been DEPRECATED.
Please see deprecations section for more information.
deprecations:
- With the deprecation of the Images (Glance) version 1
API in the Newton release, it is subject to removal on
or after the Pike release. The configuration options
specific to the Images (Glance) v1 API have also been
deprecated and are subject to removal. An indirectly related
configuration option enable_v2_api has been deprecated too
as it becomes redundant once the Images (Glance) v1 API is
removed. Appropriate warning messages have been setup for
the deprecated configuration options and when the Images
(Glance) v1 API is enabled (being used). Operators are
advised to deploy the Images (Glance) v2 API. The standard
OpenStack deprecation policy will be followed for the
removals.