Update documentation.
This commit is contained in:
parent
8bf6f3dfbd
commit
ec5ab3f706
10
README.md
10
README.md
|
|
@ -47,7 +47,7 @@ If you do not enable *Performance Monitoring Data Collection for Managed Servers
|
|||
Install InfluxDB (v. **1.8.x** or **1.9.x** for best compatibility with Grafana) on a host which is network accessible by the HMCi utility (the default InfluxDB port is 8086). You can install Grafana on the same server or any server which are able to connect to the InfluxDB database. The Grafana installation needs to be accessible from your browser (default on port 3000). The default settings for both InfluxDB and Grafana will work fine as a start.
|
||||
|
||||
- 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) (select the *OSS* variant) and [InfluxDB website](https://portal.influxdata.com/downloads/) and most likely directly from your Linux distributions repositories.
|
||||
- Binaries for amd64/x86 are available from the [Grafana website](https://grafana.com/grafana/download) (select the **OSS variant**) and [InfluxDB website](https://portal.influxdata.com/downloads/) and most likely directly from your Linux distributions repositories.
|
||||
- Create the empty *hmci* database by running the **influx** CLI command and type:
|
||||
|
||||
```text
|
||||
|
|
@ -58,7 +58,7 @@ See the [Influx documentation](https://docs.influxdata.com/influxdb/v1.8/query_l
|
|||
|
||||
### 3 - HMCi Installation & Configuration
|
||||
|
||||
Install *HMCi* on a host, which can connect to the Power HMC (on port 12443), and is also allowed to connect to the InfluxDB service. This *can be* the same LPAR/VM as used for the InfluxDB installation.
|
||||
Install *HMCi* on a host, that can connect to your Power HMC (on port 12443), and is also allowed to connect to the InfluxDB service. This *can be* the same LPAR/VM as used for the InfluxDB installation.
|
||||
|
||||
- Ensure you have **correct date/time** and NTPd running to keep it accurate!
|
||||
- The only requirement for **hmci** is the Java runtime, version 8 (or later)
|
||||
|
|
@ -153,9 +153,11 @@ Below are screenshots of the provided Grafana dashboards (found in the **doc/**
|
|||
|
||||
## Known problems
|
||||
|
||||
### Incomplete test of metrics
|
||||
### Incomplete set of metrics
|
||||
|
||||
I have not been able to test and verify all types of metric data. If you encounter any missing or wrong data, please contact me, so I can try to fix it. It is possible to run **hmci** with *-d -d* to log JSON data received by the HCM, which can help me implement missing data.
|
||||
I have not been able to test and verify all types of metric data. If you encounter any missing or wrong data, please [contact me](mark.nellemann@gmail.com) and I will try to fix it.
|
||||
|
||||
It is possible to save the raw JSON data received from the HCM, which can help me implement missing data. You need to specify **trace = "/tmp/hmci-trace"** or some other location, in the configuration file under the HMC instance.
|
||||
|
||||
|
||||
### Naming collision
|
||||
|
|
|
|||
20
doc/readme-aix.md
Normal file
20
doc/readme-aix.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
# Instructions for AIX Systems
|
||||
|
||||
Please note that the software versions referenced in this document might have changed and might not be available/working unless updated.
|
||||
|
||||
More details are available in the [README.md](../README.md) file.
|
||||
|
||||
- Grafana and InfluxDB can be downloaded from the [Power DevOps](https://www.power-devops.com/) website - look under the *Monitor* section.
|
||||
|
||||
- Ensure Java (version 8 or later) is installed and available in your PATH.
|
||||
|
||||
|
||||
## Download and Install HMCi
|
||||
|
||||
```shell
|
||||
wget https://bitbucket.org/mnellemann/hmci/downloads/hmci-1.3.1-1_all.rpm
|
||||
rpm -i --ignoreos hmci-1.3.1-1_all.rpm
|
||||
cp /opt/hmci/doc/hmci.toml /etc/
|
||||
```
|
||||
|
||||
Now modify */etc/hmci.toml* and test your setup by running ```/opt/hmci/bin/hmci -d```
|
||||
53
doc/readme-debian.md
Normal file
53
doc/readme-debian.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# Instruction for Debian / Ubuntu Systems
|
||||
|
||||
Please note that the software versions referenced in this document might have changed and might not be available/working unless updated.
|
||||
|
||||
More details are available in the [README.md](../README.md) file.
|
||||
|
||||
|
||||
## Install the Java Runtime from repository
|
||||
|
||||
```shell
|
||||
sudo apt-get install default-jre-headless
|
||||
```
|
||||
|
||||
|
||||
## Download and Install InfluxDB
|
||||
|
||||
```shell
|
||||
wget https://dl.influxdata.com/influxdb/releases/influxdb_1.8.10_amd64.deb
|
||||
sudo dpkg -i influxdb_1.8.10_amd64.deb
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable influxdb
|
||||
sudo systemctl start influxdb
|
||||
```
|
||||
|
||||
Run the ```influx``` cli command and create the *hmci* database.
|
||||
|
||||
|
||||
## Download and Install Grafana
|
||||
|
||||
```shell
|
||||
sudo apt-get install -y adduser libfontconfig1
|
||||
wget https://dl.grafana.com/oss/release/grafana_9.1.3_amd64.deb
|
||||
sudo dpkg -i grafana_9.1.3_amd64.deb
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable grafana-server
|
||||
sudo systemctl start grafana-server
|
||||
```
|
||||
|
||||
When logged in to Grafana (port 3000, admin/admin) create a datasource that points to the local InfluxDB. Now import the provided dashboards.
|
||||
|
||||
|
||||
## Download and Install HMCi
|
||||
|
||||
```shell
|
||||
wget https://bitbucket.org/mnellemann/hmci/downloads/hmci_1.3.1-1_all.deb
|
||||
sudo dpkg -i hmci_1.3.1-1_all.deb
|
||||
cp /opt/hmci/doc/hmci.toml /etc/
|
||||
cp /opt/hmci/doc/hmci.service /etc/systemd/system/
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable hmci
|
||||
```
|
||||
|
||||
Now modify */etc/hmci.toml* and test setup by running ```/opt/hmci/bin/hmci -d``` manually and verify connection to HMC and InfluxDB. Afterwards start service with ```systemctl start hmci``` .
|
||||
|
|
@ -5,6 +5,7 @@
|
|||
And any other Linux distribution using *firewalld*.
|
||||
|
||||
### Allow remote access to Grafana on port 3000
|
||||
|
||||
```shell
|
||||
firewall-cmd --zone=public --add-port=3000/tcp --permanent
|
||||
firewall-cmd --reload
|
||||
|
|
|
|||
53
doc/readme-redhat.md
Normal file
53
doc/readme-redhat.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# Instruction for RedHat / CentOS / AlmaLinux Systems
|
||||
|
||||
Please note that the software versions referenced in this document might have changed and might not be available/working unless updated.
|
||||
|
||||
More details are available in the [README.md](../README.md) file. If you are running Linux on Power (ppc64le) you should look for ppc64le packages at the [Power DevOps](https://www.power-devops.com/) website.
|
||||
|
||||
|
||||
## Install the Java Runtime from repository
|
||||
|
||||
```shell
|
||||
sudo dnf install java-11-openjdk-headless
|
||||
```
|
||||
|
||||
|
||||
## Download and Install InfluxDB
|
||||
|
||||
```shell
|
||||
wget https://dl.influxdata.com/influxdb/releases/influxdb-1.8.10.x86_64.rpm
|
||||
sudo yum localinstall influxdb-1.8.10.x86_64.rpm
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable influxdb
|
||||
sudo systemctl start influxdb
|
||||
```
|
||||
|
||||
Run the ```influx``` cli command and create the *hmci* database.
|
||||
|
||||
|
||||
## Download and Install Grafana
|
||||
|
||||
```shell
|
||||
wget https://dl.grafana.com/oss/release/grafana-9.1.3-1.x86_64.rpm
|
||||
sudo yum install grafana-9.1.3-1.x86_64.rpm
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable grafana-server
|
||||
sudo systemctl start grafana-server
|
||||
```
|
||||
|
||||
When logged in to Grafana (port 3000, admin/admin) create a datasource that points to the local InfluxDB. Now import the provided dashboards.
|
||||
|
||||
|
||||
## Download and Install HMCi
|
||||
|
||||
```shell
|
||||
wget https://bitbucket.org/mnellemann/hmci/downloads/hmci_1.3.1-1_all.deb
|
||||
sudo dpkg -i hmci_1.3.1-1_all.deb
|
||||
cp /opt/hmci/doc/hmci.toml /etc/
|
||||
cp /opt/hmci/doc/hmci.service /etc/systemd/system/
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable hmci
|
||||
sudo systemctl start hmci
|
||||
```
|
||||
|
||||
Now modify */etc/hmci.toml* and test your setup by running ```/opt/hmci/bin/hmci -d``` manually and verify connection to HMC and InfluxDB. Afterwards start service with ```systemctl start hmci``` .
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
# HMCi as a System Service
|
||||
|
||||
## Systemd
|
||||
|
||||
To install as a systemd service, copy the **hmci.service**
|
||||
file into */etc/systemd/system/* and enable the service:
|
||||
|
||||
```shell
|
||||
cp /opt/hmci/doc/hmci.service /etc/systemd/system/
|
||||
systemctl daemon-reload
|
||||
systemctl enable hmci.service
|
||||
systemctl restart hmci.service
|
||||
```
|
||||
|
||||
To read log output from the service:
|
||||
|
||||
```shell
|
||||
journalctl -f -u hmci.service
|
||||
```
|
||||
|
||||
52
doc/readme-suse.md
Normal file
52
doc/readme-suse.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# Instruction for SLES / OpenSUSE Systems
|
||||
|
||||
Please note that the software versions referenced in this document might have changed and might not be available/working unless updated.
|
||||
|
||||
More details are available in the [README.md](../README.md) file. If you are running Linux on Power (ppc64le) you should look for ppc64le packages at the [Power DevOps](https://www.power-devops.com/) website.
|
||||
|
||||
|
||||
## Install the Java Runtime from repository
|
||||
|
||||
```shell
|
||||
sudo zypper install java-11-openjdk-headless
|
||||
```
|
||||
|
||||
|
||||
## Download and Install InfluxDB
|
||||
|
||||
```shell
|
||||
wget https://dl.influxdata.com/influxdb/releases/influxdb-1.8.10.x86_64.rpm
|
||||
sudo yum localinstall influxdb-1.8.10.x86_64.rpm
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable influxdb
|
||||
sudo systemctl start influxdb
|
||||
```
|
||||
|
||||
Run the ```influx``` cli command and create the *hmci* database.
|
||||
|
||||
|
||||
## Download and Install Grafana
|
||||
|
||||
```shell
|
||||
wget https://dl.grafana.com/oss/release/grafana-9.1.3-1.x86_64.rpm
|
||||
sudo rpm -i --nodeps grafana-9.1.3-1.x86_64.rpm
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable grafana-server
|
||||
sudo systemctl start grafana-server
|
||||
```
|
||||
|
||||
When logged in to Grafana (port 3000, admin/admin) create a datasource that points to the local InfluxDB. Now import the provided dashboards.
|
||||
|
||||
|
||||
## Download and Install HMCi
|
||||
|
||||
```shell
|
||||
wget https://bitbucket.org/mnellemann/hmci/downloads/hmci_1.3.1-1_all.deb
|
||||
sudo dpkg -i hmci_1.3.1-1_all.deb
|
||||
cp /opt/hmci/doc/hmci.toml /etc/
|
||||
cp /opt/hmci/doc/hmci.service /etc/systemd/system/
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable hmci
|
||||
```
|
||||
|
||||
Now modify */etc/hmci.toml* and test your setup by running ```/opt/hmci/bin/hmci -d``` manually and verify connection to HMC and InfluxDB. Afterwards start service with ```systemctl start hmci``` .
|
||||
Loading…
Reference in a new issue