From 804b49b86dd1427e25e6a93918758c8afa8aef61 Mon Sep 17 00:00:00 2001 From: Mark Nellemann Date: Fri, 4 Sep 2020 06:51:36 +0200 Subject: [PATCH] Cleanup of README --- README.md | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e1b1d7d..fff4085 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,27 @@ HMCi is a small utility to fetch metrics from one or more HMC's and push those t ![screenshot](https://bitbucket.org/mnellemann/hmci/downloads/HMCi.png) - ## Usage Instructions -- Ensure you have correct date/time and NTP running to keep it accurate! -- Install HMCi *.deb* or *.rpm* file from [downloads](https://bitbucket.org/mnellemann/hmci/downloads/) or compile from source -- Copy the *doc/hmci.groovy.tpl* configuration template into */etc/hmci.groovy* and edit the configuration to suit your environment -- Configure Grafana to communicate with your InfluxDB and import dashboards from *doc/* into Grafana (The dashboards are slightly modified versions of the dashboard provided by the nmon2influxdb tool) +- Ensure you have correct date/time and use a NTP service to keep it accurate! +- Install the HMCi package (*.deb* or *.rpm*) from [downloads](https://bitbucket.org/mnellemann/hmci/downloads/) or compile from source. +- Copy the *doc/hmci.groovy.tpl* configuration template into */etc/hmci.groovy* and edit the configuration to suit your environment. You can use the *-c [conf-file]* switch if you place this file elsewhere. +- Configure Grafana to communicate with your InfluxDB and import dashboards from *doc/* into Grafana (The dashboards are slightly modified versions of the dashboard provided by the nmon2influxdb tool). - Run the *bin/hmci* program in a shell, as a @reboot cron task or setup a proper service :) +### InfluxDB and Grafana Packages -### Power Binaries +You can download [Grafana ppc64le](https://www.power-devops.com/grafana) and [InfluxDB ppc64le](https://www.power-devops.com/influxdb) packages for most Linux distributions and AIX on the [Power DevOps](https://www.power-devops.com/) site. -You can download [Grafana](https://www.power-devops.com/grafana) and [InfluxDB](https://www.power-devops.com/influxdb) ppc64le packages for most Linux distributions and AIX from the [Power DevOps](https://www.power-devops.com/) site. +Binaries for amd64/x86 are available from the [Grafana website](https://grafana.com/grafana/download) and [InfluxDB website](https://portal.influxdata.com/downloads/) and also directly from your Linux distribution repository in some cases. -#### Notes +### Notes Examples on how to change the default InfluxDB retention policy: ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 156w ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 90d -#### InfluxDB and Grafana Packages - -You can download [Grafana ppc64le](https://www.power-devops.com/grafana) and [InfluxDB ppc64le](https://www.power-devops.com/influxdb) packages for most Linux distributions and AIX on the [Power DevOps](https://www.power-devops.com/) site. - -Binaries for amd64/x86 are available from the [Grafana website](https://grafana.com/grafana/download) and [InfluxDB website](https://portal.influxdata.com/downloads/) and also directly from your Linux distribution repository in some cases. - ## Development Information You need JDK version 8 or later. @@ -41,7 +35,6 @@ Use the gradle build tool, which will download all required dependencies. ./gradlew clean build - #### InfluxDB for local testing Start the InfluxDB container @@ -52,7 +45,6 @@ To use the Influx client from the same container docker exec -it influxdb influx - #### Grafana for local testing Start the Grafana container, linking it to the InfluxDB container