From 1548c69a2e9d8462ffc22c7fa2aaefb0a1d42c97 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Fri, 27 Jan 2017 23:12:43 +0900 Subject: [PATCH] [admin-guide] use https instead of http for docs.o.o Change-Id: Ib877c232b8a988242894dad2e19ebf091b3d85a3 --- doc/admin-guide/setup.cfg | 2 +- .../source/baremetal-multitenancy.rst | 2 +- .../source/blockstorage-boot-from-volume.rst | 4 +-- .../source/blockstorage-volume-migration.rst | 2 +- doc/admin-guide/source/blockstorage.rst | 4 +-- .../source/cli-admin-manage-ip-addresses.rst | 2 +- .../source/cli-admin-manage-stacks.rst | 4 +-- doc/admin-guide/source/cli-cinder-quotas.rst | 2 +- doc/admin-guide/source/cli-manage-flavors.rst | 2 +- .../cli-manage-projects-users-and-roles.rst | 2 +- .../source/cli-networking-advanced-quotas.rst | 2 +- doc/admin-guide/source/compute-arch.rst | 6 ++-- .../source/compute-configuring-migrations.rst | 6 ++-- .../source/compute-cpu-topologies.rst | 6 ++-- doc/admin-guide/source/compute-flavors.rst | 2 +- doc/admin-guide/source/compute-huge-pages.rst | 4 +-- .../source/compute-images-instances.rst | 14 +++++----- .../source/compute-live-migration-usage.rst | 2 +- .../source/compute-manage-logs.rst | 2 +- .../source/compute-manage-the-cloud.rst | 4 +-- .../source/compute-networking-nova.rst | 6 ++-- doc/admin-guide/source/compute-node-down.rst | 2 +- .../source/compute-pci-passthrough.rst | 10 +++---- doc/admin-guide/source/compute-security.rst | 2 +- .../source/compute-service-groups.rst | 2 +- doc/admin-guide/source/cross-project-cors.rst | 2 +- .../source/dashboard-admin-manage-stacks.rst | 4 +-- .../source/dashboard-customize-configure.rst | 4 +-- .../dashboard-manage-host-aggregates.rst | 2 +- .../source/dashboard-manage-images.rst | 6 ++-- .../source/dashboard-manage-instances.rst | 4 +-- .../source/dashboard-manage-shares.rst | 2 +- .../source/dashboard-manage-volumes.rst | 2 +- doc/admin-guide/source/dashboard-sessions.rst | 2 +- .../source/dashboard-set-quotas.rst | 4 +-- .../source/dashboard-view-cloud-resources.rst | 2 +- doc/admin-guide/source/dashboard.rst | 8 +++--- doc/admin-guide/source/database.rst | 4 +-- .../source/identity-caching-layer.rst | 2 +- doc/admin-guide/source/identity-concepts.rst | 2 +- .../source/identity-integrate-with-ldap.rst | 4 +-- .../source/networking-config-agents.rst | 8 +++--- .../source/networking-config-identity.rst | 2 +- .../source/networking-config-plugins.rst | 12 ++++---- .../source/networking-introduction.rst | 2 +- .../source/networking-multi-dhcp-agents.rst | 2 +- doc/admin-guide/source/networking-use.rst | 6 ++-- doc/admin-guide/source/objectstorage-EC.rst | 2 +- .../source/objectstorage-admin.rst | 4 +-- .../source/objectstorage-components.rst | 2 +- .../source/objectstorage-large-objects.rst | 4 +-- .../source/objectstorage-monitoring.rst | 2 +- .../source/orchestration-introduction.rst | 2 +- .../source/shared-file-systems-crud-share.rst | 2 +- .../shared-file-systems-network-plugins.rst | 2 +- .../source/shared-file-systems-scheduling.rst | 2 +- .../shared-file-systems-share-replication.rst | 2 +- .../shared-file-systems-share-types.rst | 2 +- doc/admin-guide/source/support-compute.rst | 2 +- doc/admin-guide/source/telemetry-alarms.rst | 2 +- .../source/telemetry-best-practices.rst | 2 +- .../source/telemetry-data-collection.rst | 28 +++++++++---------- .../source/telemetry-data-pipelines.rst | 2 +- .../source/telemetry-data-retrieval.rst | 10 +++---- doc/admin-guide/source/telemetry-events.rst | 2 +- .../source/telemetry-measurements.rst | 10 +++---- .../source/telemetry-system-architecture.rst | 2 +- .../telemetry-troubleshooting-guide.rst | 6 ++-- .../source/ts-no-emulator-x86-64.rst | 2 +- 69 files changed, 138 insertions(+), 138 deletions(-) diff --git a/doc/admin-guide/setup.cfg b/doc/admin-guide/setup.cfg index 7b17407a60..2869a4150f 100644 --- a/doc/admin-guide/setup.cfg +++ b/doc/admin-guide/setup.cfg @@ -3,7 +3,7 @@ name = openstackcloudadminguide summary = OpenStack Cloud Administrator Guide author = OpenStack author-email = openstack-docs@lists.openstack.org -home-page = http://docs.openstack.org/ +home-page = https://docs.openstack.org/ classifier = Environment :: OpenStack Intended Audience :: Information Technology diff --git a/doc/admin-guide/source/baremetal-multitenancy.rst b/doc/admin-guide/source/baremetal-multitenancy.rst index c4634a710d..03f145dc23 100644 --- a/doc/admin-guide/source/baremetal-multitenancy.rst +++ b/doc/admin-guide/source/baremetal-multitenancy.rst @@ -49,7 +49,7 @@ To enable the Networking service ML2 driver, edit the param_3 = ... For more details, see -`Networking service mechanism drivers `__. +`Networking service mechanism drivers `__. Configure Bare Metal service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/admin-guide/source/blockstorage-boot-from-volume.rst b/doc/admin-guide/source/blockstorage-boot-from-volume.rst index c7bcab6697..ca58dfe954 100644 --- a/doc/admin-guide/source/blockstorage-boot-from-volume.rst +++ b/doc/admin-guide/source/blockstorage-boot-from-volume.rst @@ -6,5 +6,5 @@ In some cases, you can store and run instances from inside volumes. For information, see the `Launch an instance from a volume`_ section in the `OpenStack End User Guide`_. -.. _`Launch an instance from a volume`: http://docs.openstack.org/user-guide/cli-nova-launch-instance-from-volume.html -.. _`OpenStack End User Guide`: http://docs.openstack.org/user-guide/ +.. _`Launch an instance from a volume`: https://docs.openstack.org/user-guide/cli-nova-launch-instance-from-volume.html +.. _`OpenStack End User Guide`: https://docs.openstack.org/user-guide/ diff --git a/doc/admin-guide/source/blockstorage-volume-migration.rst b/doc/admin-guide/source/blockstorage-volume-migration.rst index 083a980318..9f3625cd1f 100644 --- a/doc/admin-guide/source/blockstorage-volume-migration.rst +++ b/doc/admin-guide/source/blockstorage-volume-migration.rst @@ -25,7 +25,7 @@ These workflows are possible for a migration: .. note:: While most back ends support this function, not all do. See the `driver - documentation `__ + documentation `__ in the OpenStack Configuration Reference for more details. #. If the volume is attached to a VM instance, the Block Storage creates a diff --git a/doc/admin-guide/source/blockstorage.rst b/doc/admin-guide/source/blockstorage.rst index 3414d7aa10..ac577454c2 100644 --- a/doc/admin-guide/source/blockstorage.rst +++ b/doc/admin-guide/source/blockstorage.rst @@ -28,5 +28,5 @@ Amazon EC2 Elastic Block Storage (EBS) offering. blockstorage-manage-volumes.rst blockstorage-troubleshoot.rst -.. _`Storage Decisions`: http://docs.openstack.org/ops-guide/arch-storage.html -.. _`OpenStack Operations Guide`: http://docs.openstack.org/ops-guide/ +.. _`Storage Decisions`: https://docs.openstack.org/ops-guide/arch-storage.html +.. _`OpenStack Operations Guide`: https://docs.openstack.org/ops-guide/ diff --git a/doc/admin-guide/source/cli-admin-manage-ip-addresses.rst b/doc/admin-guide/source/cli-admin-manage-ip-addresses.rst index 191da2859c..56c1ba54b1 100644 --- a/doc/admin-guide/source/cli-admin-manage-ip-addresses.rst +++ b/doc/admin-guide/source/cli-admin-manage-ip-addresses.rst @@ -13,7 +13,7 @@ Internet. addresses with projects and instances. You can change user permissions for managing IP addresses by updating the ``/etc/nova/policy.json`` file. For basic floating-IP procedures, refer to the `Allocate a - floating address to an instance `_ + floating address to an instance `_ section in the OpenStack End User Guide. - For details on creating public networks using OpenStack Networking diff --git a/doc/admin-guide/source/cli-admin-manage-stacks.rst b/doc/admin-guide/source/cli-admin-manage-stacks.rst index 22f409727a..14064f3123 100644 --- a/doc/admin-guide/source/cli-admin-manage-stacks.rst +++ b/doc/admin-guide/source/cli-admin-manage-stacks.rst @@ -20,10 +20,10 @@ For information about: - basic creation and deletion of Orchestration stacks, refer to the `OpenStack End User Guide - `_ + `_ - **openstack** CLI, see the `OpenStackClient documentation - `_ + `_ .. note:: diff --git a/doc/admin-guide/source/cli-cinder-quotas.rst b/doc/admin-guide/source/cli-cinder-quotas.rst index 01c234c4a6..b14bc40905 100644 --- a/doc/admin-guide/source/cli-cinder-quotas.rst +++ b/doc/admin-guide/source/cli-cinder-quotas.rst @@ -96,7 +96,7 @@ service quotas. update the property in the :guilabel:`cinder.quota` section of the ``/etc/cinder/cinder.conf`` file. For more information, see the `Block Storage service - `_ + `_ in OpenStack Configuration Reference. #. To update Block Storage service quotas for an existing project diff --git a/doc/admin-guide/source/cli-manage-flavors.rst b/doc/admin-guide/source/cli-manage-flavors.rst index df74ccf314..4b14e3764e 100644 --- a/doc/admin-guide/source/cli-manage-flavors.rst +++ b/doc/admin-guide/source/cli-manage-flavors.rst @@ -123,7 +123,7 @@ Create a flavor flavor that you do not want other projects to have access to, you can change the flavor's access to make it a private flavor. See - `Private Flavors in the OpenStack Operations Guide `_. + `Private Flavors in the OpenStack Operations Guide `_. For a list of optional parameters, run this command: diff --git a/doc/admin-guide/source/cli-manage-projects-users-and-roles.rst b/doc/admin-guide/source/cli-manage-projects-users-and-roles.rst index 52dd281d66..202485963a 100644 --- a/doc/admin-guide/source/cli-manage-projects-users-and-roles.rst +++ b/doc/admin-guide/source/cli-manage-projects-users-and-roles.rst @@ -28,7 +28,7 @@ from its primary project. Before you can run client commands, you must download and source an OpenStack RC file. See `Download and source the OpenStack RC file -`_. +`_. Projects ~~~~~~~~ diff --git a/doc/admin-guide/source/cli-networking-advanced-quotas.rst b/doc/admin-guide/source/cli-networking-advanced-quotas.rst index f8bc543e0c..f3875c43fa 100644 --- a/doc/admin-guide/source/cli-networking-advanced-quotas.rst +++ b/doc/admin-guide/source/cli-networking-advanced-quotas.rst @@ -146,7 +146,7 @@ the default set of quotas are enforced for all projects, so no | description | Expose functions for quotas management per tenant | | links | | | name | Quota management support | - | namespace | http://docs.openstack.org/network/ext/quotas-sets/api/v2.0 | + | namespace | https://docs.openstack.org/network/ext/quotas-sets/api/v2.0 | | updated | 2012-07-29T10:00:00-00:00 | +-------------+------------------------------------------------------------+ diff --git a/doc/admin-guide/source/compute-arch.rst b/doc/admin-guide/source/compute-arch.rst index 479830fdac..03c4d8101c 100644 --- a/doc/admin-guide/source/compute-arch.rst +++ b/doc/admin-guide/source/compute-arch.rst @@ -47,7 +47,7 @@ into account. However, the majority of OpenStack development is done on systems using KVM and Xen-based hypervisors. For a detailed list of features and support across different hypervisors, see the `Feature Support Matrix -`_. +`_. You can also orchestrate clouds using multiple hypervisors in different availability zones. Compute supports the following hypervisors: @@ -73,7 +73,7 @@ availability zones. Compute supports the following hypervisors: - `Xen `__ For more information about hypervisors, see the -`Hypervisors `__ +`Hypervisors `__ section in the OpenStack Configuration Reference. Projects, users, and roles @@ -179,7 +179,7 @@ to keep ephemeral storage, depending on the flavor selected. In this case, the root file system can be on the persistent volume, and its state is maintained, even if the instance is shut down. For more information about this type of configuration, see `Introduction to the -Block Storage service `_ +Block Storage service `_ in the OpenStack Configuration Reference. .. note:: diff --git a/doc/admin-guide/source/compute-configuring-migrations.rst b/doc/admin-guide/source/compute-configuring-migrations.rst index b8919d7538..fb899ff187 100644 --- a/doc/admin-guide/source/compute-configuring-migrations.rst +++ b/doc/admin-guide/source/compute-configuring-migrations.rst @@ -35,7 +35,7 @@ The migration types are: - **Block live migration**. No shared storage is required. Incompatible with read-only devices such as CD-ROMs and - `Configuration Drive (config\_drive) `_. + `Configuration Drive (config\_drive) `_. - **Volume-backed live migration**. Instances are backed by volumes rather than ephemeral disk, no shared storage is required, and @@ -270,7 +270,7 @@ Example Compute installation environment #. You can now configure other options for live migration. In most cases, you will not need to configure any options. For advanced configuration options, - see the `OpenStack Configuration Reference Guide `_. @@ -309,7 +309,7 @@ configuration is required. parameter with the live migration command. - Block migration is incompatible with read-only devices such as - CD-ROMs and `Configuration Drive (config_drive) `_. + CD-ROMs and `Configuration Drive (config_drive) `_. - Since the ephemeral drives are copied over the network in block migration, migrations of instances with heavy I/O loads may never diff --git a/doc/admin-guide/source/compute-cpu-topologies.rst b/doc/admin-guide/source/compute-cpu-topologies.rst index cc64ee552b..bc1feeed04 100644 --- a/doc/admin-guide/source/compute-cpu-topologies.rst +++ b/doc/admin-guide/source/compute-cpu-topologies.rst @@ -306,7 +306,7 @@ For more information about image metadata, refer to the `Image metadata`_ guide. .. Links -.. _`Scheduling`: http://docs.openstack.org/newton/config-reference/compute/scheduler.html -.. _`Flavors`: http://docs.openstack.org/admin-guide/compute-flavors.html -.. _`Image metadata`: http://docs.openstack.org/image-guide/image-metadata.html +.. _`Scheduling`: https://docs.openstack.org/newton/config-reference/compute/scheduler.html +.. _`Flavors`: https://docs.openstack.org/admin-guide/compute-flavors.html +.. _`Image metadata`: https://docs.openstack.org/image-guide/image-metadata.html .. _`discussion`: http://lists.openstack.org/pipermail/openstack-dev/2016-March/090367.html diff --git a/doc/admin-guide/source/compute-flavors.rst b/doc/admin-guide/source/compute-flavors.rst index 18f048e424..d201e4cd3e 100644 --- a/doc/admin-guide/source/compute-flavors.rst +++ b/doc/admin-guide/source/compute-flavors.rst @@ -524,7 +524,7 @@ PCI passthrough - ALIAS: (string) The alias which correspond to a particular PCI device class as configured in the nova configuration file (see `nova.conf - configuration options `_). + configuration options `_). - COUNT: (integer) The amount of PCI devices of type ALIAS to be assigned to a guest. diff --git a/doc/admin-guide/source/compute-huge-pages.rst b/doc/admin-guide/source/compute-huge-pages.rst index ea4e65cd8c..03074cada5 100644 --- a/doc/admin-guide/source/compute-huge-pages.rst +++ b/doc/admin-guide/source/compute-huge-pages.rst @@ -235,5 +235,5 @@ guide. .. Links .. _`Linux THP guide`: https://www.kernel.org/doc/Documentation/vm/transhuge.txt .. _`Linux hugetlbfs guide`: https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt -.. _`Flavors`: http://docs.openstack.org/admin-guide/compute-flavors.html -.. _`Image metadata`: http://docs.openstack.org/image-guide/image-metadata.html +.. _`Flavors`: https://docs.openstack.org/admin-guide/compute-flavors.html +.. _`Image metadata`: https://docs.openstack.org/image-guide/image-metadata.html diff --git a/doc/admin-guide/source/compute-images-instances.rst b/doc/admin-guide/source/compute-images-instances.rst index a2dd5d11a4..df48d864bb 100644 --- a/doc/admin-guide/source/compute-images-instances.rst +++ b/doc/admin-guide/source/compute-images-instances.rst @@ -27,11 +27,11 @@ flavors that you can edit or add to. - For more information about creating and troubleshooting images, see the `OpenStack Virtual Machine Image - Guide `__. + Guide `__. - For more information about image configuration options, see the `Image services - `__ + `__ section of the OpenStack Configuration Reference. - For more information about flavors, see :ref:`compute-flavors`. @@ -270,7 +270,7 @@ can also be used to set policies for Image service actions. To view a sample configuration file, see `glance-api.conf - `__. + `__. #. Optionally, in the ``glance-api.conf`` file, specify whether roles or policies are used in the property protections configuration file @@ -283,7 +283,7 @@ can also be used to set policies for Image service actions. To view a sample configuration file, see `glance-api.conf - `__. + `__. Image download: how it works ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -319,7 +319,7 @@ Compute nodes also implement caching of images, meaning that if an image has been used before it won't necessarily be downloaded every time. Information on the configuration options for caching on compute nodes can be found in the `Configuration -Reference `__. +Reference `__. Instance building blocks ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -406,14 +406,14 @@ version using the pip python package installer: For more information about python-novaclient and other command-line tools, see the `OpenStack End User -Guide `__. +Guide `__. Control where instances run ~~~~~~~~~~~~~~~~~~~~~~~~~~~ The `Scheduling section -`__ +`__ of OpenStack Configuration Reference provides detailed information on controlling where your instances run, including ensuring a set of instances run on different compute nodes for diff --git a/doc/admin-guide/source/compute-live-migration-usage.rst b/doc/admin-guide/source/compute-live-migration-usage.rst index 87c6feebab..865139e0c4 100644 --- a/doc/admin-guide/source/compute-live-migration-usage.rst +++ b/doc/admin-guide/source/compute-live-migration-usage.rst @@ -16,7 +16,7 @@ Before starting a migration, review the Configure migrations section. under the default Compute configuration options, the instances are suspended before migration. For more information, see `Configure migrations - `_. + `_. in the OpenStack Configuration Reference. **Migrating instances** diff --git a/doc/admin-guide/source/compute-manage-logs.rst b/doc/admin-guide/source/compute-manage-logs.rst index a51eee2cf0..f47ca8743e 100644 --- a/doc/admin-guide/source/compute-manage-logs.rst +++ b/doc/admin-guide/source/compute-manage-logs.rst @@ -39,7 +39,7 @@ For more about the logging configuration syntax, including the on logging configuration files. For an example of the ``logging.conf`` file with various defined handlers, see -the `OpenStack Configuration Reference `__. +the `OpenStack Configuration Reference `__. Syslog ~~~~~~ diff --git a/doc/admin-guide/source/compute-manage-the-cloud.rst b/doc/admin-guide/source/compute-manage-the-cloud.rst index d2754be1b4..ec247c6157 100644 --- a/doc/admin-guide/source/compute-manage-the-cloud.rst +++ b/doc/admin-guide/source/compute-manage-the-cloud.rst @@ -25,7 +25,7 @@ specific commands might be restricted by the Identity service. To install python-openstackclient, follow the instructions in the `OpenStack User Guide - `_. + `_. #. Confirm the installation was successful: @@ -48,7 +48,7 @@ specific commands might be restricted by the Identity service. For a complete list of ``openstack`` commands and parameters, see the `OpenStack Command-Line Reference - `__. + `__. #. Set the required parameters as environment variables to make running commands easier. For example, you can add ``--os-username`` as an diff --git a/doc/admin-guide/source/compute-networking-nova.rst b/doc/admin-guide/source/compute-networking-nova.rst index 05bcb1cbba..e9a0b70aff 100644 --- a/doc/admin-guide/source/compute-networking-nova.rst +++ b/doc/admin-guide/source/compute-networking-nova.rst @@ -135,7 +135,7 @@ compute node runs its own ``nova-network`` service. In both cases, all traffic between VMs and the internet flows through ``nova-network``. Each mode has benefits and drawbacks. For more on this, see the Network Topology section in the `OpenStack Operations Guide -`__. +`__. All networking options require network connectivity to be already set up between OpenStack physical nodes. OpenStack does not configure any @@ -195,7 +195,7 @@ configuration file. Specify the configuration file using the For more information about creating a dnsmasq configuration file, see the `OpenStack Configuration -Reference `__, +Reference `__, and `the dnsmasq documentation `__. @@ -720,7 +720,7 @@ to perform floating IP operations: For more information about how administrators can associate floating IPs with instances, see `Manage IP -addresses `__ +addresses `__ in the OpenStack Administrator Guide. Automatically add floating IPs diff --git a/doc/admin-guide/source/compute-node-down.rst b/doc/admin-guide/source/compute-node-down.rst index a1e0274e71..b17077835d 100644 --- a/doc/admin-guide/source/compute-node-down.rst +++ b/doc/admin-guide/source/compute-node-down.rst @@ -13,7 +13,7 @@ Evacuate instances If a hardware malfunction or other error causes the cloud compute node to fail, you can use the :command:`nova evacuate` command to evacuate instances. -See the `OpenStack Administrator Guide `__. +See the `OpenStack Administrator Guide `__. .. _nova-compute-node-down-manual-recovery: diff --git a/doc/admin-guide/source/compute-pci-passthrough.rst b/doc/admin-guide/source/compute-pci-passthrough.rst index d6de3251b2..428a847702 100644 --- a/doc/admin-guide/source/compute-pci-passthrough.rst +++ b/doc/admin-guide/source/compute-pci-passthrough.rst @@ -139,8 +139,8 @@ available with the specified ``vendor_id`` and ``product_id`` that matches the # openstack server create --flavor m1.large --image cirros-0.3.4-x86_64-uec --wait test-pci .. Links -.. _`Create Virtual Functions`: http://docs.openstack.org/newton/networking-guide/config-sriov.html#create-virtual-functions-compute -.. _`Configure nova-scheduler`: http://docs.openstack.org/newton/networking-guide/config-sriov.html#configure-nova-scheduler-controller -.. _`nova.conf configuration options`: http://docs.openstack.org/newton/config-reference/compute/config-options.html -.. _`flavor`: http://docs.openstack.org/admin-guide/compute-flavors.html -.. _`Networking Guide`: http://docs.openstack.org/newton/networking-guide/config-sriov.html +.. _`Create Virtual Functions`: https://docs.openstack.org/newton/networking-guide/config-sriov.html#create-virtual-functions-compute +.. _`Configure nova-scheduler`: https://docs.openstack.org/newton/networking-guide/config-sriov.html#configure-nova-scheduler-controller +.. _`nova.conf configuration options`: https://docs.openstack.org/newton/config-reference/compute/config-options.html +.. _`flavor`: https://docs.openstack.org/admin-guide/compute-flavors.html +.. _`Networking Guide`: https://docs.openstack.org/newton/networking-guide/config-sriov.html diff --git a/doc/admin-guide/source/compute-security.rst b/doc/admin-guide/source/compute-security.rst index 1b4f12adef..521661143d 100644 --- a/doc/admin-guide/source/compute-security.rst +++ b/doc/admin-guide/source/compute-security.rst @@ -6,7 +6,7 @@ Security hardening OpenStack Compute can be integrated with various third-party technologies to increase security. For more information, see the -`OpenStack Security Guide `_. +`OpenStack Security Guide `_. Trusted compute pools ~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/admin-guide/source/compute-service-groups.rst b/doc/admin-guide/source/compute-service-groups.rst index ebf5c4895c..9fd9dc8ad3 100644 --- a/doc/admin-guide/source/compute-service-groups.rst +++ b/doc/admin-guide/source/compute-service-groups.rst @@ -92,7 +92,7 @@ To use the memcache driver, you must install memcached. You might already have it installed, as the same driver is also used for the OpenStack Object Storage and OpenStack dashboard. To install memcached, see the *Environment -> Memcached* section in the -`Installation Tutorials and Guides `_ +`Installation Tutorials and Guides `_ depending on your distribution. These values in the ``/etc/nova/nova.conf`` file are required on every diff --git a/doc/admin-guide/source/cross-project-cors.rst b/doc/admin-guide/source/cross-project-cors.rst index 002faf9789..46b5ec5032 100644 --- a/doc/admin-guide/source/cross-project-cors.rst +++ b/doc/admin-guide/source/cross-project-cors.rst @@ -63,7 +63,7 @@ human-readable string: For more information about CORS configuration, see `cross-origin resource sharing -`_ +`_ in OpenStack Configuration Reference. Enabling CORS with PasteDeploy diff --git a/doc/admin-guide/source/dashboard-admin-manage-stacks.rst b/doc/admin-guide/source/dashboard-admin-manage-stacks.rst index 9fe369e3f3..d02ac98585 100644 --- a/doc/admin-guide/source/dashboard-admin-manage-stacks.rst +++ b/doc/admin-guide/source/dashboard-admin-manage-stacks.rst @@ -21,7 +21,7 @@ For information about: * administrative tasks on the command-line, see the `OpenStack Administrator Guide - `__. + `__. .. note:: @@ -30,5 +30,5 @@ For information about: * the basic creation and deletion of Orchestration stacks, refer to the `OpenStack End User Guide - `__. + `__. diff --git a/doc/admin-guide/source/dashboard-customize-configure.rst b/doc/admin-guide/source/dashboard-customize-configure.rst index 721d32c9ea..560e3b660a 100644 --- a/doc/admin-guide/source/dashboard-customize-configure.rst +++ b/doc/admin-guide/source/dashboard-customize-configure.rst @@ -141,7 +141,7 @@ Logo link Help URL -------- -#. By default, the help URL points to http://docs.openstack.org. To change +#. By default, the help URL points to https://docs.openstack.org. To change this, edit the following attribute in ``local_settings.py``: .. code-block:: python @@ -305,7 +305,7 @@ The standard installation uses a non-encrypted HTTP channel. The service catalog configuration in the Identity service determines whether a service appears in the Dashboard. For the full listing, see `Horizon Settings and Configuration - `_. + `_. #. Restart the Apache HTTP Server. diff --git a/doc/admin-guide/source/dashboard-manage-host-aggregates.rst b/doc/admin-guide/source/dashboard-manage-host-aggregates.rst index 7384179d3f..4c0b4883cb 100644 --- a/doc/admin-guide/source/dashboard-manage-host-aggregates.rst +++ b/doc/admin-guide/source/dashboard-manage-host-aggregates.rst @@ -11,7 +11,7 @@ multiple aggregates. The scheduler uses this information to make scheduling decisions. For information, see -`Scheduling `__. +`Scheduling `__. To create a host aggregate ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/admin-guide/source/dashboard-manage-images.rst b/doc/admin-guide/source/dashboard-manage-images.rst index 3a29d322ae..689a820b4f 100644 --- a/doc/admin-guide/source/dashboard-manage-images.rst +++ b/doc/admin-guide/source/dashboard-manage-images.rst @@ -10,9 +10,9 @@ access. To create and manage images in specified projects as an end user, see the `upload and manage images with Dashboard in OpenStack End User Guide -`_ +`_ and `manage images with CLI in OpenStack End User Guide -`_ . +`_ . To create and manage images as an administrator for other users, use the following procedures. @@ -21,7 +21,7 @@ Create images ~~~~~~~~~~~~~ For details about image creation, see the `Virtual Machine Image -Guide `_. +Guide `_. #. Log in to the Dashboard and select the :guilabel:`admin` project from the drop-down list. diff --git a/doc/admin-guide/source/dashboard-manage-instances.rst b/doc/admin-guide/source/dashboard-manage-instances.rst index 4f3fd797a9..9116f33218 100644 --- a/doc/admin-guide/source/dashboard-manage-instances.rst +++ b/doc/admin-guide/source/dashboard-manage-instances.rst @@ -8,7 +8,7 @@ create a snapshot from, and migrate instances. You can also view the logs for instances or launch a VNC console for an instance. For information about using the Dashboard to launch instances as an end -user, see the `OpenStack End User Guide `__. +user, see the `OpenStack End User Guide `__. Create instance snapshots ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -30,7 +30,7 @@ Create instance snapshots #. To launch an instance from the snapshot, select the snapshot and click :guilabel:`Launch`. For information about launching instances, see the - `OpenStack End User Guide `__. + `OpenStack End User Guide `__. Control the state of an instance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/admin-guide/source/dashboard-manage-shares.rst b/doc/admin-guide/source/dashboard-manage-shares.rst index aba6504433..4c0933a431 100644 --- a/doc/admin-guide/source/dashboard-manage-shares.rst +++ b/doc/admin-guide/source/dashboard-manage-shares.rst @@ -6,7 +6,7 @@ Shares are file storage that instances can access. Users can allow or deny a running instance to have access to a share at any time. For information about using the Dashboard to create and manage shares as an end user, see the -`OpenStack End User Guide `_. +`OpenStack End User Guide `_. As an administrative user, you can manage shares and share types for users in various projects. You can create and delete share types, and view diff --git a/doc/admin-guide/source/dashboard-manage-volumes.rst b/doc/admin-guide/source/dashboard-manage-volumes.rst index afe8b71f95..828f8f8549 100644 --- a/doc/admin-guide/source/dashboard-manage-volumes.rst +++ b/doc/admin-guide/source/dashboard-manage-volumes.rst @@ -6,7 +6,7 @@ Volumes are the Block Storage devices that you attach to instances to enable persistent storage. Users can attach a volume to a running instance or detach a volume and attach it to another instance at any time. For information about using the dashboard to create and manage volumes as an end user, see the -`OpenStack End User Guide `_. +`OpenStack End User Guide `_. As an administrative user, you can manage volumes and volume types for users in various projects. You can create and delete volume types, and you can view diff --git a/doc/admin-guide/source/dashboard-sessions.rst b/doc/admin-guide/source/dashboard-sessions.rst index 9c285b5294..b9a9068315 100644 --- a/doc/admin-guide/source/dashboard-sessions.rst +++ b/doc/admin-guide/source/dashboard-sessions.rst @@ -12,7 +12,7 @@ After architecting and implementing the core OpenStack services and other required services, combined with the Dashboard service steps below, users and administrators can use the OpenStack dashboard. Refer to the `OpenStack Dashboard -`__ +`__ chapter of the OpenStack End User Guide for further instructions on logging in to the Dashboard. diff --git a/doc/admin-guide/source/dashboard-set-quotas.rst b/doc/admin-guide/source/dashboard-set-quotas.rst index 0adf1770ab..9cac950c3a 100644 --- a/doc/admin-guide/source/dashboard-set-quotas.rst +++ b/doc/admin-guide/source/dashboard-set-quotas.rst @@ -24,7 +24,7 @@ quotas for new projects, as well as update quotas for existing projects. Using the command-line interface, you can manage quotas for the OpenStack Compute service, the OpenStack Block Storage service, and the OpenStack Networking service (see `OpenStack Administrator Guide - `_). + `_). Additionally, you can update Compute service quotas for project users. @@ -114,4 +114,4 @@ Update project quotas The dashboard does not show all possible project quotas. To view and update the quotas for a service, use its command-line client. See `OpenStack Administrator Guide - `_. + `_. diff --git a/doc/admin-guide/source/dashboard-view-cloud-resources.rst b/doc/admin-guide/source/dashboard-view-cloud-resources.rst index 2286dc08b8..223ea5553b 100644 --- a/doc/admin-guide/source/dashboard-view-cloud-resources.rst +++ b/doc/admin-guide/source/dashboard-view-cloud-resources.rst @@ -16,7 +16,7 @@ Compute) or by polling the infrastructure (for example, libvirt). :command:`ceilometer` command-line interface (CLI). For basic administration information, refer to the `Measure Cloud - Resources `_ + Resources `_ chapter in the OpenStack End User Guide. .. _dashboard-view-resource-stats: diff --git a/doc/admin-guide/source/dashboard.rst b/doc/admin-guide/source/dashboard.rst index 1f0262866b..b451a0d519 100644 --- a/doc/admin-guide/source/dashboard.rst +++ b/doc/admin-guide/source/dashboard.rst @@ -7,7 +7,7 @@ manage OpenStack resources and services. The Dashboard allows you to interact with the OpenStack Compute cloud controller using the OpenStack APIs. For more information about installing and configuring the Dashboard, see the `Installation Tutorials and Guides -`__ +`__ for your operating system. .. toctree:: @@ -27,11 +27,11 @@ for your operating system. dashboard-admin-manage-stacks.rst - To deploy the dashboard, see the `OpenStack dashboard documentation - `__. + `__. - To launch instances with the dashboard as an end user, see the `Launch and manage instances - `__. + `__. in the OpenStack End User Guide. - To create and manage ports, see the `Create and manage networks - `__ + `__ section of the OpenStack End User Guide. diff --git a/doc/admin-guide/source/database.rst b/doc/admin-guide/source/database.rst index d34bba7595..8947932bd4 100644 --- a/doc/admin-guide/source/database.rst +++ b/doc/admin-guide/source/database.rst @@ -23,7 +23,7 @@ configuration, patching, backups, restores, and monitoring. You can modify various cluster characteristics by editing the ``/etc/trove/trove.conf`` file. A comprehensive list of the Database service configuration options is described in the `Database service -`_ +`_ chapter in the *Configuration Reference*. Create a data store @@ -446,7 +446,7 @@ Redis. testing and Database service development installations. Do not use Redstack in a production environment. For more information, see `the Database service - developer docs `_ + developer docs `_ #. Start Redis: diff --git a/doc/admin-guide/source/identity-caching-layer.rst b/doc/admin-guide/source/identity-caching-layer.rst index d93c664eb0..1ebc7e1dd1 100644 --- a/doc/admin-guide/source/identity-caching-layer.rst +++ b/doc/admin-guide/source/identity-caching-layer.rst @@ -5,7 +5,7 @@ Caching layer OpenStack Identity supports a caching layer that is above the configurable subsystems (for example, token). OpenStack Identity uses the -`oslo.cache `__ +`oslo.cache `__ library which allows flexible cache back ends. The majority of the caching configuration options are set in the ``[cache]`` section of the ``/etc/keystone/keystone.conf`` file. However, each section that has diff --git a/doc/admin-guide/source/identity-concepts.rst b/doc/admin-guide/source/identity-concepts.rst index b2d3077a53..cc60b4f9d6 100644 --- a/doc/admin-guide/source/identity-concepts.rst +++ b/doc/admin-guide/source/identity-concepts.rst @@ -303,7 +303,7 @@ service, such as, a user named ``nova`` for the Compute service, and a special service project called ``service``. For information about how to create services and endpoints, see the -`OpenStack Administrator Guide `__. Groups diff --git a/doc/admin-guide/source/identity-integrate-with-ldap.rst b/doc/admin-guide/source/identity-integrate-with-ldap.rst index 45f9c77b85..a2ad2fb41d 100644 --- a/doc/admin-guide/source/identity-integrate-with-ldap.rst +++ b/doc/admin-guide/source/identity-integrate-with-ldap.rst @@ -240,7 +240,7 @@ administrators to use users and groups in LDAP. #. List the domains using the dashboard, or the OpenStackClient CLI. Refer to the `Command List - `__ + `__ for a list of OpenStackClient commands. #. Create domains using OpenStack dashboard, or the OpenStackClient CLI. @@ -386,7 +386,7 @@ Secure the OpenStack Identity service connection to an LDAP back end The Identity service supports the use of TLS to encrypt LDAP traffic. Before configuring this, you must first verify where your certificate authority file is located. For more information, see the -`OpenStack Security Guide SSL introduction `_. Once you verify the location of your certificate authority file: diff --git a/doc/admin-guide/source/networking-config-agents.rst b/doc/admin-guide/source/networking-config-agents.rst index 76eace0ce2..4d29eace90 100644 --- a/doc/admin-guide/source/networking-config-agents.rst +++ b/doc/admin-guide/source/networking-config-agents.rst @@ -126,7 +126,7 @@ service, or no longer needed. This feature applies to all plug-ins that support DHCP scaling. For more information, see the `DHCP agent configuration -options `__ +options `__ listed in the OpenStack Configuration Reference. DHCP agent setup: OVS plug-in @@ -418,7 +418,7 @@ Configure Hyper-V L2 agent Before you install the OpenStack Networking Hyper-V L2 agent on a Hyper-V compute node, ensure the compute node has been configured correctly using these -`instructions `__. +`instructions `__. **To install the OpenStack Networking Hyper-V agent and configure the node** @@ -444,7 +444,7 @@ correctly using these #. Create the ``C:\etc\neutron-hyperv-agent.conf`` file and add the proper configuration options and the `Hyper-V related - options `__. Here is a sample config file: + options `__. Here is a sample config file: .. code-block:: ini @@ -501,5 +501,5 @@ complete basic operations on agents. **Basic operations on Networking agents** See the `OpenStack Command-Line Interface -Reference `__ +Reference `__ for more information on Networking commands. diff --git a/doc/admin-guide/source/networking-config-identity.rst b/doc/admin-guide/source/networking-config-identity.rst index f311c0ef84..3c1098ad4f 100644 --- a/doc/admin-guide/source/networking-config-identity.rst +++ b/doc/admin-guide/source/networking-config-identity.rst @@ -115,7 +115,7 @@ Configure Identity service for Networking --project $SERVICE_TENANT For information about how to create service entries and users, see the `Newton Installation -Tutorials and Guides `_ +Tutorials and Guides `_ for your distribution. Compute diff --git a/doc/admin-guide/source/networking-config-plugins.rst b/doc/admin-guide/source/networking-config-plugins.rst index 563c9d091c..a0c4941944 100644 --- a/doc/admin-guide/source/networking-config-plugins.rst +++ b/doc/admin-guide/source/networking-config-plugins.rst @@ -3,7 +3,7 @@ Plug-in configurations ====================== For configurations options, see `Networking configuration -options `__ +options `__ in Configuration Reference. These sections explain how to configure specific plug-ins. @@ -31,7 +31,7 @@ Configure Big Switch (Floodlight REST Proxy) plug-in server = CONTROLLER_IP:PORT For database configuration, see `Install Networking - Services `__ + Services `__ in the Installation Tutorials and Guides. (The link defaults to the Ubuntu version.) @@ -77,9 +77,9 @@ Configure Brocade plug-in ostype = NOS For database configuration, see `Install Networking - Services `__ + Services `__ in any of the Installation Tutorials and Guides in the `OpenStack Documentation - index `__. (The link defaults to the Ubuntu + index `__. (The link defaults to the Ubuntu version.) #. Restart the ``neutron-server`` service to apply the settings: @@ -173,7 +173,7 @@ formerly known as Nicira NVP. NEUTRON_PLUGIN_CONFIG = /etc/neutron/plugins/vmware/nsx.ini For database configuration, see `Install Networking - Services `__ + Services `__ in the Installation Tutorials and Guides. #. Restart ``neutron-server`` to apply settings: @@ -236,7 +236,7 @@ Configure PLUMgrid plug-in password = "PLUMgrid-director-admin-password" For database configuration, see `Install Networking - Services `__ + Services `__ in the Installation Tutorials and Guides. #. Restart the ``neutron-server`` service to apply the settings: diff --git a/doc/admin-guide/source/networking-introduction.rst b/doc/admin-guide/source/networking-introduction.rst index 0e6727f2a6..9e0580418a 100644 --- a/doc/admin-guide/source/networking-introduction.rst +++ b/doc/admin-guide/source/networking-introduction.rst @@ -156,7 +156,7 @@ Least connections Firewall-as-a-Service (FWaaS) overview ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -For information on Firewall-as-a-Service (FWaaS), please consult the `Networking Guide `__. +For information on Firewall-as-a-Service (FWaaS), please consult the `Networking Guide `__. Allowed-address-pairs ~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/admin-guide/source/networking-multi-dhcp-agents.rst b/doc/admin-guide/source/networking-multi-dhcp-agents.rst index 0e097aa7fa..aff7a5ae97 100644 --- a/doc/admin-guide/source/networking-multi-dhcp-agents.rst +++ b/doc/admin-guide/source/networking-multi-dhcp-agents.rst @@ -3,5 +3,5 @@ Scalable and highly available DHCP agents ========================================= This section is fully described at the `High-availability for DHCP -`_ +`_ in the Networking Guide. diff --git a/doc/admin-guide/source/networking-use.rst b/doc/admin-guide/source/networking-use.rst index c26c36d6e7..cc414892b0 100644 --- a/doc/admin-guide/source/networking-use.rst +++ b/doc/admin-guide/source/networking-use.rst @@ -33,17 +33,17 @@ Networking API call has a corresponding :command:`neutron` command. The :command:`openstack` CLI is a common interface for all OpenStack projects, however, not every API operation has been implemented. For the list of available commands, see `Command List -`__. +`__. The :command:`neutron` CLI includes a number of options. For details, see -`Create and manage networks `__. +`Create and manage networks `__. Basic Networking operations --------------------------- To learn about advanced capabilities available through the :command:`neutron` command-line interface (CLI), read the networking section `Create and manage -networks `__ +networks `__ in the OpenStack End User Guide. This table shows example :command:`openstack` commands that enable you to diff --git a/doc/admin-guide/source/objectstorage-EC.rst b/doc/admin-guide/source/objectstorage-EC.rst index cef675697f..e01179ab2d 100644 --- a/doc/admin-guide/source/objectstorage-EC.rst +++ b/doc/admin-guide/source/objectstorage-EC.rst @@ -8,7 +8,7 @@ less capacity with similar durability characteristics as replicas. From an application perspective, erasure coding support is transparent. Object Storage (swift) implements erasure coding as a Storage Policy. See `Storage Policies -`_ +`_ for more details. There is no external API related to erasure coding. Create a container using a diff --git a/doc/admin-guide/source/objectstorage-admin.rst b/doc/admin-guide/source/objectstorage-admin.rst index b7390b47ca..0f62b7857e 100644 --- a/doc/admin-guide/source/objectstorage-admin.rst +++ b/doc/admin-guide/source/objectstorage-admin.rst @@ -5,7 +5,7 @@ System administration for Object Storage By understanding Object Storage concepts, you can better monitor and administer your storage solution. The majority of the administration information is maintained in developer documentation at -`docs.openstack.org/developer/swift/ `__. +`docs.openstack.org/developer/swift/ `__. -See the `OpenStack Configuration Reference `__ +See the `OpenStack Configuration Reference `__ for a list of configuration options for Object Storage. diff --git a/doc/admin-guide/source/objectstorage-components.rst b/doc/admin-guide/source/objectstorage-components.rst index ef56638a44..4cd3de0db5 100644 --- a/doc/admin-guide/source/objectstorage-components.rst +++ b/doc/admin-guide/source/objectstorage-components.rst @@ -49,7 +49,7 @@ take over. For more information concerning proxy server configuration, see `Configuration Reference -`_. +`_. Rings ----- diff --git a/doc/admin-guide/source/objectstorage-large-objects.rst b/doc/admin-guide/source/objectstorage-large-objects.rst index f6c790b3ad..33d803bc30 100644 --- a/doc/admin-guide/source/objectstorage-large-objects.rst +++ b/doc/admin-guide/source/objectstorage-large-objects.rst @@ -29,7 +29,7 @@ The large object is comprised of two types of objects: - **Dynamic large objects** To find out more information on large object support, see `Large objects -`_ +`_ in the OpenStack End User Guide, or `Large Object Support -`_ +`_ in the developer documentation. diff --git a/doc/admin-guide/source/objectstorage-monitoring.rst b/doc/admin-guide/source/objectstorage-monitoring.rst index 91691b9f96..92b905ef59 100644 --- a/doc/admin-guide/source/objectstorage-monitoring.rst +++ b/doc/admin-guide/source/objectstorage-monitoring.rst @@ -128,7 +128,7 @@ integrated into Object Storage itself. The submitted change set (see ``_) currently reports 124 meters across 15 Object Storage daemons and the tempauth middleware. Details of the meters tracked are in the `Administrator's -Guide `_. +Guide `_. The sending of meters is integrated with the logging framework. To enable, configure ``log_statsd_host`` in the relevant config file. You diff --git a/doc/admin-guide/source/orchestration-introduction.rst b/doc/admin-guide/source/orchestration-introduction.rst index 4aea46ecaf..d66498499d 100644 --- a/doc/admin-guide/source/orchestration-introduction.rst +++ b/doc/admin-guide/source/orchestration-introduction.rst @@ -29,4 +29,4 @@ a web interface. For more information about using the Orchestration service through the command line, see the `OpenStack Command-Line Interface Reference -`_. +`_. diff --git a/doc/admin-guide/source/shared-file-systems-crud-share.rst b/doc/admin-guide/source/shared-file-systems-crud-share.rst index 6ef224328b..ff96823099 100644 --- a/doc/admin-guide/source/shared-file-systems-crud-share.rst +++ b/doc/admin-guide/source/shared-file-systems-crud-share.rst @@ -746,7 +746,7 @@ Allow access to the share with ``user`` access type: For the example, the Generic driver with the Block Storage service as a back-end doesn't support ``user`` and ``cert`` authentications methods. For details of supporting of features by different drivers, see `Manila share - features support mapping `_. To verify that the access rules (ACL) were configured correctly for a share, diff --git a/doc/admin-guide/source/shared-file-systems-network-plugins.rst b/doc/admin-guide/source/shared-file-systems-network-plugins.rst index 050d596a46..0b38c73bd3 100644 --- a/doc/admin-guide/source/shared-file-systems-network-plugins.rst +++ b/doc/admin-guide/source/shared-file-systems-network-plugins.rst @@ -80,4 +80,4 @@ Shared File Systems service: These network plug-ins were introduced in the OpenStack Kilo release. In the OpenStack Juno version, only NeutronNetworkPlugin is available. -More information about network plug-ins can be found in `Manila developer documentation `_ +More information about network plug-ins can be found in `Manila developer documentation `_ diff --git a/doc/admin-guide/source/shared-file-systems-scheduling.rst b/doc/admin-guide/source/shared-file-systems-scheduling.rst index 2d0ff313c6..a970733893 100644 --- a/doc/admin-guide/source/shared-file-systems-scheduling.rst +++ b/doc/admin-guide/source/shared-file-systems-scheduling.rst @@ -15,7 +15,7 @@ A share type is a list from key-value pairs called extra-specs. The scheduler uses required and un-scoped extra-specs to look up the shared service most suitable for a new share with the specified share type. For more information about extra-specs and their type, see `Capabilities -and Extra-Specs `_ section in developer documentation. +and Extra-Specs `_ section in developer documentation. The general scheduler workflow: diff --git a/doc/admin-guide/source/shared-file-systems-share-replication.rst b/doc/admin-guide/source/shared-file-systems-share-replication.rst index 2ad47a629b..547dcfb6cd 100644 --- a/doc/admin-guide/source/shared-file-systems-share-replication.rst +++ b/doc/admin-guide/source/shared-file-systems-share-replication.rst @@ -134,7 +134,7 @@ separate networks. The service network is reachable from the host where the ``manila-share`` service is running. The share export IP is from a network that allows user access. -See `Configuring the ZFSonLinux driver `_ +See `Configuring the ZFSonLinux driver `_ for information on how to set up the ZFSonLinux driver. diff --git a/doc/admin-guide/source/shared-file-systems-share-types.rst b/doc/admin-guide/source/shared-file-systems-share-types.rst index 3bf9534930..fa260b6ef7 100644 --- a/doc/admin-guide/source/shared-file-systems-share-types.rst +++ b/doc/admin-guide/source/shared-file-systems-share-types.rst @@ -59,7 +59,7 @@ for the following purposes: The scheduler uses the special capabilities prefix for filtering. The scheduler can only create a share on a back end that reports capabilities matching the un-scoped extra-spec keys for the share type. For details, see `Capabilities -and Extra-Specs `_. Each driver implementation determines which extra specification keys it uses. diff --git a/doc/admin-guide/source/support-compute.rst b/doc/admin-guide/source/support-compute.rst index 406c2f0dd3..0ba2ef5271 100644 --- a/doc/admin-guide/source/support-compute.rst +++ b/doc/admin-guide/source/support-compute.rst @@ -78,7 +78,7 @@ The report has the following sections: * Configuration: Lists all configuration options currently accessible through the CONF object for the current process. -For more information, see `Guru Meditation Reports `_. +For more information, see `Guru Meditation Reports `_. .. _compute-common-errors-and-fixes: diff --git a/doc/admin-guide/source/telemetry-alarms.rst b/doc/admin-guide/source/telemetry-alarms.rst index ed478c2cc4..4604f48ff1 100644 --- a/doc/admin-guide/source/telemetry-alarms.rst +++ b/doc/admin-guide/source/telemetry-alarms.rst @@ -116,7 +116,7 @@ information about this approach, see the section called To use this workload partitioning solution set the ``evaluation_service`` option to ``default``. For more information, see the alarm section in the -`OpenStack Configuration Reference `_. +`OpenStack Configuration Reference `_. Using alarms ~~~~~~~~~~~~ diff --git a/doc/admin-guide/source/telemetry-best-practices.rst b/doc/admin-guide/source/telemetry-best-practices.rst index b419b0b71e..e9cbd00537 100644 --- a/doc/admin-guide/source/telemetry-best-practices.rst +++ b/doc/admin-guide/source/telemetry-best-practices.rst @@ -94,7 +94,7 @@ Data storage For more information on how to configure ``mod_wsgi``, see the `Telemetry Install Documentation - `__. + `__. #. The collection service provided by the Telemetry project is not intended to be an archival service. Set a Time to Live (TTL) value to expire data diff --git a/doc/admin-guide/source/telemetry-data-collection.rst b/doc/admin-guide/source/telemetry-data-collection.rst index 47bddc2b02..8830212b57 100644 --- a/doc/admin-guide/source/telemetry-data-collection.rst +++ b/doc/admin-guide/source/telemetry-data-collection.rst @@ -88,7 +88,7 @@ types by each OpenStack service that Telemetry transforms into samples. image.send - The required configuration for Image service can be * - service found in - `Configure the Image service for Telemetry `__ + `Configure the Image service for Telemetry `__ section in the Installation Tutorials and Guides. * - OpenStack Networking - floatingip.create.end @@ -171,7 +171,7 @@ types by each OpenStack service that Telemetry transforms into samples. volume.backup.restore.\ \* - The required configuration for Block Storage service can be found in the - `Add the Block Storage service agent for Telemetry section `__ + `Add the Block Storage service agent for Telemetry section `__ in the Installation Tutorials and Guides. .. note:: @@ -186,7 +186,7 @@ administrators and users. Configuring ``nova_notifications`` in the ``nova.conf`` file allows administrators to respond to events rapidly. For more information on configuring notifications for the compute service, see -`Telemetry services `__ in the Installation Tutorials and Guides. @@ -209,7 +209,7 @@ information locally. A Compute agent instance has to be installed on each and every compute node, installation instructions can be found in the `Install the Compute agent for Telemetry -`__ section in the Installation Tutorials and Guides. @@ -242,7 +242,7 @@ meters are listed in :ref:`telemetry-object-storage-meter`, marked with The instructions on how to install this middleware can be found in `Configure the Object Storage service for Telemetry -`__ section in the Installation Tutorials and Guides. @@ -341,7 +341,7 @@ The following services can be polled with this agent: framework To install and configure this service use the `Add the Telemetry service -`__ +`__ section in the Installation Tutorials and Guides. The central agent does not need direct database connection. The samples @@ -399,7 +399,7 @@ above several back ends that can be used for building distributed applications. Tooz supports `various -drivers `__ +drivers `__ including the following back end solutions: - `Zookeeper `__. Recommended solution by @@ -416,7 +416,7 @@ Telemetry services. For information about the required configuration options that have to be set in the ``ceilometer.conf`` configuration file for both the central and Compute agents, see the `Coordination section -`__ +`__ in the OpenStack Configuration Reference. Notification agent HA deployment @@ -430,7 +430,7 @@ in a larger amount of load. To enable workload partitioning by notification agent, the ``backend_url`` option must be set in the ``ceilometer.conf`` configuration file. Additionally, ``workload_partitioning`` should be enabled in the -`Notification section `__ in the OpenStack Configuration Reference. +`Notification section `__ in the OpenStack Configuration Reference. .. note:: @@ -468,7 +468,7 @@ central agent configuration also supports using different configuration files for groups of service instances of this type that are running in parallel. For enabling this configuration set a value for the ``partitioning_group_prefix`` option in the `polling section -`__ +`__ in the OpenStack Configuration Reference. .. warning:: @@ -483,7 +483,7 @@ in the OpenStack Configuration Reference. To enable the Compute agent to run multiple instances simultaneously with workload partitioning, the ``workload_partitioning`` option has to be set to ``True`` under the `Compute section -`__ +`__ in the ``ceilometer.conf`` configuration file. @@ -725,7 +725,7 @@ Multiple ``ceilometer-collector`` processes can be run at a time. It is also supported to start multiple worker threads per collector process. The ``collector_workers`` configuration option has to be modified in the `Collector section -`__ +`__ of the ``ceilometer.conf`` configuration file. Database dispatcher @@ -782,7 +782,7 @@ target. The samples are sent without any modification. To set this option as the collector's target, the ``dispatcher`` has to be changed to ``http`` in the ``ceilometer.conf`` configuration file. For the list of options that you need to set, see the see the `dispatcher_http -section `__ +section `__ in the OpenStack Configuration Reference. File dispatcher @@ -791,5 +791,5 @@ File dispatcher You can store samples in a file by setting the ``dispatcher`` option in the ``ceilometer.conf`` file. For the list of configuration options, see the `dispatcher_file section -`__ +`__ in the OpenStack Configuration Reference. diff --git a/doc/admin-guide/source/telemetry-data-pipelines.rst b/doc/admin-guide/source/telemetry-data-pipelines.rst index 8f24d154f2..253d61bc95 100644 --- a/doc/admin-guide/source/telemetry-data-pipelines.rst +++ b/doc/admin-guide/source/telemetry-data-pipelines.rst @@ -51,7 +51,7 @@ the ``ceilometer.conf`` file. The meter pipeline and event pipeline configuration files can be set by the ``pipeline_cfg_file`` and ``event_pipeline_cfg_file`` options listed in the `Description of configuration options for api table -`__ +`__ section in the OpenStack Configuration Reference respectively. Multiple pipelines can be defined in one pipeline configuration file. diff --git a/doc/admin-guide/source/telemetry-data-retrieval.rst b/doc/admin-guide/source/telemetry-data-retrieval.rst index fbe3296309..956acfd9db 100644 --- a/doc/admin-guide/source/telemetry-data-retrieval.rst +++ b/doc/admin-guide/source/telemetry-data-retrieval.rst @@ -57,12 +57,12 @@ be a list of data structures that consist of the following items: Regardless of the endpoint on which the filter is applied on, it will always target the fields of the `Sample type -`__. +`__. Several fields of the API endpoints accept shorter names than the ones defined in the reference. The API will do the transformation internally and return the output with the fields that are listed in the `API reference -`__. +`__. The fields are the following: - ``project_id``: project @@ -129,7 +129,7 @@ The ``filter``, ``orderby`` and ``limit`` fields are optional. As opposed to the simple query, complex query is available via a separate API endpoint. For more information see the `Telemetry v2 Web API - Reference `__. + Reference `__. Statistics ---------- @@ -189,7 +189,7 @@ the requested operations. To be able to use the :command:`ceilometer` command, the python-ceilometerclient package needs to be installed and configured properly. For details about the installation process, see the `Telemetry -chapter `__ +chapter `__ in the Installation Tutorials and Guides. .. note:: @@ -479,7 +479,7 @@ The method calls look like the following: For further details about the python-ceilometerclient package, see the `Python bindings to the OpenStack Ceilometer -API `__ +API `__ reference. .. _telemetry-publishers: diff --git a/doc/admin-guide/source/telemetry-events.rst b/doc/admin-guide/source/telemetry-events.rst index fc1cb5dbb5..31890c2c8b 100644 --- a/doc/admin-guide/source/telemetry-events.rst +++ b/doc/admin-guide/source/telemetry-events.rst @@ -18,7 +18,7 @@ Event configuration To enable the creation and storage of events in the Telemetry service ``store_events`` option needs to be set to ``True``. For further configuration options, see the event section in the `OpenStack Configuration Reference -`__. +`__. .. note:: diff --git a/doc/admin-guide/source/telemetry-measurements.rst b/doc/admin-guide/source/telemetry-measurements.rst index ee2de9f838..c7dbc69f5d 100644 --- a/doc/admin-guide/source/telemetry-measurements.rst +++ b/doc/admin-guide/source/telemetry-measurements.rst @@ -20,9 +20,9 @@ below. You may need to configure Telemetry or other OpenStack services in order to be able to collect all the samples you need. For further information about configuration requirements see the `Telemetry chapter - `__ + `__ in the Installation Tutorials and Guides. Also check the `Telemetry manual - installation `__ + installation `__ description. Telemetry uses the following meter types: @@ -83,7 +83,7 @@ Telemetry or emit notifications that this service consumes. way of using Telemetry is to configure it to use the event store and turn off the collection of the event related meters. For further information about events see `Events section - `__ + `__ in the Telemetry documentation. For further information about how to turn on and off meters see :ref:`telemetry-pipeline-configuration`. Please also note that currently no migration is available to move the already @@ -452,7 +452,7 @@ the compute host machines. In order to use that you need to set the ``compute_monitors`` option to ``ComputeDriverCPUMonitor`` in the ``nova.conf`` configuration file. For further information see the Compute configuration section in the `Compute chapter -`__ +`__ of the OpenStack Configuration Reference. The following host machine related meters are collected for OpenStack @@ -508,7 +508,7 @@ data from the host machine. The sensor data is not available in the Bare metal service by default. To enable the meters and configure this module to emit notifications about the measured values see the `Installation - Guide `__ + Guide `__ for the Bare metal service. The following meters are recorded for the Bare metal service: diff --git a/doc/admin-guide/source/telemetry-system-architecture.rst b/doc/admin-guide/source/telemetry-system-architecture.rst index fdf9ae65bc..8dc4122b4b 100644 --- a/doc/admin-guide/source/telemetry-system-architecture.rst +++ b/doc/admin-guide/source/telemetry-system-architecture.rst @@ -165,7 +165,7 @@ Users, roles, and projects This service of OpenStack uses OpenStack Identity for authenticating and authorizing users. The required configuration options are listed in the `Telemetry -section `__ +section `__ in the OpenStack Configuration Reference. The system uses two roles:``admin`` and ``non-admin``. The authorization diff --git a/doc/admin-guide/source/telemetry-troubleshooting-guide.rst b/doc/admin-guide/source/telemetry-troubleshooting-guide.rst index 66111221d4..a1b1a26c2e 100644 --- a/doc/admin-guide/source/telemetry-troubleshooting-guide.rst +++ b/doc/admin-guide/source/telemetry-troubleshooting-guide.rst @@ -11,7 +11,7 @@ logging, the format of the log entries and the log levels. The log settings can be changed in ``ceilometer.conf``. The list of configuration options are listed in the logging configuration options table in the `Telemetry -section `__ +section `__ in the OpenStack Configuration Reference. By default ``stderr`` is used as standard output for the log messages. @@ -61,7 +61,7 @@ service and the log file of Telemetry should be checked first. For the list of meters that are originated from notifications, see the `Telemetry Measurements -Reference `__. +Reference `__. Recommended auth_url to be used @@ -71,7 +71,7 @@ When using the Telemetry command-line client, the credentials and the ``os_auth_url`` have to be set in order for the client to authenticate against OpenStack Identity. For further details about the credentials that have to be provided see the `Telemetry Python -API `__. +API `__. The service catalog provided by OpenStack Identity contains the URLs that are available for authentication. The URLs have diff --git a/doc/admin-guide/source/ts-no-emulator-x86-64.rst b/doc/admin-guide/source/ts-no-emulator-x86-64.rst index 22cca43284..1c62da64dc 100644 --- a/doc/admin-guide/source/ts-no-emulator-x86-64.rst +++ b/doc/admin-guide/source/ts-no-emulator-x86-64.rst @@ -15,5 +15,5 @@ On the KVM host, run :command:`cat /proc/cpuinfo`. Make sure the ``vmx`` or ``svm`` flags are set. Follow the instructions in the `Enable KVM -`__ section in the OpenStack Configuration Reference to enable hardware +`__ section in the OpenStack Configuration Reference to enable hardware virtualization support in your BIOS.