Embellish overview documentation

Signed-off-by: Zack Cerza <zack@redhat.com>

diff --git a/roles/pcp/README.rst b/roles/pcp/README.rst
index 01c00678798d66c033d8e1da2666d4d4d62aa959..cafd2c97b083ff40c10c0d37f867598f5e01e988 100644 (file)
--- a/roles/pcp/README.rst
+++ b/roles/pcp/README.rst
@@ -2,6 +2,12 @@ PCP
 ===
 This role is used to configure a node to run PCP_.
 
+PCP's main function is to collect performance-related metrics. By default, this
+role will set up each node as a ``pcp_collector``. It is also capable of
+installing and configuring the necessary packages to act as a ``pcp_manager``,
+collecting data from all the ``pcp_collector`` nodes; and also as a ``pcp_web``
+host, providing various web UIs to display the data graphically.
+
 These distros should be fully supported:
 
 - CentOS 7
@@ -20,11 +26,13 @@ Variables
 
 Defaults for these variables are defined in ``roles/pcp/defaults/main.yml``.
 
-To tell a given host to collect performance data::
+To tell a given host to collect performance data using ``pmcd``, and to run
+``pmlogger`` to create archive logs::
 
     pcp_collector: true
 
-To tell the host to aggregate data from other systems::
+To tell the host to aggregate data from other systems using ``pmmgr`` and
+corresponding ``pmlogger`` processes for each ``pcp_collector`` node::
 
     pcp_manager: true