diff --git a/doc/admin-guide-cloud/source/compute-manage-the-cloud.rst b/doc/admin-guide-cloud/source/compute-manage-the-cloud.rst index 52922f3c03..99def56282 100644 --- a/doc/admin-guide-cloud/source/compute-manage-the-cloud.rst +++ b/doc/admin-guide-cloud/source/compute-manage-the-cloud.rst @@ -67,7 +67,7 @@ the Identity Service. $ nova help SUBCOMMAND For a complete list of ``nova`` commands and parameters, see the - `OpenStack Command-Line Reference `__. + `OpenStack Command-Line Reference `__. #. Set the required parameters as environment variables to make running commands easier. For example, you can add :option:`--os-username` as a diff --git a/doc/admin-guide-cloud/source/compute-service-groups.rst b/doc/admin-guide-cloud/source/compute-service-groups.rst index 0b7a1db8b8..1d206fdfb1 100644 --- a/doc/admin-guide-cloud/source/compute-service-groups.rst +++ b/doc/admin-guide-cloud/source/compute-service-groups.rst @@ -95,7 +95,7 @@ more details, see `memcached.org `_. 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. If you need to install -memcached, see the instructions in the `OpenStack Installation Guide `_. +memcached, see the instructions in the `OpenStack Installation Guide `_. These values in the :file:`/etc/nova/nova.conf` file are required on every node for the memcache driver: diff --git a/doc/admin-guide-cloud/source/compute_arch.rst b/doc/admin-guide-cloud/source/compute_arch.rst index bdf02b8152..68b86e3647 100644 --- a/doc/admin-guide-cloud/source/compute_arch.rst +++ b/doc/admin-guide-cloud/source/compute_arch.rst @@ -196,7 +196,8 @@ In addition to the native compute API, OpenStack provides an EC2-compatible API. This API allows EC2 legacy workflows built for EC2 to work with OpenStack. For more information and configuration options about this compatibility API, see the `OpenStack Configuration -Reference `__. +Reference `__. Numerous third-party tools and language-specific SDKs can be used to interact with OpenStack clouds, using both native and compatibility diff --git a/doc/admin-guide-cloud/source/identity_concepts.rst b/doc/admin-guide-cloud/source/identity_concepts.rst index 2c24bf5547..f208fcfc6c 100644 --- a/doc/admin-guide-cloud/source/identity_concepts.rst +++ b/doc/admin-guide-cloud/source/identity_concepts.rst @@ -325,7 +325,8 @@ service, such as, a user named ``nova`` for the Compute service, and a special service tenant called ``service``. For information about how to create services and endpoints, see the -`OpenStack Admin User Guide `__. +`OpenStack Admin User Guide `__. Groups ~~~~~~ diff --git a/doc/admin-guide-cloud/source/networking_config-agents.rst b/doc/admin-guide-cloud/source/networking_config-agents.rst index 978b68d7b1..d97eb709a9 100644 --- a/doc/admin-guide-cloud/source/networking_config-agents.rst +++ b/doc/admin-guide-cloud/source/networking_config-agents.rst @@ -517,5 +517,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-cloud/source/networking_config-identity.rst b/doc/admin-guide-cloud/source/networking_config-identity.rst index 09a2391c0f..5955ab6c09 100644 --- a/doc/admin-guide-cloud/source/networking_config-identity.rst +++ b/doc/admin-guide-cloud/source/networking_config-identity.rst @@ -117,7 +117,7 @@ Configure Identity service for Networking For information about how to create service entries and users, see the OpenStack Installation Guide for your distribution -(`docs.openstack.org `__). +(`docs.openstack.org `__). Compute ~~~~~~~ diff --git a/doc/admin-guide-cloud/source/networking_config-plugins.rst b/doc/admin-guide-cloud/source/networking_config-plugins.rst index aac4d1ddeb..203f076406 100644 --- a/doc/admin-guide-cloud/source/networking_config-plugins.rst +++ b/doc/admin-guide-cloud/source/networking_config-plugins.rst @@ -32,8 +32,8 @@ Configure Big Switch (Floodlight REST Proxy) plug-in server = CONTROLLER_IP:PORT For database configuration, see `Install Networking - Services `__ + Services `__ in the Installation Guide in the `OpenStack Documentation index `__. (The link defaults to the Ubuntu version.) @@ -80,8 +80,8 @@ Configure Brocade plug-in ostype = NOS For database configuration, see `Install Networking - Services `__ + Services `__ in any of the Installation Guides in the `OpenStack Documentation index `__. (The link defaults to the Ubuntu version.) @@ -177,8 +177,8 @@ 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 Guide. #. Restart neutron-server to apply settings: @@ -241,8 +241,8 @@ Configure PLUMgrid plug-in password = "PLUMgrid-director-admin-password" For database configuration, see `Install Networking - Services `__ + Services `__ in the Installation Guide. #. Restart the neutron-server service to apply the settings: diff --git a/doc/admin-guide-cloud/source/objectstorage-admin.rst b/doc/admin-guide-cloud/source/objectstorage-admin.rst index 34a6636a29..7de0c08b21 100644 --- a/doc/admin-guide-cloud/source/objectstorage-admin.rst +++ b/doc/admin-guide-cloud/source/objectstorage-admin.rst @@ -8,5 +8,5 @@ information is maintained in developer documentation at `docs.openstack.org/developer/swift/ `__. See the `OpenStack Configuration -Reference `__ +Reference `__ for a list of configuration options for Object Storage. diff --git a/doc/admin-guide-cloud/source/telemetry-data-collection.rst b/doc/admin-guide-cloud/source/telemetry-data-collection.rst index d60b867a25..52c09b438c 100644 --- a/doc/admin-guide-cloud/source/telemetry-data-collection.rst +++ b/doc/admin-guide-cloud/source/telemetry-data-collection.rst @@ -75,11 +75,10 @@ each OpenStack service that are transformed to samples by Telemetry. | | image.upload | found in `Configure the Image | | | | service for Telemetry section | | | image.delete | `__ section in | -| | | the OpenStack Installation | -| | | Guide. | +| | | /liberty/install-guide-ubuntu | +| | image.send | /ceilometer-glance.html>`__ | +| | | section in the OpenStack | +| | | Installation Guide | +--------------------+------------------------+-------------------------------+ | OpenStack | floatingip.create.end | | | Networking | | | @@ -133,10 +132,10 @@ each OpenStack service that are transformed to samples by Telemetry. | | volume.create.\* | be found in the `Add the | | | | Block Storage service agent | | | volume.delete.\* | for Telemetry section `__ section in the | +| | | //docs.openstack.org/liberty/ | +| | volume.update.\* | install-guide-ubuntu/ | +| | | /ceilometer-cinder.html>`__ | +| | volume.resize.\* | section in the | | | | OpenStack Installation Guide. | | | volume.attach.\* | | | | | | @@ -164,7 +163,7 @@ administrators and users. Configuring nova_notifications in the rapidly. For more information on configuring notifications for the compute service, see `Chapter 11 on Telemetry services `__ in the +liberty/install-guide-ubuntu/ceilometer-nova.html>`__ in the OpenStack Installation Guide. .. note:: @@ -184,7 +183,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 OpenStack Installation Guide. Telemetry middleware @@ -274,7 +273,7 @@ The following services can be polled with this agent: framework To install and configure this service use the `Install the Telemetry module -`__ +`__ section in the OpenStack Installation Guide. The central agent does not need direct database connection. The samples @@ -298,7 +297,7 @@ information. 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 OpenStack Installation Guide. Just like the central agent, this component also does not need a direct @@ -380,7 +379,7 @@ Telemetry services. For information about the required configuration options that have to be set in the :file:`ceilometer.conf` configuration file for both the central and compute agents, see the `Coordination section -`__ +`__ in the OpenStack Configuration Reference. Notification agent HA deployment @@ -393,7 +392,7 @@ in a larger amount of load. To enable workload partitioning by notification agent, the ``backend_url`` option must be set in the :file:`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:: @@ -431,7 +430,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 `Central section -`__ +`__ in the OpenStack Configuration Reference. .. warning:: @@ -446,7 +445,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 :file:`ceilometer.conf` configuration file. @@ -559,7 +558,7 @@ the :file:`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. @@ -1007,7 +1006,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 :file:`ceilometer.conf` configuration file. Database dispatcher @@ -1057,7 +1056,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 :file:`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 @@ -1065,7 +1064,7 @@ File dispatcher You can store samples in a file by setting the ``dispatcher`` option in the :file:`ceilometer.conf` file. For the list of configuration options, see the `dispatcher_file section -`__ +`__ in the OpenStack Configuration Reference. Gnocchi dispatcher @@ -1077,5 +1076,5 @@ configuration file. For the list of options that you need to set, see the `dispatcher_gnocchi section -`__ +`__ in the OpenStack Configuration Reference. diff --git a/doc/admin-guide-cloud/source/telemetry-data-retrieval.rst b/doc/admin-guide-cloud/source/telemetry-data-retrieval.rst index 73cebca493..009d7509ff 100644 --- a/doc/admin-guide-cloud/source/telemetry-data-retrieval.rst +++ b/doc/admin-guide-cloud/source/telemetry-data-retrieval.rst @@ -185,7 +185,7 @@ the requested operations. To be able to use the ``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 OpenStack Installation Guide. .. note:: diff --git a/doc/admin-guide-cloud/source/telemetry-measurements.rst b/doc/admin-guide-cloud/source/telemetry-measurements.rst index 4ec076474b..9d1a84289a 100644 --- a/doc/admin-guide-cloud/source/telemetry-measurements.rst +++ b/doc/admin-guide-cloud/source/telemetry-measurements.rst @@ -20,7 +20,7 @@ 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 OpenStack Installation Guide. Also check the `Telemetry manual installation `__ description. @@ -420,7 +420,7 @@ the compute host machines. In order to use that you need to set the ``compute_monitors`` option to ``ComputeDriverCPUMonitor`` in the :file:`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 diff --git a/doc/admin-guide-cloud/source/telemetry-troubleshooting-guide.rst b/doc/admin-guide-cloud/source/telemetry-troubleshooting-guide.rst index a865dbd66a..7d4a36e836 100644 --- a/doc/admin-guide-cloud/source/telemetry-troubleshooting-guide.rst +++ b/doc/admin-guide-cloud/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 :file:`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. diff --git a/doc/install-guide/source/glance-verify.rst b/doc/install-guide/source/glance-verify.rst index e97c49575a..6ccb6fbb44 100644 --- a/doc/install-guide/source/glance-verify.rst +++ b/doc/install-guide/source/glance-verify.rst @@ -10,7 +10,7 @@ For more information about how to download and build images, see `__. For information about how to manage images, see the `OpenStack User Guide -`__. +`__. #. In each client environment script, configure the Image service client to use API version 2.0: diff --git a/doc/user-guide-admin/source/dashboard_manage_volumes.rst b/doc/user-guide-admin/source/dashboard_manage_volumes.rst index 107f485680..75d28d753c 100644 --- a/doc/user-guide-admin/source/dashboard_manage_volumes.rst +++ b/doc/user-guide-admin/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