fixed doc build errors (#56735) (#57080)

(cherry picked from commit ac22cd31b6)
This commit is contained in:
Sandra McCann 2019-05-28 15:32:47 -04:00 committed by Alicia Cozine
parent 5a1985cb06
commit 4b1c9c1b29
3 changed files with 6 additions and 6 deletions

View file

@ -41,8 +41,8 @@ deprecated:
removed_in: "2.12" removed_in: "2.12"
why: Updated modules released with increased functionality why: Updated modules released with increased functionality
alternative: > alternative: >
Use M(gcp_compute_healthcheck), M(gcp_compute_http_healthcheck) or Use M(gcp_compute_health_check), M(gcp_compute_http_health_check) or
M(gcp_compute_https_healthcheck) instead. M(gcp_compute_https_health_check) instead.
author: author:
- "Tom Melendez (@supertom) <tom@supertom.com>" - "Tom Melendez (@supertom) <tom@supertom.com>"
options: options:

View file

@ -18,7 +18,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: postgresql_pg_hba module: postgresql_pg_hba
short_description: Add, remove or modifie a rule in a pg_hba file short_description: Add, remove or modify a rule in a pg_hba file
description: description:
- The fundamental function of the module is to create, or delete lines in pg_hba files. - The fundamental function of the module is to create, or delete lines in pg_hba files.
- The lines in the file should be in a typical pg_hba form and lines should be unique per key (type, databases, users, source). - The lines in the file should be in a typical pg_hba form and lines should be unique per key (type, databases, users, source).
@ -100,12 +100,12 @@ notes:
- The default authentication assumes that on the host, you are either logging in as or - The default authentication assumes that on the host, you are either logging in as or
sudo'ing to an account with appropriate permissions to read and modify the file. sudo'ing to an account with appropriate permissions to read and modify the file.
- This module also returns the pg_hba info. You can use this module to only retrieve it by only specifying I(dest). - This module also returns the pg_hba info. You can use this module to only retrieve it by only specifying I(dest).
The info kan be found in the returned data under key pg_hba, being a list, containing a dict per rule. The info can be found in the returned data under key pg_hba, being a list, containing a dict per rule.
- This module will sort resulting C(pg_hba) files if a rule change is required. - This module will sort resulting C(pg_hba) files if a rule change is required.
This could give unexpected results with manual created hba files, if it was improperly sorted. This could give unexpected results with manual created hba files, if it was improperly sorted.
For example a rule was created for a net first and for a ip in that net range next. For example a rule was created for a net first and for a ip in that net range next.
In that situation, the 'ip specific rule' will never hit, it is in the C(pg_hba) file obsolete. In that situation, the 'ip specific rule' will never hit, it is in the C(pg_hba) file obsolete.
After the C(pg_hba) file is rewritten by the M(pg_hba) module, the ip specific rule will be sorted above the range rule. After the C(pg_hba) file is rewritten by the M(postgresql_pg_hba) module, the ip specific rule will be sorted above the range rule.
And then it will hit, which will give unexpected results. And then it will hit, which will give unexpected results.
- With the 'order' parameter you can control which field is used to sort first, next and last. - With the 'order' parameter you can control which field is used to sort first, next and last.
- The module supports a check mode and a diff mode. - The module supports a check mode and a diff mode.

View file

@ -59,7 +59,7 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- aci - aci
notes: notes:
- A scheduler is required for this module, which could have been created using the M(aci_scheduler) module or via the UI. - A scheduler is required for this module, which could have been created using the M(aci_fabric_scheduler) module or via the UI.
author: author:
- Steven Gerhart (@sgerhart) - Steven Gerhart (@sgerhart)
''' '''