postgresql modules: remove extra lines from doc that are presented in ext doc fragment (#58501)

pull/58505/head
Andrey Klychkov 5 years ago committed by Alicia Cozine
parent 0a27ad6ea0
commit 5937080977

@ -46,19 +46,6 @@ options:
- Permissions checking for SQL commands is carried out as though - Permissions checking for SQL commands is carried out as though
the session_role were the one that had logged in originally. the session_role were the one that had logged in originally.
type: str type: str
notes:
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- login_user or session_role must be able to read from pg_authid.
- To avoid "Peer authentication failed for user postgres" error,
use postgres user as a I(become_user).
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module. If
the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host. For Ubuntu-based
systems, install the postgresql, libpq-dev, and python-psycopg2 packages
on the remote host before using this module.
requirements: [ psycopg2 ]
author: author:
- Andrew Klychkov (@Andersson007) - Andrew Klychkov (@Andersson007)
extends_documentation_fragment: postgres extends_documentation_fragment: postgres

@ -107,17 +107,6 @@ options:
type: str type: str
aliases: [ ssl_rootcert ] aliases: [ ssl_rootcert ]
version_added: '2.8' version_added: '2.8'
notes:
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module.
- If the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host.
- For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages
on the remote host before using this module.
requirements: [ psycopg2 ]
author: author:
- Jens Depuydt (@jensdepuydt) - Jens Depuydt (@jensdepuydt)
- Thomas O'Donnell (@andytom) - Thomas O'Donnell (@andytom)

@ -74,18 +74,6 @@ options:
- Permissions checking for SQL commands is carried out as though - Permissions checking for SQL commands is carried out as though
the session_role were the one that had logged in originally. the session_role were the one that had logged in originally.
type: str type: str
notes:
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- To avoid "Peer authentication failed for user postgres" error,
use postgres user as a I(become_user).
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module.
- If the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host.
- For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages
on the remote host before using this module.
requirements: [ psycopg2 ]
author: author:
- Andrew Klychkov (@Andersson007) - Andrew Klychkov (@Andersson007)
extends_documentation_fragment: postgres extends_documentation_fragment: postgres

@ -74,21 +74,6 @@ options:
- Permissions checking for SQL commands is carried out as though - Permissions checking for SQL commands is carried out as though
the session_role were the one that had logged in originally. the session_role were the one that had logged in originally.
type: str type: str
notes:
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- To avoid "Peer authentication failed for user postgres" error,
use postgres user as a I(become_user).
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module.
- If the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host.
- For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages
on the remote host before using this module.
requirements:
- psycopg2
author: author:
- Andrew Klychkov (@Andersson007) - Andrew Klychkov (@Andersson007)
extends_documentation_fragment: postgres extends_documentation_fragment: postgres

@ -23,20 +23,10 @@ version_added: '2.8'
options: options:
db: db:
description: description:
- Name of database to connect. - Name of a database to connect to.
type: str type: str
aliases: aliases:
- login_db - login_db
notes:
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module. If
the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host. For Ubuntu-based
systems, install the postgresql, libpq-dev, and python-psycopg2 packages
on the remote host before using this module.
requirements: [ psycopg2 ]
author: author:
- Andrew Klychkov (@Andersson007) - Andrew Klychkov (@Andersson007)
extends_documentation_fragment: postgres extends_documentation_fragment: postgres

@ -161,12 +161,6 @@ options:
- ssl_rootcert - ssl_rootcert
notes: notes:
- Default authentication assumes that postgresql_privs is run by the
C(postgres) user on the remote host. (Ansible's C(user) or C(sudo-user)).
- This module requires Python package I(psycopg2) to be installed on the
remote host. In the default case of the remote host also being the
PostgreSQL server, PostgreSQL has to be installed there as well, obviously.
For Debian/Ubuntu-based systems, install packages I(postgresql) and I(python-psycopg2).
- Parameters that accept comma separated lists (I(privs), I(objs), I(roles)) - Parameters that accept comma separated lists (I(privs), I(objs), I(roles))
have singular alias names (I(priv), I(obj), I(role)). have singular alias names (I(priv), I(obj), I(role)).
- To revoke only C(GRANT OPTION) for a specific object, set I(state) to - To revoke only C(GRANT OPTION) for a specific object, set I(state) to
@ -177,10 +171,6 @@ notes:
specified via I(login). If R has been granted the same privileges by specified via I(login). If R has been granted the same privileges by
another user also, R can still access database objects via these privileges. another user also, R can still access database objects via these privileges.
- When revoking privileges, C(RESTRICT) is assumed (see PostgreSQL docs). - When revoking privileges, C(RESTRICT) is assumed (see PostgreSQL docs).
- The ca_cert parameter requires at least Postgres version 8.4 and I(psycopg2) version 2.4.3.
requirements:
- psycopg2
extends_documentation_fragment: extends_documentation_fragment:
- postgres - postgres

@ -56,18 +56,6 @@ options:
type: str type: str
aliases: aliases:
- login_db - login_db
notes:
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- To avoid "Peer authentication failed for user postgres" error,
use postgres user as a I(become_user).
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module. If
the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host. For Ubuntu-based
systems, install the postgresql, libpq-dev, and python-psycopg2 packages
on the remote host before using this module.
requirements: [ psycopg2 ]
author: author:
- Felix Archambault (@archf) - Felix Archambault (@archf)
- Andrew Klychkov (@Andersson007) - Andrew Klychkov (@Andersson007)

@ -74,14 +74,6 @@ options:
type: str type: str
aliases: [ ssl_rootcert ] aliases: [ ssl_rootcert ]
version_added: '2.8' version_added: '2.8'
notes:
- This module uses I(psycopg2), a Python PostgreSQL database adapter.
- You must ensure that psycopg2 is installed on the host before using this module.
- If the remote host is the PostgreSQL server (which is the default case),
then PostgreSQL must also be installed on the remote host.
- For Ubuntu-based systems, install the C(postgresql), C(libpq-dev),
and C(python-psycopg2) packages on the remote host before using this module.
requirements: [ psycopg2 ]
author: author:
- Flavien Chantelot (@Dorn-) <contact@flavien.io> - Flavien Chantelot (@Dorn-) <contact@flavien.io>
- Thomas O'Donnell (@andytom) - Thomas O'Donnell (@andytom)

@ -72,15 +72,6 @@ notes:
not restarted and the value in pg_settings is not updated yet. not restarted and the value in pg_settings is not updated yet.
- For some parameters restart of PostgreSQL server is required. - For some parameters restart of PostgreSQL server is required.
See official documentation U(https://www.postgresql.org/docs/current/view-pg-settings.html). See official documentation U(https://www.postgresql.org/docs/current/view-pg-settings.html).
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module. If
the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host. For Ubuntu-based
systems, install the postgresql, libpq-dev, and python-psycopg2 packages
on the remote host before using this module.
requirements: [ psycopg2 ]
author: author:
- Andrew Klychkov (@Andersson007) - Andrew Klychkov (@Andersson007)
extends_documentation_fragment: postgres extends_documentation_fragment: postgres

@ -78,22 +78,10 @@ options:
notes: notes:
- Physical replication slots were introduced to PostgreSQL with version 9.4, - Physical replication slots were introduced to PostgreSQL with version 9.4,
while logical replication slots were added beginning with version 10.0. while logical replication slots were added beginning with version 10.0.
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- To avoid "Peer authentication failed for user postgres" error,
use postgres user as a I(become_user).
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module.
- If the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host.
- For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages
requirements:
- psycopg2
author: author:
- John Scalia (@jscalia) - John Scalia (@jscalia)
- Andew Klychkov (@Andersson007) - Andrew Klychkov (@Andersson007)
extends_documentation_fragment: postgres extends_documentation_fragment: postgres
''' '''

@ -105,19 +105,8 @@ notes:
- If you do not pass db parameter, tables will be created in the database - If you do not pass db parameter, tables will be created in the database
named postgres. named postgres.
- PostgreSQL allows to create columnless table, so columns param is optional. - PostgreSQL allows to create columnless table, so columns param is optional.
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- To avoid "Peer authentication failed for user postgres" error,
use postgres user as a I(become_user).
- Unlogged tables are available from PostgreSQL server version 9.1 - Unlogged tables are available from PostgreSQL server version 9.1
U(https://www.postgresql.org/docs/9.1/sql-createtable.html). U(https://www.postgresql.org/docs/9.1/sql-createtable.html).
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module.
- If the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host. For Ubuntu-based
systems, install the postgresql, libpq-dev, and python-psycopg2 packages
on the remote host before using this module.
requirements: [ psycopg2 ]
author: author:
- Andrew Klychkov (@Andersson007) - Andrew Klychkov (@Andersson007)
extends_documentation_fragment: postgres extends_documentation_fragment: postgres

@ -150,21 +150,8 @@ options:
notes: notes:
- The module creates a user (role) with login privilege by default. - The module creates a user (role) with login privilege by default.
Use NOLOGIN role_attr_flags to change this behaviour. Use NOLOGIN role_attr_flags to change this behaviour.
- The default authentication assumes that you are either logging in as or
sudo'ing to the postgres account on the host.
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
ensure that psycopg2 is installed on the host before using this module. If
the remote host is the PostgreSQL server (which is the default case), then
PostgreSQL must also be installed on the remote host. For Ubuntu-based
systems, install the postgresql, libpq-dev, and python-psycopg2 packages
on the remote host before using this module.
- If you specify PUBLIC as the user (role), then the privilege changes will apply to all users (roles). - If you specify PUBLIC as the user (role), then the privilege changes will apply to all users (roles).
You may not specify password or role_attr_flags when the PUBLIC user is specified. You may not specify password or role_attr_flags when the PUBLIC user is specified.
- The ca_cert parameter requires at least Postgres version 8.4 and I(psycopg2) version 2.4.3.
requirements:
- psycopg2
author: author:
- Ansible Core Team - Ansible Core Team
extends_documentation_fragment: postgres extends_documentation_fragment: postgres

Loading…
Cancel
Save