Skip to content

Commit 8a0ed14

Browse files
committed
docs: update instructions for installation from packages and fix typos in text
1 parent 79b1b69 commit 8a0ed14

File tree

1 file changed

+50
-25
lines changed

1 file changed

+50
-25
lines changed

README.rst

Lines changed: 50 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,50 @@ Build status
1212
License
1313
========
1414

15-
Development version, available on github, released under BSD 3-clause.
15+
Development version, available on GitHub, released under BSD 3-clause.
1616

1717
============
1818
Installation
1919
============
2020

21-
DEB packages for Debian|Ubuntu:
21+
For Debian, Ubuntu, Astra:
2222

2323
.. code-block:: bash
2424
25-
echo "deb [arch=amd64] https://repo.postgrespro.ru/mamonsu/latest/deb/ $(lsb_release -cs) main-$(lsb_release -cs)" > /etc/apt/sources.list.d/mamonsu.list
26-
wget -O - https://repo.postgrespro.ru/mamonsu/keys/GPG-KEY-MAMONSU | sudo apt-key add - && sudo apt-get update
27-
sudo apt-get install mamonsu
25+
$ wget https://repo.postgrespro.ru/mamonsu/keys/apt-repo-add.sh
26+
$ sudo chmod 700 ./apt-repo-add.sh
27+
$ sudo ./apt-repo-add.sh
28+
$ apt-get install mamonsu
2829
2930
30-
RPM packages for Centos:
31+
For RPM-based distros such as Centos, RHEL, Oraclelinux, SLES, AltLinux, AltLinux-spt
32+
33+
Install rpm from https://repo.postgrespro.ru/mamonsu/keys adding name of specific distro such as:
34+
35+
.. code-block:: bash
36+
37+
$ rpm -i https://repo.postgrespro.ru/mamonsu/keys/centos.rpm
38+
39+
Install package
40+
41+
For RH-like:
3142

3243
.. code-block:: bash
3344
34-
rpm -ivh https://repo.postgrespro.ru/mamonsu/keys/mamonsu-repo-centos.noarch.rpm
35-
yum install mamonsu
45+
$ yum install mamonsu
46+
47+
For SLES:
48+
49+
.. code-block:: bash
50+
51+
$ zypper install mamonsu
52+
53+
For AltLinux, AltlLinux-spt:
54+
55+
.. code-block:: bash
56+
57+
$ apt-get update
58+
$ apt-get install mamonsu
3659
3760
Pre-Build packages for Windows: `Windows installers <https://oc.postgrespro.ru/index.php/s/qu7YsFvOE55LdXo>`_
3861

@@ -70,6 +93,8 @@ Build repository, `./packaging/repo/gnupg` and `./packaging/repo/rpmmacros` must
7093
7194
Build win32 exe: (worked with python v3.{4,5}: py2exe v0.9.2.2 and pywin32 v220 or python v2.7: py2exe v0.6.9 and pywin32 v220):
7295

96+
NOTE: only mamonsu 2.3.4 builds for Windows.
97+
7398
.. code-block:: bash
7499
75100
$ git clone ... && cd mamonsu && python setup_win32.py py2exe
@@ -89,23 +114,23 @@ Build nsis installer:
89114
Configure
90115
==========
91116

92-
Export template for zabbix:
117+
Export template for Zabbix:
93118

94119
.. code-block:: bash
95120
96121
$ mamonsu export template template.xml --add-plugins /etc/mamonsu/plugins
97122
or
98123
$ cp /usr/share/mamonsu/template.xml .
99124
100-
or get example of config with all available parameters at https://postgrespro.ru/products/extensions/mamonsu
125+
or get an example of config with all available parameters at https://postgrespro.ru/products/extensions/mamonsu
101126

102127
Import this file in web interface of zabbix: Configuration => Templates => Import, or deploy with mamonsu:
103128

104129
.. code-block:: bash
105130
106131
$ mamonsu zabbix template export /usr/share/mamonsu/template.xml --url=http://zabbix/ --user=Admin --password=zabbix
107132
108-
Add this template like `PostgresPro-Linux2` at your monitoring host, or create host with mamonsu:
133+
Add this template like `PostgresPro-Linux2` at your monitoring host, or create a host with mamonsu:
109134

110135
.. code-block:: bash
111136
@@ -117,9 +142,9 @@ Generate config on monitoring host or use preinstalled:
117142
118143
$ mamonsu export config /etc/mamonsu/agent.conf --add-plugins /etc/mamonsu/plugins
119144
120-
or get example of config with all available parameters at https://postgrespro.ru/products/extensions/mamonsu
145+
or get an example of config with all available parameters at https://postgrespro.ru/products/extensions/mamonsu
121146

122-
Change previously zabbix server address and client hostname:
147+
Change previously Zabbix server address and client hostname:
123148

124149
.. code-block:: bash
125150
@@ -152,20 +177,20 @@ Change previously zabbix server address and client hostname:
152177
level = INFO
153178
154179
These are the main mamonsu settings to get started. You can also fine-tune other mamonsu settings.
155-
At https://postgrespro.ru/products/extensions/mamonsu you can find example of configuration file for mamonsu
180+
At https://postgrespro.ru/products/extensions/mamonsu you can find an example of the configuration file for mamonsu
156181
with all available parameters.
157182

158-
Bootstrap DDL for monitoring (if you want to monitoring without superuser rights)
183+
Bootstrap DDL for monitoring (if you want to monitor without superuser rights)
159184

160-
Create non-privileged user (for example 'mamonsu')
185+
Create a non-privileged user (for example 'mamonsu')
161186

162187
.. code-block:: bash
163188
164189
$ createdb mamonsu
165190
166191
$ createuser mamonsu
167192
168-
Implement bootstrap from non-privileged user
193+
Implement bootstrap from a non-privileged user
169194

170195
.. code-block:: bash
171196
@@ -182,36 +207,36 @@ Export template for zabbix-agent
182207
183208
$ mamonsu export zabbix-template template_agent.xml
184209
185-
or get example of template at https://postgrespro.ru/products/extensions/mamonsu
210+
or get an example of the template at https://postgrespro.ru/products/extensions/mamonsu
186211

187212
Export or download zabbix-agent configuration file for needed PostgreSQL version
188213

189214
.. code-block:: bash
190215
191216
$ mamonsu export zabbix-parameters userparameters_pgsql_v*.conf --pg-version=version_number (by default pg-version=10)
192217
193-
or get example of configuration file at https://postgrespro.ru/products/extensions/mamonsu
218+
or get an example of configuration file at https://postgrespro.ru/products/extensions/mamonsu
194219

195220
NOTE: zabbix-agent configuration file for PostgreSQL 10 and 11 are equal
196221

197-
Bash scripts for OS parameters monitoring are exported with configuration file in directory /scripts
222+
Bash scripts for OS parameters monitoring are exported with the configuration file in directory /scripts
198223
Or you can download them at https://postgrespro.ru/products/extensions/mamonsu
199224

200225
Add configuration file to zabbix-agent directory as /etc/zabbix/zabbix_agentd.d/userparameters_pgsql.conf
201226

202-
NOTE: Make sure path for bash scripts in zabbix-agent configuration file is valid
227+
NOTE: Make sure that the path for bash scripts in the zabbix-agent configuration file is valid
203228

204229
Edit connections options of zabbix-agent /etc/zabbix/zabbix_agentd.conf, following standard instructions for zabbix-agent installation (https://www.zabbix.com/documentation/3.4/manual/concepts/agent)
205230

206231
==================
207232
Write your plugin
208233
==================
209234

210-
All plugins must exist in plugin directory which is defined in your configuration file.
235+
All plugins must exist in the plugin directory which is defined in your configuration file.
211236

212-
See the `examples <https://github.com/postgrespro/mamonsu/tree/master/examples>`_ for aditional information.
237+
See the `examples <https://github.com/postgrespro/mamonsu/tree/master/examples>`_ for additional information.
213238

214-
After add new plugin, you must to reexport template and import this file to zabbix.
239+
After adding a new plugin, you must re-export the template and import a new template to Zabbix.
215240

216241
=========
217242
3rd-party
@@ -405,7 +430,7 @@ Screenshots
405430
Tool: Report
406431
============
407432
408-
Create report about used hardware and PostgreSQL:
433+
Create a report about used hardware and PostgreSQL:
409434
410435
.. code-block:: bash
411436

0 commit comments

Comments
 (0)