Skip to content

Commit f3941a0

Browse files
committed
doc: updated info about bootstrap '-c' option
1 parent d638e2d commit f3941a0

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ Since Mamonsu **3.0** template contains screens:
8282
### Tools
8383
Mamonsu provides the command-line interface for updating some Zabbix server settings, as well as getting an overview of the monitored system configuration and tuning PostgreSQL and system settings on the fly. Also it provides tool to generate a detailed report on the hardware, operating system, memory usage and other parameters of the monitored system. List of Mamonsu commands and options:
8484

85-
mamonsu agent [agent_action]
86-
mamonsu bootstrap [-M mamonsu_user] [-x | --create-extensions] [connection_options]
85+
mamonsu agent [agent_action] [-c | --config]
86+
mamonsu bootstrap [-M mamonsu_user] [-x | --create-extensions] [-c | --config] [connection_options]
8787
mamonsu export {template | config} filename [export_options]
8888
mamonsu report [report_options] [connection_options]
8989
mamonsu tune [tuning_options] [connection_options]
@@ -196,7 +196,7 @@ If you omit this step, metrics can only be collected on behalf of a superuser, w
196196
```
197197
- Run the following command to bootstrap Mamonsu:
198198
```shell
199-
mamonsu bootstrap [-M mamonsu_user] [-x | --create-extensions] [connection_options]
199+
mamonsu bootstrap [-M mamonsu_user] [-x | --create-extensions] [-c | --config] [connection_options]
200200
```
201201
For details of usage, see “[Tools](documentation/tools.md#bootstrap)".
202202
As the result of this operation, monitoring functions are created in the mamonsu_database in *mamonsu* schema, and the right to execute them is granted to the mamonsu_user. Thus, a superuser connection is no longer required. Mamonsu also creates several tables in the specified database. Do not delete these tables as they are required for Mamonsu to work.

documentation/tools.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
List of Mamonsu commands and options:
44

5-
mamonsu agent [agent_action]
6-
mamonsu bootstrap [-M mamonsu_user] [-x | --create-extensions] [connection_options]
5+
mamonsu agent [agent_action] [-c | --config]
6+
mamonsu bootstrap [-M mamonsu_user] [-x | --create-extensions] [-c | --config] [connection_options]
77
mamonsu export {template | config} filename [export_options]
88
mamonsu report [report_options] [connection_options]
99
mamonsu tune [tuning_options] [connection_options]
@@ -42,7 +42,7 @@ List of Mamonsu commands and options:
4242
## agent
4343
Syntax:
4444
```shell
45-
mamonsu agent { metric-list | metric-get metric_name | version }
45+
mamonsu agent { metric-list | metric-get metric_name | version } [-c | --config]
4646
```
4747
Provides information on the collected metrics from the command line. You can specify one of the following parameters:
4848
@@ -53,20 +53,32 @@ Provides information on the collected metrics from the command line. You can spe
5353
        Check the latest value for the specified metric. You can get the list of available metrics using the metric-list option.
5454
5555
**version**
56-
        Display Mamonsu version.
56+
        Display Mamonsu version.
57+
58+
**-c/--config**
59+
        Specify mamonsu config file.
60+
        Default = '/etc/mamonsu/agent.conf'
61+
        *mamonsu agent* gets info about default host and port from config file.
5762
5863
5964
## bootstrap
6065
Syntax:
6166
```shell
62-
mamonsu bootstrap [-M mamonsu_user] [-x | --create-extensions] [connection_options]
67+
mamonsu bootstrap [-M mamonsu_user] [-x | --create-extensions] [-c | --config] [connection_options]
6368
```
64-
Bootstrap Mamonsu. This command can take the following options:
69+
Bootstrap Mamonsu. This command can take the following options:
70+
6571
**-M**
66-
        Mandatory.
67-
        Specify a non-privileged user that will own all Mamonsu processes.
72+
        Specify a non-privileged user that will own all Mamonsu processes.
73+
6874
**-x/--create-extensions**
69-
        Creates additional extensions (currently, pg_buffercache).
75+
        Creates additional extensions (currently, pg_buffercache).
76+
77+
**-c/--config**
78+
        Specify mamonsu config file.
79+
        Default = '/etc/mamonsu/agent.conf'
80+
        *mamonsu bootstrap* gets info about mamonsu default database from config file.
81+
7082
**connection_options**
7183
        Provide optional command-line connection parameters.
7284

0 commit comments

Comments
 (0)