2021-08-12 12:47:48 +02:00
|
|
|
#!/bin/bash
|
|
|
|
|
|
2021-08-26 15:31:47 +02:00
|
|
|
if ! command -v check_patroni &>/dev/null; then
|
|
|
|
|
echo "check_partroni must be installed to generate the documentation"
|
|
|
|
|
exit 1
|
|
|
|
|
fi
|
|
|
|
|
|
2021-08-12 12:47:48 +02:00
|
|
|
README="../README.md"
|
|
|
|
|
function readme(){
|
|
|
|
|
echo "$1" >> $README
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function helpme(){
|
|
|
|
|
readme
|
2021-08-13 11:13:33 +02:00
|
|
|
readme '```'
|
2021-08-12 12:47:48 +02:00
|
|
|
check_patroni $1 --help >> $README
|
2021-08-13 11:13:33 +02:00
|
|
|
readme '```'
|
2021-08-12 12:47:48 +02:00
|
|
|
readme
|
|
|
|
|
}
|
|
|
|
|
|
2021-08-13 11:13:33 +02:00
|
|
|
cat << '_EOF_' > $README
|
2021-08-12 12:47:48 +02:00
|
|
|
# check_patroni
|
|
|
|
|
_EOF_
|
|
|
|
|
helpme
|
2021-08-13 11:13:33 +02:00
|
|
|
cat << '_EOF_' >> $README
|
2021-08-13 12:12:08 +02:00
|
|
|
## install
|
|
|
|
|
|
2021-08-13 14:43:07 +02:00
|
|
|
The check requers python3. Using a virtual env is advised for testing :
|
2021-08-13 12:12:08 +02:00
|
|
|
|
|
|
|
|
```
|
2021-08-13 14:43:07 +02:00
|
|
|
pip -m venv ~/venv
|
|
|
|
|
source ~venv/bin/activate
|
2021-08-13 12:12:08 +02:00
|
|
|
```
|
|
|
|
|
|
2021-08-13 14:43:07 +02:00
|
|
|
Clone the repo, then install with pip3 from it :
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
pip3 install .
|
|
|
|
|
pip3 install .[dev]
|
|
|
|
|
pip3 install .[test]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Links :
|
|
|
|
|
* [pip & centos 7](https://linuxize.com/post/how-to-install-pip-on-centos-7/)
|
|
|
|
|
* [pip & debian10](https://linuxize.com/post/how-to-install-pip-on-debian-10/)
|
|
|
|
|
|
2021-08-13 11:13:33 +02:00
|
|
|
## config file
|
|
|
|
|
|
|
|
|
|
All global and service specific parameters can be specified via a config file has follows:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
[options]
|
|
|
|
|
endpoints = https://10.20.199.3:8008, https://10.20.199.4:8008,https://10.20.199.5:8008
|
|
|
|
|
cert_file = ./ssl/benoit-dalibo-cert.pem
|
|
|
|
|
key_file = ./ssl/benoit-dalibo-key.pem
|
|
|
|
|
ca_file = ./ssl/CA-cert.pem
|
|
|
|
|
timeout = 0
|
|
|
|
|
|
|
|
|
|
[options.node_is_replica]
|
|
|
|
|
lag=100
|
|
|
|
|
```
|
2021-08-26 15:31:47 +02:00
|
|
|
## thresholds
|
|
|
|
|
|
|
|
|
|
The format for the threshold parameters is "[@][start:][end]".
|
|
|
|
|
|
|
|
|
|
* "start:" may be omitted if start==0
|
|
|
|
|
* "~:" means that start is negative infinity
|
|
|
|
|
* If `end` is omitted, infinity is assumed
|
|
|
|
|
* To invert the match condition, prefix the range expression with "@".
|
|
|
|
|
|
|
|
|
|
A match is found when : start <= VALUE <= end
|
|
|
|
|
|
|
|
|
|
For example, the followinf command will raise :
|
|
|
|
|
|
|
|
|
|
* a warning if there is less than 1 nodes
|
|
|
|
|
* a critical if there are no nodes
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
check_patroni -e https://10.20.199.3:8008 cluster_has_replica --warning @1 --critical @0
|
|
|
|
|
```
|
2021-08-13 11:13:33 +02:00
|
|
|
_EOF_
|
|
|
|
|
readme
|
2021-08-12 12:47:48 +02:00
|
|
|
readme "## cluster services"
|
|
|
|
|
readme "### cluster_config_has_changed"
|
|
|
|
|
helpme cluster_config_has_changed
|
|
|
|
|
readme "### cluster_has_leader"
|
|
|
|
|
helpme cluster_has_leader
|
|
|
|
|
readme "### cluster_has_replica"
|
|
|
|
|
helpme cluster_has_replica
|
|
|
|
|
readme "### cluster_is_in_maintenance"
|
|
|
|
|
helpme cluster_is_in_maintenance
|
|
|
|
|
readme "### cluster_node_count"
|
|
|
|
|
helpme cluster_node_count
|
|
|
|
|
readme "## node services"
|
|
|
|
|
readme "### node_is_alive"
|
|
|
|
|
helpme node_is_alive
|
|
|
|
|
readme "### node_is_pending_restart"
|
|
|
|
|
helpme node_is_pending_restart
|
|
|
|
|
readme "### node_is_primary"
|
|
|
|
|
helpme node_is_primary
|
|
|
|
|
readme "### node_is_replica"
|
|
|
|
|
helpme node_is_replica
|
|
|
|
|
readme "### node_patroni_version"
|
|
|
|
|
helpme node_patroni_version
|
|
|
|
|
readme "### node_tl_has_changed"
|
|
|
|
|
helpme node_tl_has_changed
|
|
|
|
|
cat << _EOF_ >> $README
|
|
|
|
|
|
|
|
|
|
_EOF_
|
