From fab1e80cb25c511384566affd3196a6d3f9ec5fa Mon Sep 17 00:00:00 2001 From: Maria Zlatkova Date: Tue, 14 Feb 2017 19:29:44 +0200 Subject: [PATCH] [admin-guide] Update links for Ocata Change-Id: I0baaaf19d8da682a1f2f5bfaf4e6a6d4562c9071 --- .../source/baremetal-multitenancy.rst | 2 +- .../source/blockstorage-volume-migration.rst | 2 +- doc/admin-guide/source/cli-cinder-quotas.rst | 2 +- doc/admin-guide/source/compute-arch.rst | 4 +-- .../source/compute-cpu-topologies.rst | 2 +- doc/admin-guide/source/compute-flavors.rst | 2 +- .../source/compute-images-instances.rst | 10 ++++---- .../source/compute-live-migration-usage.rst | 2 +- .../source/compute-manage-logs.rst | 2 +- .../source/compute-networking-nova.rst | 2 +- .../source/compute-pci-passthrough.rst | 8 +++--- .../source/compute-service-groups.rst | 2 +- doc/admin-guide/source/cross-project-cors.rst | 2 +- .../dashboard-manage-host-aggregates.rst | 2 +- doc/admin-guide/source/dashboard.rst | 2 +- doc/admin-guide/source/database.rst | 2 +- doc/admin-guide/source/index.rst | 2 +- .../source/networking-adv-features.rst | 2 +- .../source/networking-config-agents.rst | 6 ++--- .../source/networking-config-identity.rst | 4 +-- .../source/networking-config-plugins.rst | 10 ++++---- .../source/networking-introduction.rst | 2 +- .../source/networking-multi-dhcp-agents.rst | 2 +- .../source/objectstorage-admin.rst | 2 +- .../source/objectstorage-components.rst | 2 +- .../shared-file-systems-share-replication.rst | 2 +- doc/admin-guide/source/telemetry-alarms.rst | 2 +- .../source/telemetry-data-collection.rst | 25 ++++++++++--------- .../source/telemetry-data-pipelines.rst | 2 +- .../source/telemetry-data-retrieval.rst | 2 +- .../source/telemetry-measurements.rst | 6 ++--- .../source/telemetry-system-architecture.rst | 8 +++--- .../telemetry-troubleshooting-guide.rst | 2 +- .../source/ts-no-emulator-x86-64.rst | 2 +- 34 files changed, 66 insertions(+), 65 deletions(-) diff --git a/doc/admin-guide/source/baremetal-multitenancy.rst b/doc/admin-guide/source/baremetal-multitenancy.rst index 03f145dc23..3b5bd5ba59 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-volume-migration.rst b/doc/admin-guide/source/blockstorage-volume-migration.rst index 9f3625cd1f..8d58ed94b2 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/cli-cinder-quotas.rst b/doc/admin-guide/source/cli-cinder-quotas.rst index 43422f8f3c..88bd71f23e 100644 --- a/doc/admin-guide/source/cli-cinder-quotas.rst +++ b/doc/admin-guide/source/cli-cinder-quotas.rst @@ -85,7 +85,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/compute-arch.rst b/doc/admin-guide/source/compute-arch.rst index b83ae8a258..adeb2e5004 100644 --- a/doc/admin-guide/source/compute-arch.rst +++ b/doc/admin-guide/source/compute-arch.rst @@ -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-cpu-topologies.rst b/doc/admin-guide/source/compute-cpu-topologies.rst index bc1feeed04..6a8472bfd2 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`: https://docs.openstack.org/newton/config-reference/compute/scheduler.html +.. _`Scheduling`: https://docs.openstack.org/ocata/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 f113a6559a..3d1fe4c6e8 100644 --- a/doc/admin-guide/source/compute-flavors.rst +++ b/doc/admin-guide/source/compute-flavors.rst @@ -527,7 +527,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-images-instances.rst b/doc/admin-guide/source/compute-images-instances.rst index 839ae94209..31c3a7b45d 100644 --- a/doc/admin-guide/source/compute-images-instances.rst +++ b/doc/admin-guide/source/compute-images-instances.rst @@ -31,7 +31,7 @@ flavors that you can edit or add to. - 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 ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -414,7 +414,7 @@ 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 865139e0c4..0e7a0d5a8c 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 6c3123b58c..b94be9bb41 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-networking-nova.rst b/doc/admin-guide/source/compute-networking-nova.rst index d46a02590d..b13b8bc062 100644 --- a/doc/admin-guide/source/compute-networking-nova.rst +++ b/doc/admin-guide/source/compute-networking-nova.rst @@ -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 `__. diff --git a/doc/admin-guide/source/compute-pci-passthrough.rst b/doc/admin-guide/source/compute-pci-passthrough.rst index 428a847702..9cd99f2304 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`: 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 +.. _`Create Virtual Functions`: https://docs.openstack.org/ocata/networking-guide/config-sriov.html#create-virtual-functions-compute +.. _`Configure nova-scheduler`: https://docs.openstack.org/ocata/networking-guide/config-sriov.html#configure-nova-scheduler-controller +.. _`nova.conf configuration options`: https://docs.openstack.org/ocata/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 +.. _`Networking Guide`: https://docs.openstack.org/ocata/networking-guide/config-sriov.html diff --git a/doc/admin-guide/source/compute-service-groups.rst b/doc/admin-guide/source/compute-service-groups.rst index 9fd9dc8ad3..5bd49020fa 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 46b5ec5032..26a8c553a2 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-manage-host-aggregates.rst b/doc/admin-guide/source/dashboard-manage-host-aggregates.rst index 4c0b4883cb..c3134850c0 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.rst b/doc/admin-guide/source/dashboard.rst index b451a0d519..d2ef6c763e 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:: diff --git a/doc/admin-guide/source/database.rst b/doc/admin-guide/source/database.rst index 8947932bd4..e2391f7eca 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 diff --git a/doc/admin-guide/source/index.rst b/doc/admin-guide/source/index.rst index 07e15cbc73..fa20c8c69e 100644 --- a/doc/admin-guide/source/index.rst +++ b/doc/admin-guide/source/index.rst @@ -8,7 +8,7 @@ Abstract OpenStack offers open source software for OpenStack administrators to manage and troubleshoot an OpenStack cloud. -This guide documents OpenStack Newton and Mitaka releases. +This guide documents OpenStack Ocata, Newton, and Mitaka releases. Contents ~~~~~~~~ diff --git a/doc/admin-guide/source/networking-adv-features.rst b/doc/admin-guide/source/networking-adv-features.rst index 9527ba44c4..03a99af880 100644 --- a/doc/admin-guide/source/networking-adv-features.rst +++ b/doc/admin-guide/source/networking-adv-features.rst @@ -180,7 +180,7 @@ routers can connect multiple L2 Networking networks and can also provide a gateway that connects one or more private L2 networks to a shared external network. For example, a public network for access to the Internet. See the `OpenStack Configuration Reference `_ for details on common +openstack.org/ocata/config-reference/>`_ for details on common models of deploying Networking L3 routers. The L3 router provides basic NAT capabilities on gateway ports that diff --git a/doc/admin-guide/source/networking-config-agents.rst b/doc/admin-guide/source/networking-config-agents.rst index 4d29eace90..339668e2c2 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 diff --git a/doc/admin-guide/source/networking-config-identity.rst b/doc/admin-guide/source/networking-config-identity.rst index 3c1098ad4f..7d57645876 100644 --- a/doc/admin-guide/source/networking-config-identity.rst +++ b/doc/admin-guide/source/networking-config-identity.rst @@ -114,8 +114,8 @@ Configure Identity service for Networking $ openstack role add $ADMIN_ROLE --user $NEUTRON_USER \ --project $SERVICE_TENANT -For information about how to create service entries and users, see the `Newton Installation -Tutorials and Guides `_ +For information about how to create service entries and users, see the `Ocata Installation +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 a0c4941944..66047119fb 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,7 +77,7 @@ 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 version.) @@ -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 39cd2ae1dc..e6d3da61ee 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 aff7a5ae97..582b497fde 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/objectstorage-admin.rst b/doc/admin-guide/source/objectstorage-admin.rst index 0f62b7857e..f0323e495d 100644 --- a/doc/admin-guide/source/objectstorage-admin.rst +++ b/doc/admin-guide/source/objectstorage-admin.rst @@ -7,5 +7,5 @@ administer your storage solution. The majority of the administration information is maintained in developer documentation at `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 4cd3de0db5..11b8feac01 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/shared-file-systems-share-replication.rst b/doc/admin-guide/source/shared-file-systems-share-replication.rst index 547dcfb6cd..b641424f9f 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/telemetry-alarms.rst b/doc/admin-guide/source/telemetry-alarms.rst index 4604f48ff1..9c56c3edeb 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-data-collection.rst b/doc/admin-guide/source/telemetry-data-collection.rst index 4904a4ddb2..cce6a49a63 100644 --- a/doc/admin-guide/source/telemetry-data-collection.rst +++ b/doc/admin-guide/source/telemetry-data-collection.rst @@ -94,8 +94,9 @@ types by each OpenStack service that Telemetry transforms into samples. image.delete image.send + - The required configuration for Image service can be found in the - `Configure the Image service for Telemetry `__ + `Configure the Image service for Telemetry `__ section in the Installation Tutorials and Guides. * - OpenStack Networking - floatingip.create.end @@ -178,7 +179,8 @@ 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 `__ + `Add the Block Storage service agent for Telemetry + `__ section in the Installation Tutorials and Guides. .. note:: @@ -194,7 +196,7 @@ administrators and users. Configuring ``nova_notifications`` in the rapidly. For more information on configuring notifications for the compute service, see `Telemetry services `__ in the +telemetry/ocata/configure_services/nova/install-nova-ubuntu.html>`__ in the Installation Tutorials and Guides. Middleware for the OpenStack Object Storage service @@ -210,7 +212,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 `__ +telemetry/ocata/configure_services/swift/install-swift-ubuntu.html>`__ section in the Installation Tutorials and Guides. Telemetry middleware @@ -297,7 +299,7 @@ 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 `__ +telemetry/ocata/configure_services/nova/install-nova-ubuntu.html>`__ section in the Installation Tutorials and Guides. The compute agent does not need direct database connection. The samples @@ -339,7 +341,7 @@ The following services can be polled with this agent: framework (deprecated in Newton) To install and configure this service use the `Add the Telemetry service -`__ +`__ section in the Installation Tutorials and Guides. Just like the compute agent, this component also does not need a direct @@ -405,7 +407,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 @@ -418,7 +420,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. The notification agent creates multiple queues to divide the workload across all active agents. The number of queues can be controlled by the @@ -458,7 +460,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:: @@ -473,7 +475,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. @@ -697,7 +699,7 @@ Multiple ``ceilometer-agent-notification`` agents can be run at a time. It is also supported to start multiple worker threads per agent. The ``workers`` configuration option has to be modified in the `notification section -`__ +`__ of the ``ceilometer.conf`` configuration file. .. note:: @@ -797,4 +799,3 @@ The level of support differs in case of the configured back end: - No - DB2 NoSQL does not have native TTL nor ``ceilometer-expirer`` support. - diff --git a/doc/admin-guide/source/telemetry-data-pipelines.rst b/doc/admin-guide/source/telemetry-data-pipelines.rst index 253d61bc95..c8a39524e9 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 75b6bb668c..8896852e9f 100644 --- a/doc/admin-guide/source/telemetry-data-retrieval.rst +++ b/doc/admin-guide/source/telemetry-data-retrieval.rst @@ -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:: diff --git a/doc/admin-guide/source/telemetry-measurements.rst b/doc/admin-guide/source/telemetry-measurements.rst index 592936fef4..e4da1345da 100644 --- a/doc/admin-guide/source/telemetry-measurements.rst +++ b/doc/admin-guide/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 Installation Tutorials and Guides. Also check the `Telemetry manual installation `__ description. @@ -459,7 +459,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 @@ -515,7 +515,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 92442cafbf..f2c5c2aef2 100644 --- a/doc/admin-guide/source/telemetry-system-architecture.rst +++ b/doc/admin-guide/source/telemetry-system-architecture.rst @@ -150,10 +150,10 @@ 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 `__ -in the OpenStack Configuration Reference. Alternatively, gnocchi can be -configured without authentication to minimize overhead. +`Telemetry section +`__ in the +OpenStack Configuration Reference. Alternatively, gnocchi can be configured +without authentication to minimize overhead. The system uses two roles:``admin`` and ``non-admin``. The authorization happens before processing each API request. The amount of returned data diff --git a/doc/admin-guide/source/telemetry-troubleshooting-guide.rst b/doc/admin-guide/source/telemetry-troubleshooting-guide.rst index f4e8a8dd95..f6dc78ee85 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. 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 1c62da64dc..b45ae73dcc 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.