Merge "Document Glance Registry deprecation"

doc/source/admin/authentication.rst

@@ -42,6 +42,8 @@ information. In order to configure Glance to use Keystone, the
 the authentication token validation and retrieves actual user authentication
 information. It can be found in the Keystone distribution.
 
+.. include:: ../deprecate-registry.inc
+
 
 Configuring Glance API to use Keystone
 --------------------------------------
@@ -93,6 +95,8 @@ with ``authtoken`` and ``context``::
 Configuring Glance Registry to use Keystone
 -------------------------------------------
 
+.. include:: ../deprecate-registry.inc
+
 Configuring Glance Registry to use Keystone is also relatively
 straight forward.  The same middleware needs to be added
 to ``glance-registry-paste.ini`` as was needed by Glance API;

doc/source/admin/controllingservers.rst

@@ -22,6 +22,9 @@ Controlling Glance Servers
 This section describes the ways to start, stop, and reload Glance's server
 programs.
 
+.. include:: ../deprecate-registry.inc
+
+
 Starting a server
 -----------------
 

doc/source/admin/property-protections.rst

@@ -101,6 +101,8 @@ permitted to perform the requested action, ``403 Forbidden`` will be returned.
 V1 API X-glance-registry-Purge-props
 ------------------------------------
 
+.. include:: ../deprecate-registry.inc
+
 Property protections will still be honoured if
 ``X-glance-registry-Purge-props`` is set to ``True``. That is, if you request
 to modify properties with this header set to ``True``, you will not be able to

doc/source/cli/glanceregistry.rst

@@ -8,6 +8,9 @@ Server for the Glance Registry Service
 
 .. include:: header.txt
 
+.. include:: ../deprecate-registry.inc
+
+
 SYNOPSIS
 ========
 

doc/source/configuration/configuring.rst

@@ -23,6 +23,8 @@ Glance has a number of options that you can use to configure the Glance API
 server, the Glance Registry server, and the various storage backends that
 Glance can use to store images.
 
+.. include:: ../deprecate-registry.inc
+
 Most configuration is done via configuration files, with the Glance API
 server and Glance Registry server using separate configuration files.
 
@@ -146,6 +148,8 @@ You can put the following options in the ``glance-api.conf`` and
 ``glance-registry.conf`` files, under the ``[DEFAULT]`` section. They enable
 startup and binding behaviour for the API and registry servers, respectively.
 
+.. include:: ../deprecate-registry.inc
+
 ``bind_host=ADDRESS``
   The address of the host to bind to.
 
@@ -219,6 +223,8 @@ Configuring Registry Access
 There are a number of configuration options in Glance that control how
 the API server accesses the registry server.
 
+.. include:: ../deprecate-registry.inc
+
 ``registry_client_protocol=PROTOCOL``
   If you run a secure Registry server, you need to set this value to ``https``
   and also set ``registry_client_key_file`` and optionally
@@ -1334,11 +1340,13 @@ on command line)
 
 ``enable_v1_registry=<True|False>``
 
-  Optional. Default: ``True``
+  Optional and DEPRECATED. Default: ``True``
 
 ``enable_v2_registry=<True|False>``
 
-  Optional. Default: ``True``
+  Optional and DEPRECATED. Default: ``True``
+
+  .. include:: ../deprecate-registry.inc
 
   Defines which version(s) of the Registry API will be enabled.
   If the Glance API server parameter ``enable_v1_api`` has been set to ``True`` the
@@ -1347,7 +1355,6 @@ on command line)
   set to ``True`` and the parameter ``data_api`` has been set to
   ``glance.db.registry.api`` the ``enable_v2_registry`` has to be set to ``True``
 
-
 Configuring Notifications
 -------------------------
 

doc/source/configuration/glance_registry.rst

@@ -4,6 +4,8 @@
 glance-registry.conf
 --------------------
 
+.. include:: ../deprecate-registry.inc
+
 This configuration file controls how the register server operates. More
 information can be found in :ref:`configuring-the-glance-registry`.
 

doc/source/contributor/architecture.rst

@@ -81,3 +81,5 @@ Following components are present in the Glance architecture:
 
 * **Registry Layer** - optional layer that is used to organise secure
     communication between the domain and the DAL by using a separate service.
+
+  .. include:: ../deprecate-registry.inc

doc/source/deprecate-registry.inc

@@ -0,0 +1,8 @@
+.. note:: The Glance Registry Service and its APIs have been DEPRECATED in
+    the Queens release and are subject to removal at the beginning of the
+    'S' development cycle, following the `OpenStack standard deprecation policy
+    <https://governance.openstack.org/reference/tags/assert_follows-standard-deprecation.html>`_.
+
+    For more information, see the Glance specification document `Actually
+    Deprecate the Glance Registry
+    <http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html>`_.

doc/source/install/get-started.rst

@@ -50,6 +50,8 @@ glance-registry
      The registry is a private internal service meant for use by
      OpenStack Image service. Do not expose this service to users.
 
+  .. include:: ../deprecate-registry.inc
+
 Database
   Stores image metadata and you can choose your database depending on
   your preference. Most deployments use MySQL or SQLite.

doc/source/install/install-debian.rst

@@ -250,6 +250,8 @@ Install and configure components
 3. Edit the ``/etc/glance/glance-registry.conf`` file and complete
    the following actions:
 
+   .. include:: ../deprecate-registry.inc
+
    * In the ``[database]`` section, configure database access:
 
      .. path /etc/glance/glance-registry.conf

doc/source/install/install-obs.rst

@@ -264,6 +264,8 @@ Install and configure components
 3. Edit the ``/etc/glance/glance-registry.conf`` file and complete
    the following actions:
 
+   .. include:: ../deprecate-registry.inc
+
    * In the ``[database]`` section, configure database access:
 
      .. path /etc/glance/glance-registry.conf

doc/source/install/install-rdo.rst

@@ -250,6 +250,8 @@ Install and configure components
 3. Edit the ``/etc/glance/glance-registry.conf`` file and complete
    the following actions:
 
+   .. include:: ../deprecate-registry.inc
+
    * In the ``[database]`` section, configure database access:
 
      .. path /etc/glance/glance-registry.conf

doc/source/install/install-ubuntu.rst

@@ -250,6 +250,8 @@ Install and configure components
 3. Edit the ``/etc/glance/glance-registry.conf`` file and complete
    the following actions:
 
+   .. include:: ../deprecate-registry.inc
+
    * In the ``[database]`` section, configure database access:
 
      .. path /etc/glance/glance-registry.conf

releasenotes/notes/deprecate-registry-ff286df90df793f0.yaml

@@ -0,0 +1,12 @@
+---
+deprecations:
+  - |
+    The Glance Registry Service and its APIs are officially DEPRECATED
+    in this release and are subject to removal at the beginning of the
+    'S' development cycle, following the `OpenStack standard deprecation
+    policy
+    <https://governance.openstack.org/reference/tags/assert_follows-standard-deprecation.html>`_.
+
+    For more information, see the Glance specification document `Actually
+    Deprecate the Glance Registry
+    <http://specs.openstack.org/openstack/glance-specs/specs/queens/approved/glance/deprecate-registry.html>`_.