22.18. drp-prom-mon - Prometheus Monitoring¶

The following documentation is for Prometheus Monitoring (drp-prom-mon) content package at version v4.12.0-alpha00.78+gc037aaa40eb3ad853690ce178f9ab8a5bae4c436.

22.18.1. Object Specific Documentation¶

22.18.1.1. params¶

The content package provides the following params.

22.18.1.1.1. drp-prom-mon/cluster-profile¶

This param will be set to the users cloned profile name for the cluster. It is used to identify the Profile to write Param data to for subsequent use during install and configuration stages.

This Params should be used in a cloned Profile which contains the name of the Clone in this Param.

22.18.1.1.2. drp-prom-mon/drp-prefs-defaultBootenv¶

Set the Global Preferences for default Boot Environment.

22.18.1.1.3. drp-prom-mon/drp-prefs-knownTokenTimeout¶

Set the Global Preferences for known token timeout.

22.18.1.1.4. drp-prom-mon/drp-prefs-unknownBootenv¶

Set the Global Preferences for unknown Boot Environment.

22.18.1.1.5. drp-prom-mon/drp-prefs-unknownStage¶

Set the Global Preferences for unknown Stage.

22.18.1.1.6. drp-prom-mon/drp-prefs-unknownTokenTimeout¶

Set the Global Preferences for unknown token timeout.

22.18.1.1.7. drp-prom-mon/drp-skip-prefs¶

Set to true to skip setting Global Preferences

22.18.1.1.8. drp-prom-mon/drp-version¶

This param will set the version of Digital Rebar Provision to install on the Machine.

Set this to any value supported by the DRP installer script. Typically these values would be like the following:

|Name|Description| |-|-| |`stable`|current production 'stable' release| |`tip`|current 'tip' release (usually tracks a few commits behind 'master'| |`v3.7.3`|an explicit version to install - the leading 'v' is required in the version string|

22.18.1.1.9. drp-prom-mon/installer-version¶

This param will set the version of the ‘install.sh’ script to install this DRP instance with.

The only options supported are:

stable

tip

22.18.1.1.10. drp-prom-mon/node-exporter¶

This param will be set to the Machine IP address that the Node Exporter will be running on. Node Exporter will feed metrics to the Prometheus/Grafana instance

Prometheus pulls stats, so no need to configure the Node Exporter to know about it. However, Prometheus DOES need to be configured to know about Node Exporter to scrape stats.

This Param is used in the Prometheus install task.

22.18.1.1.11. drp-prom-mon/skip-centos-7-install¶

Set to true to skip installing CentOS 7 Install ISO

22.18.1.1.12. drp-prom-mon/skip-sledgehammer¶

Set to true to skip installing Sledgehammer Discover Image

22.18.1.1.13. drp-prom-mon/skip-ubuntu-1604-install¶

Set to true to skip installing Ubuntu 16 Install ISO

22.18.1.2. profiles¶

The content package provides the following profiles.

22.18.1.2.1. install-drp¶

This stage installs Digital Rebar Provision on a machine. It currently defaults to install stable version in the ‘production’ install mode (not isolated).

Future versions of this content will give you the ability to customize your install via Params.

This stage requires a supported Operating System with the runner service running (drpcli agent).

22.18.1.2.2. install-grafana¶

Extremely simple stage to install Grafana on a Machine.

The Operating System must be installed already, and the Agent (drpcli) must be installed and running (which can be done via the ‘runner-service’ or ‘drp-agent’ stage.

22.18.1.2.3. install-node-exporter¶

You MUST clone this profile, and apply the clone to the Machines you are configuring for Node Exporter and Prometheus services. In addition, you must set the name of your cloned Profile in the ‘drp-prom-mon/cluster-name’ Param.

The ‘cfg-node-exporter.sh.tmpl’ Template will collect the Machines IP Address and add a the Param ‘drp-prom-mon/node-exporter’ to the cloned profile. DO NOT create the Param, otherwise, the template will fail with an error.

22.18.1.2.4. install-prom-mon¶

Installs the Prometheus and Grafana tools, and configures a Node Exporter for Prometheus.

You MUST clone this profile, and apply the clone to the Machines you are configuring for Node Exporter and Prometheus services. In addition, you must set the name of your cloned Profile in the ‘drp-prom-mon/cluster-name’ Param.

The ‘cfg-node-exporter.sh.tmpl’ Template will collect the Machines IP Address and add a the Param ‘drp-prom-mon/node-exporter’ to the cloned profile. DO NOT create the Param, otherwise, the template will fail with an error.

22.18.1.2.5. install-prometheus¶

You MUST clone this profile, and apply the clone to the Machines you are configuring for Node Exporter and Prometheus services. In addition, you must set the name of your cloned Profile in the ‘drp-prom-mon/cluster-name’ Param.

The ‘cfg-node-exporter.sh.tmpl’ Template will collect the Machines IP Address and add a the Param ‘drp-prom-mon/node-exporter’ to the cloned profile. DO NOT create the Param, otherwise, the template will fail with an error.

The Prometheus configuration task will use the Param to write the config appropriately for the service to scrape the Node Exporter.

22.18.1.2.6. prom-mon-prep-ubuntu¶

This stage installs ubuntu on a machine and the runner service. It leaves runner-service running for the following drp-prom-mon install steps.

The associated profile (‘prom-mon-single-node’) sets the needed param ‘drp-prom-mon/node-exporter’ value to the machines loopback address (127.0.0.1).

22.18.1.2.7. prom-mon-single-node¶

This profile defins the install of a drp-prom-mon cluster in one step. DRP, Node Exporter, Prometheus, and Grafana components will be installed. All pieces are installed on a single Machine.

You do NOT need to clone this profile as it doesn’t require write access to the Params for a Single Node install.

The ‘drp-prom-mon/node-exporter’ is set to loopback address because we are only running on a single machine instance.

The Machines must have a supported OS installed, and the ‘drpcli’ runner Agent must be running.

22.18.1.3. stages¶

The content package provides the following stages.

22.18.1.3.1. install-drp¶

Stage that install DRP endpoint.

22.18.1.3.2. install-grafana¶

Stage that installs and configures Grafana

22.18.1.3.3. install-node-exporter¶

Stage that installs and configures Node Exporter

22.18.1.3.4. install-prom-mon¶

Stage that installs Prometheus/Grafana monitoring

22.18.1.3.5. install-prometheus¶

Stage that installs Prometheus monitoring

22.18.1.3.6. prom-mon-single-node¶

Single node with DRP/Node Exporter/Prometheus/Grafana setup

22.18.1.3.7. start-prom-mon¶

Start the prom-mon process on this Machine.

22.18.1.4. tasks¶

The content package provides the following tasks.

22.18.1.4.1. add-node-exporter-param¶

The ‘drp-prom-mon/node-exporter’ Param defines the IP Address of the Node Exporter that will be scraped by the Prometheus instance. This value will subsequently be used by the Prometheus configuration steps to add a scrape rule to config files for collecting metrics.

22.18.1.4.2. cfg-drp-cc¶

A task to install DRP community content

22.18.1.4.3. cfg-drp-centos7¶

A task to configure DRP content bootenv Centos 7

22.18.1.4.4. cfg-drp-prefs¶

Set the Global Preferences for a DRP instance. If the associated OptionalParams are set, then the default settings will be overridden with the value specified. The defaults for the BootEnv and Stages will assume Discover/Sledgehamer/Discovery.

22.18.1.4.5. cfg-drp-sledgehammer¶

A task to configure DRP sledgehammer

22.18.1.4.6. cfg-drp-ubuntu1604¶

A task to configure DRP content bootenv Ubuntu 16.04

22.18.1.4.7. cfg-grafana¶

This task configures the drp-prom-mon Grafana component. The Prometheus Datasource will be setup, the default admin credentials will be changed, and the grafana shared dashboard (ID 405) will be installed.

22.18.1.4.8. install-drp¶

A task to install Digital Rebar Provision on a Machine.

22.18.1.4.9. install-grafana¶

A task to install Grafana.

22.18.1.4.10. install-node-exporter¶

This task installs the Node Exporter package on a given machine. It also will record the Node Exporter systems IP address in the param ‘drp-prom-mon/node-exporter’. This value will subsequently be used by the Prometheus Stage to collect (scrape) metrics from this machine.

The Param ‘drp-prom-mon/cluster-profile’ MUST BE SET on the machine so that the Stage can record the Pram information correctly.

If the Param ‘drp-prom-mon/cluster-profile’ is set to the value

prom-mon-single-node

Then the Stage will assume this is an all-in-one DRP/Prometheus/ Node Exporter/Grafana platform - and you DO NOT have to set the cluster profile.

22.18.1.4.11. install-prometheus¶

A task to Install Prometheus