README.md in cloudstack-nagios-0.18.0 vs README.md in cloudstack-nagios-0.18.1
- old
+ new
@@ -1,22 +1,22 @@
# Cloudstack Nagios
[![Gem Version](https://badge.fury.io/rb/cloudstack-nagios.svg)](http://badge.fury.io/rb/cloudstack-nagios)
-Cloudstack Nagios helps you monitoring your Cloudstack environment with Nagios.
-Cloudstack Nagios uses the Cloudstack API to collect information about system vm's and ressources.
+CloudStack Nagios helps you monitoring your Cloudstack environment with Nagios/Icinga.
+CloudStack Nagios uses the CloudStack API to collect information about system vm's and resources.
The following checks are supported:
* system and network checks for virtual routers
* storage pool capacity checks
* global zone capacities
## Prerequisites
- * Cloudstack Root Admin keys have to be used.
- * In order to connect to system VMs the private ssh key found on the Cloudstack management server under /var/lib/cloud/management/.ssh/id_rsa are required.
- * The system vms must be reachable on the Cloudstack Management Network over SSH (default port 3922) from the nagios server executing the checks (check with 'ssh -i /var/lib/cloud/management/.ssh/id_rsa -p 3922 <router_mgmt_ip>').
+ * CloudStack Root Admin keys have to be used.
+ * In order to connect to system vm's the private ssh key found on the CloudStack management server under /var/lib/cloud/management/.ssh/id_rsa are required.
+ * The system vm's must be reachable on the Cloudstack Management Network over SSH (default port 3922) from the Nagios server executing the checks (check with 'ssh -i /var/lib/cloud/management/.ssh/id_rsa -p 3922 <router_mgmt_ip>').
## Installation
Install the cloudstack-cli gem:
@@ -30,11 +30,11 @@
```sh
$ cs-nagios setup
```
-cloudstack-nagios expects to find a configuartion file with the API URL and your CloudStack credentials in your home directory named .cloudstack-cli.yml. If the file is located elsewhere you can specify the loaction using the --config option.
+cloudstack-nagios expects to find a configuration file with the API URL and your CloudStack credentials in your home directory named .cloudstack-cli.yml. If the file is located elsewhere you can specify the location using the --config option.
cloudstack-nagios supports multiple environments using the --environment option.
Example content of the configuration file:
@@ -64,12 +64,12 @@
Generate all configuration files:
```sh
$ cs-nagios nagios_config generate all
```
-You can also generate each config file individualy.
-The following types are awailable:
+You can also generate each config file individually.
+The following types are available:
```sh
$ cs-nagios nagios_config list
all
hostgroups
@@ -83,17 +83,17 @@
storage_pools
```
### System VM checks
-For all vm checks access to the cloudstack management network is required in order to run the ckecks via ssh or snmp.
+For all vm checks access to the CloudStack management network is required in order to run the checks via SSH or SNMP.
#### Types
cloudstack-nagios differentiates between 2 different types of system vm's:
* routers: `cs-nagios check router`
- * secondary storage vms and console proxies: `cs-nagios check system_vm`
+ * secondary storage vm's and console proxies: `cs-nagios check system_vm`
#### Checks
The following checks are available:
@@ -101,11 +101,11 @@
* memory - measure memory usage in percents
* cpu - measure cpu usage in percent
* network - measure network usage
* fs_rw - check if the root file system is writeable
* rootfs_rw - check if the root file system is writeable (wrapper for fs_rw with mount point /)
- * disk_usage - check the diks space usage of the root volume
+ * disk_usage - check the disks space usage of the root volume
Checks for routers
* conntrack_connections, check the number of conntrack connections and set proper limits if needed
* active_ftp - make sure conntrack_ftp and nf_nat_ftp modules are loaded and enable it if needed
@@ -116,16 +116,16 @@
$ cs-nagios check router active_ftp --host 10.100.9.177
```
#### Enabling snmpd checks for system vms
-If you want to check your system vms with standard Nagios snmp checks instead of checking over SSH, there are commands to configure snmpd on the machines and open the firewall.
+If you want to check your system vm's with standard Nagios SNMP checks instead of checking over SSH, there are commands to configure snmpd on the machines and open the firewall.
* snmpd_config enable - goes to all the routers and configure snmpd
* snmpd_config check - test if port TCP 161 is reachable on routers
-Note: If you want to use snmp checks, you have to adapt the nagios configuration files accordingly.
+Note: If you want to use snmp checks, you have to adapt the Nagios configuration files accordingly.
### Capacity checks
Checks various global capacity values.
@@ -135,10 +135,10 @@
$ cs-nagios check capacity memory --zone ZUERICH_IX
```
### Storage pool checks
-Checks the available disk space on Cloudstack storage pools.
+Checks the available disk space on CloudStack storage pools.
Example:
```sh
$ cs-nagios check storage_pool --pool_name fs_cs_zone01_pod01