From: Zack Cerza Date: Thu, 31 Mar 2016 18:18:38 +0000 (-0600) Subject: Embellish overview documentation X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F214%2Fhead;p=ceph-cm-ansible.git Embellish overview documentation Signed-off-by: Zack Cerza --- diff --git a/roles/pcp/README.rst b/roles/pcp/README.rst index 01c00678..cafd2c97 100644 --- 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