openstack
/
glance
Code Issues Proposed changes

Merge "use :ref: instead of :doc: for xref"

This commit is contained in:
Jenkins 2017-06-28 17:34:00 +00:00 committed by Gerrit Code Review
parent acf8c38b64 ca7a572d11
commit 951fcb4c89
17 changed files with 52 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/admin/authentication.rst
View File

@ -14,6 +14,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _authentication:
Authentication With Keystone
============================

2
doc/source/admin/cache.rst
View File

@ -14,6 +14,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _image-cache:
The Glance Image Cache
======================

4
doc/source/admin/controllingservers.rst
View File

@ -14,6 +14,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _controlling-servers:
Controlling Glance Servers
==========================
@ -125,7 +127,7 @@ command line.)
For more information on configuring the server via the ``paste.deploy``
configuration files, see the section entitled
:doc:`Configuring Glance servers <configuring>`
:ref:`Configuring Glance servers <configuring>`
Note that the server `daemonizes` itself by using the standard
shell backgrounding indicator, ``&``, in the previous example. For most use cases, we recommend

4
doc/source/admin/db-sqlalchemy-migrate.rst
View File

@ -14,12 +14,14 @@
License for the specific language governing permissions and limitations
under the License.
.. _legacy-database-management:
Legacy Database Management
==========================
.. note::
This page applies only to Glance releases prior to Ocata. From Ocata
onward, please see :doc:`db`.
onward, please see :ref:`database-management`.
The default metadata driver for Glance uses sqlalchemy, which implies there
exists a backend database which must be managed. The ``glance-manage`` binary

6
doc/source/admin/db.rst
View File

@ -11,6 +11,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _database-management:
Database Management
===================
@ -30,7 +32,7 @@ The commands should be executed as a subcommand of 'db':
more recent releases is incompatible with the "legacy" tool. If you are
consulting these documents for information about the ``glance-manage`` tool
in the Newton or earlier releases, please see the
:doc:`db-sqlalchemy-migrate` page.
:ref:`legacy-database-management` page.
.. _`SQLAlchemy`: http://www.sqlalchemy.org/
@ -142,7 +144,7 @@ rotation, allow them to drain, and then take them out of service permanently,
leaving all Glance nodes in your cloud at release *n*.
That's a rough sketch of how a rolling upgrade would work. For full details,
see :doc:`rollingupgrades`.
see :ref:`rolling-upgrades`.
.. note::
Downgrading a database is not supported. See :ref:`downgrades` for more

2
doc/source/admin/notifications.rst
View File

@ -14,6 +14,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _notifications:
Notifications
=============

2
doc/source/admin/property-protections.rst
View File

@ -14,6 +14,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _property-protections:
Property Protections
====================

5
doc/source/admin/requirements.rst
View File

@ -30,8 +30,9 @@ using "xattr" driver.
On the other hand, if ``dnspython`` is installed in the environment, Glance
provides a workaround to make it work with IPV6.
Additionally, some libraries like ``xattr`` are not compatible when using
Glance on Windows (see :doc:`the documentation on config options affecting the Image Cache <configuring>`).
Additionally, some libraries like ``xattr`` are not compatible when
using Glance on Windows (see :ref:`the documentation on config options
affecting the Image Cache <configuring>`).
Guideline to include your requirement in the requirements.txt file

2
doc/source/admin/rollingupgrades.rst
View File

@ -11,6 +11,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _rolling-upgrades:
Rolling Upgrades
================

2
doc/source/admin/tasks.rst
View File

@ -14,6 +14,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _tasks:
Tasks
=====

12
doc/source/configuration/configuring.rst
View File

@ -14,6 +14,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _basic-configuration:
Basic Configuration
===================
@ -25,7 +27,7 @@ Most configuration is done via configuration files, with the Glance API
server and Glance Registry server using separate configuration files.
When starting up a Glance server, you can specify the configuration file to
use (see :doc:`the documentation on controller Glance servers <controllingservers>`).
use (see :ref:`the documentation on controller Glance servers <controlling-servers>`).
If you do **not** specify a configuration file, Glance will look in the following
directories for a configuration file, in order:
@ -43,7 +45,7 @@ is likely that you will have sample configuration files installed in
``/etc/glance``.
In addition, sample configuration files for each server application with
detailed comments are available in the :doc:`Glance Sample Configuration
detailed comments are available in the :ref:`Glance Sample Configuration
<sample-configuration>` section.
The PasteDeploy configuration (controlling the deployment of the WSGI
@ -1309,7 +1311,7 @@ One main configuration file option affects the image cache.
``glance-cache-pruner`` executable is what prunes the image cache to be equal
to or less than this value. The ``glance-cache-pruner`` executable is designed
to be run via cron on a regular basis. See more about this executable in
:doc:`Controlling the Growth of the Image Cache <cache>`
:ref:`Controlling the Growth of the Image Cache <image-cache>`
.. _configuring-the-glance-registry:
@ -1380,7 +1382,7 @@ configuration file.
In M release, the``[DEFAULT]/notification_driver`` option has been deprecated in favor
of ``[oslo_messaging_notifications]/driver``.
For more information see :doc:`Glance notifications <notifications>` and
For more information see :ref:`Glance notifications <notifications>` and
`oslo.messaging <http://docs.openstack.org/developer/oslo.messaging/>`_.
``[DEFAULT]/disabled_notifications``
@ -1399,7 +1401,7 @@ Configuring Glance Property Protections
---------------------------------------
Access to image meta properties may be configured using a
:doc:`Property Protections Configuration file <property-protections>`. The
:ref:`Property Protections Configuration file <property-protections>`. The
location for this file can be specified in the ``glance-api.conf``
configuration file in the section ``[DEFAULT]``. **If an incorrect value is
specified, glance API service will not start.**

6
doc/source/configuration/index.rst
View File

@ -1,10 +1,12 @@
.. _configuring:
============================
Glance Configuration Options
============================
This section provides a list of all possible options for each
configuration file. Refer to :doc:`Basic Configuration <../configuring>`
for a detailed guide in getting started with various option settings.
configuration file. Refer to :ref:`basic-configuration` for a
detailed guide in getting started with various option settings.
Glance uses the following configuration files for its various services.

2
doc/source/configuration/sample-configuration.rst
View File

@ -1,3 +1,5 @@
.. _sample-configuration:
===========================
Glance Sample Configuration
===========================

2
doc/source/user/formats.rst
View File

@ -14,6 +14,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _formats:
Disk and Container Formats
==========================

18
doc/source/user/glanceapi.rst
View File

@ -122,7 +122,7 @@ Keystone using and send it along with all API requests to Glance through
the ``X-Auth-Token`` header. Glance will communicate back to Keystone to
verify the token validity and obtain your identity credentials.
See :doc:`authentication` for more information on integrating with Keystone.
See :ref:`authentication` for more information on integrating with Keystone.
Using v1.X
----------
@ -221,19 +221,19 @@ list details these query parameters.
Filters images having a ``container_format`` attribute matching ``FORMAT``
For more information, see :doc:`About Disk and Container Formats <formats>`
For more information, see :ref:`formats`
* ``disk_format=FORMAT``
Filters images having a ``disk_format`` attribute matching ``FORMAT``
For more information, see :doc:`About Disk and Container Formats <formats>`
For more information, see :ref:`formats`
* ``status=STATUS``
Filters images having a ``status`` attribute matching ``STATUS``
For more information, see :doc:`About Image Statuses <statuses>`
For more information, see :ref:`image-statuses`
* ``size_min=BYTES``
@ -516,14 +516,14 @@ The list of metadata headers that Glance accepts are listed below.
``aki``, ``ari``, ``ami``, ``raw``, ``iso``, ``vhd``, ``vhdx``, ``vdi``,
``qcow2``, ``vmdk`` or ``ploop``.
For more information, see :doc:`About Disk and Container Formats <formats>`.
For more information, see :ref:`formats`.
* ``x-image-meta-container_format``
This header is required, unless reserving an image. Valid values are one of
``aki``, ``ari``, ``ami``, ``bare``, ``ova``, ``ovf``, or ``docker``.
For more information, see :doc:`About Disk and Container Formats <formats>`.
For more information, see :ref:`formats`.
* ``x-image-meta-size``
@ -619,7 +619,7 @@ exception.
On success, the ``PUT`` request will return the image metadata encoded as HTTP
headers.
See more about image statuses here: :doc:`Image Statuses <statuses>`
See more about image statuses here: :ref:`image-statuses`
List Image Memberships
@ -773,7 +773,7 @@ Images v2 Tasks API
Version 2 of the OpenStack Images API introduces a Task resource that is used
to create and monitor long-running asynchronous image-related processes. See
the :doc:`Tasks <tasks>` section of the Glance documentation for more
the :ref:`tasks` section of the Glance documentation for more
information.
The following Task calls are available:
@ -827,7 +827,7 @@ returned list of tasks. The following list details these query parameters.
* ``status={status}``
Filters the list to display only those tasks in the specified status. See
the task schema or the :doc:`Task Statuses <statuses>` section of this
the task schema or the :ref:`task-statuses` section of this
documentation for the legal values to use for ``{status}``.
For example, a request to ``GET /v2/tasks?status=pending`` would return only

2
doc/source/user/glancemetadefcatalogapi.rst
View File

@ -51,7 +51,7 @@ Keystone send it along with all API requests to Glance through the
``X-Auth-Token`` header. Glance will communicate back to Keystone to verify
the token validity and obtain your identity credentials.
See :doc:`authentication` for more information on integrating with Keystone.
See :ref:`authentication` for more information on integrating with Keystone.
Using v2.X
----------

2
doc/source/user/statuses.rst
View File

@ -14,6 +14,8 @@
License for the specific language governing permissions and limitations
under the License.
.. _image-statuses:
Image Statuses
==============