diff --git a/doc/source/admin/telemetry-system-architecture.rst b/doc/source/admin/telemetry-system-architecture.rst index 13d182e254..e3f1c0ae11 100644 --- a/doc/source/admin/telemetry-system-architecture.rst +++ b/doc/source/admin/telemetry-system-architecture.rst @@ -5,37 +5,32 @@ System architecture =================== The Telemetry service uses an agent-based architecture. Several modules -combine their responsibilities to collect data, store samples in a -database, or provide an API service for handling incoming requests. +combine their responsibilities to collect, normalize, and redirect data +to be used for use cases such as metering, monitoring, and alerting. -The Telemetry service is built from the following agents and services: +The Telemetry service is built from the following agents: ceilometer-polling Polls for different kinds of meter data by using the polling plug-ins (pollsters) registered in different namespaces. It provides a - single polling interface across different namespaces. The ``compute`` - namespace polls the local hypervisor to acquire performance data of local - instances. The ``central`` namespace polls the public RESTful APIs of other - OpenStack services such as Compute service and Image service. The ``ipmi`` - namespace polls the local node with IPMI support, in order to acquire IPMI - sensor data and Intel Node Manager datahost-level information. + single polling interface across different namespaces. + +.. note:: + + The ``ceilometer-polling`` service provides polling support on any + namespace but many distributions continue to provide namespace-scoped + agents: ``ceilometer-agent-central``, ``ceilometer-agent-compute``, + and ``ceilometer-agent-ipmi``. ceilometer-agent-notification Consumes AMQP messages from other OpenStack services, normalizes messages, and publishes them to configured targets. - .. note:: - - The ``ceilometer-polling`` service provides polling support on any - namespace but many distributions continue to provide namespace-scoped - agents: ``ceilometer-agent-central``, ``ceilometer-agent-compute``, - and ``ceilometer-agent-ipmi``. - Except for the ``ceilometer-polling`` agents polling the ``compute`` or ``ipmi`` namespaces, all the other services are placed on one or more controller nodes. -The Telemetry architecture highly depends on the AMQP service both for +The Telemetry architecture depends on the AMQP service both for consuming notifications coming from OpenStack services and internal communication. @@ -71,8 +66,6 @@ The list of supported base back ends for events: - `PostgreSQL `__ -- `HBase `__ - .. _telemetry-supported-hypervisors: @@ -85,67 +78,23 @@ compute hosts. The following is a list of supported hypervisors. -- The following hypervisors are supported via `libvirt `__ - - * `Kernel-based Virtual Machine (KVM) `__ - - * `Quick Emulator (QEMU) `__ - - * `Linux Containers (LXC) `__ - - * `User-mode Linux (UML) `__ - - .. note:: - - For details about hypervisor support in libvirt please check the - `Libvirt API support matrix `__. - +- `Libvirt supported hypervisors `__ such as KVM and QEMU - `Hyper-V `__ - - `XEN `__ - - `VMware vSphere `__ +.. note:: + + For details about hypervisor support in libvirt please see the + `Libvirt API support matrix `__. + Supported networking services ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Telemetry is able to retrieve information from OpenStack Networking and -external networking services: - -- OpenStack Networking: - - - Basic network meters - - - Firewall-as-a-Service (FWaaS) meters - - - Load-Balancer-as-a-Service (LBaaS) meters - - - VPN-as-a-Service (VPNaaS) meters +Telemetry is able to retrieve information from external networking services: - SDN controller meters: - `OpenDaylight `__ - - `OpenContrail `__ - - -.. _telemetry-users-roles-projects: - -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. - -The system uses two roles:``admin`` and ``non-admin``. The authorization -happens before processing each API request. The amount of returned data -depends on the role the requestor owns. - -The creation of alarm definitions also highly depends on the role of the -user, who initiated the action. Further details about :ref:`telemetry-alarms` -handling can be found in this guide.