ungleich-public/cdist
ungleich-public
/
cdist
7
3
Fork 10
Code Issues 57 Pull Requests 12 Projects Releases Wiki Activity

[type/__postgres_conf] Update man.rst

This commit is contained in:
Dennis Camera 2021-04-15 15:55:52 +02:00
parent 686e4f0f2d
commit 19bf37be1a
1 changed files with 22 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
cdist/conf/type/__postgres_conf/man.rst
View File

@ -1,29 +1,27 @@
cdist-type__postgres_conf(7) cdist-type__postgres_conf(7)
============================ ============================
Configure a PostgreSQL server. NAME
----
NOTE: This type might need to be run multiple times to apply all bits of the cdist-type__postgres_conf - Alter PostgreSQL configuration
configuration due to ordering requirements.
SSRQ <cdist--@--ssrq-sds-fds.ch>
DESCRIPTION DESCRIPTION
----------- -----------
Configure a PostgreSQL server using ALTER SYSTEM. Configure a running PostgreSQL server using ``ALTER SYSTEM``.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
value value
The value to setup (can be omitted when state is set to "absent"). The value to set (can be omitted if ``--state`` is set to ``absent``).
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
state state
"present" or "absent". Defaults to "present". ``present`` or ``absent``.
Defaults to ``present``.
BOOLEAN PARAMETERS BOOLEAN PARAMETERS
@ -36,20 +34,27 @@ EXAMPLES
.. code-block:: sh .. code-block:: sh
# set timezone # set timezone
__postgres_conf timezone --value Europe/Zurich __postgres_conf timezone --value Europe/Zurich
# reset maximum number of concurrent connections to default (normally 100) # reset maximum number of concurrent connections to default (normally 100)
__postgres_conf max_connections --state absent __postgres_conf max_connections --state absent
SEE ALSO SEE ALSO
-------- --------
- `cdist-type(7) <cdist-type.html>`_ None.
AUTHORS
-------
Beni Ruef (bernhard.ruef--@--ssrq-sds-fds.ch)
Dennis Camera (dennis.camera--@--ssrq-sds-fds.ch)
COPYING COPYING
------- -------
Copyright \(C) 2020 SSRQ (www.ssrq-sds-fds.ch). Copyright \(C) 2019-2021 SSRQ (www.ssrq-sds-fds.ch).
Free use of this software is granted under the terms You can redistribute it and/or modify it under the terms of the GNU General
of the GNU General Public License version 3 (GPLv3). Public License as published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.