Add CLI.md

doc/CLI.md

@@ -0,0 +1,238 @@
+# pgagroal-cli user guide
+
+```
+pgagroal-cli [ -c CONFIG_FILE ] [ COMMAND ]
+
+-c, --config CONFIG_FILE Set the path to the pgagroal.conf file
+-h, --host HOST          Set the host name
+-p, --port PORT          Set the port number
+-U, --user USERNAME      Set the user name
+-P, --password PASSWORD  Set the password
+-L, --logfile FILE       Set the log file
+-v, --verbose            Output text string of result
+-V, --version            Display version information
+-?, --help               Display help
+```
+## flush-idle
+Flush idle connections
+
+Command
+
+```
+pgagroal-cli flush-idle
+```
+
+Example
+
+```
+pgagroal-cli flush-idle
+```
+
+## flush-gracefully
+Flush all connections gracefully
+
+Command
+
+```
+pgagroal-cli flush-gracefully
+```
+
+Example
+
+```
+pgagroal-cli flush-gracefully
+```
+
+## flush-all
+Flush all connections. USE WITH CAUTION !
+
+Command
+
+```
+pgagroal-cli flush-all
+```
+
+Example
+
+```
+pgagroal-cli flush-all
+```
+
+## is-alive
+Is pgagroal alive
+
+Command
+
+```
+pgagroal-cli is-alive
+```
+
+Example
+
+```
+pgagroal-cli is-alive
+```
+
+## enable
+Enable a database
+
+Command
+
+```
+pgagroal-cli enable [<database>|*]
+```
+
+Example
+
+```
+pgagroal-cli enable
+```
+
+## disable
+Disable a database
+
+Command
+
+```
+pgagroal-cli disable [<database>|*]
+```
+
+Example
+
+```
+pgagroal-cli disable
+```
+
+## gracefully
+Stop pgagroal gracefully
+
+Command
+
+```
+pgagroal-cli gracefully
+```
+
+Example
+
+```
+pgagroal-cli gracefully
+```
+
+## stop
+Stop pgagroal
+
+Command
+
+```
+pgagroal-cli stop
+```
+
+Example
+
+```
+pgagroal-cli stop
+```
+
+## cancel-shutdown
+Cancel the graceful shutdown
+
+Command
+
+```
+pgagroal-cli cancel-shutdown
+```
+
+Example
+
+```
+pgagroal-cli cancel-shutdown
+```
+
+## status
+Status of pgagroal
+
+Command
+
+```
+pgagroal-cli status
+```
+
+Example
+
+```
+pgagroal-cli status
+```
+
+## details
+Detailed status of pgagroal
+
+Command
+
+```
+pgagroal-cli details
+```
+
+Example
+
+```
+pgagroal-cli details
+```
+
+## switch-to
+Switch to another primary
+
+Command
+
+```
+pgagroal-cli switch-to <server>
+```
+
+Example
+
+```
+pgagroal-cli switch-to replica
+```
+
+## reload
+Reload the configuration
+
+Command
+
+```
+pgagroal-cli reload
+```
+
+Example
+
+```
+pgagroal-cli reload
+```
+
+## reset
+Reset the Prometheus statistics
+Command
+
+```
+pgagroal-cli reset
+```
+
+Example
+
+```
+pgagroal-cli reset
+```
+
+## reset-server
+Reset the state of a server
+
+Command
+
+```
+pgagroal-cli reset-server <server>
+```
+
+Example
+
+```
+pgagroal-cli reset-server primary
+```

pgagroal.spec

@@ -41,6 +41,7 @@ cmake -DCMAKE_BUILD_TYPE=Release ..
 %{__install} -m 644 %{_builddir}/%{name}-%{version}/contrib/grafana/dashboard.json %{buildroot}%{_docdir}/%{name}/grafana/dashboard.json
 %{__install} -m 644 %{_builddir}/%{name}-%{version}/contrib/grafana/README.md %{buildroot}%{_docdir}/%{name}/grafana/README.md
 %{__install} -m 644 %{_builddir}/%{name}-%{version}/doc/ARCHITECTURE.md %{buildroot}%{_docdir}/%{name}/ARCHITECTURE.md
+%{__install} -m 644 %{_builddir}/%{name}-%{version}/doc/CLI.md %{buildroot}%{_docdir}/%{name}/CLI.md
 %{__install} -m 644 %{_builddir}/%{name}-%{version}/doc/CONFIGURATION.md %{buildroot}%{_docdir}/%{name}/CONFIGURATION.md
 %{__install} -m 644 %{_builddir}/%{name}-%{version}/doc/FAILOVER.md %{buildroot}%{_docdir}/%{name}/FAILOVER.md
 %{__install} -m 644 %{_builddir}/%{name}-%{version}/doc/GETTING_STARTED.md %{buildroot}%{_docdir}/%{name}/GETTING_STARTED.md
@@ -82,6 +83,7 @@ cd %{buildroot}%{_libdir}/
 %files
 %license %{_docdir}/%{name}/LICENSE
 %{_docdir}/%{name}/ARCHITECTURE.md
+%{_docdir}/%{name}/CLI.md
 %{_docdir}/%{name}/CODE_OF_CONDUCT.md
 %{_docdir}/%{name}/CONFIGURATION.md
 %{_docdir}/%{name}/FAILOVER.md