Make all doc_fragments private. (#898)

This commit is contained in:
Felix Fontein
2025-05-18 01:42:18 +02:00
committed by GitHub
parent 7294841a28
commit b08afe4237
54 changed files with 186 additions and 155 deletions

View File

@@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations

View File

@@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations

View File

@@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations

View File

@@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations

View File

@@ -3,6 +3,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations

View File

@@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations

View File

@@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations

View File

@@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations

View File

@@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations

View File

@@ -21,7 +21,7 @@ options:
type: string
required: true
extends_documentation_fragment:
- community.crypto.name_encoding
- community.crypto._name_encoding
seealso:
- module: community.crypto.openssl_csr_info
- plugin: community.crypto.to_serial

View File

@@ -32,7 +32,7 @@ options:
type: bool
default: false
extends_documentation_fragment:
- community.crypto.name_encoding
- community.crypto._name_encoding
seealso:
- module: community.crypto.openssl_privatekey_info
"""

View File

@@ -21,7 +21,7 @@ options:
type: string
required: true
extends_documentation_fragment:
- community.crypto.name_encoding
- community.crypto._name_encoding
seealso:
- module: community.crypto.x509_certificate_info
- plugin: community.crypto.to_serial

View File

@@ -29,7 +29,7 @@ options:
default: true
version_added: 1.7.0
extends_documentation_fragment:
- community.crypto.name_encoding
- community.crypto._name_encoding
seealso:
- module: community.crypto.x509_crl_info
- plugin: community.crypto.to_serial

View File

@@ -31,10 +31,10 @@ seealso:
- module: community.crypto.acme_inspect
description: Allows to debug problems.
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.attributes
- community.crypto.attributes.actiongroup_acme
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._attributes
- community.crypto._attributes.actiongroup_acme
attributes:
check_mode:
support: full

View File

@@ -18,12 +18,12 @@ notes:
- The M(community.crypto.acme_account) module allows to modify, create and delete ACME accounts.
- This module was called C(acme_account_facts) before Ansible 2.8. The usage did not change.
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.attributes
- community.crypto.attributes.actiongroup_acme
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._attributes
- community.crypto._attributes.actiongroup_acme
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
options:
retrieve_orders:
description:

View File

@@ -17,11 +17,11 @@ description:
(U(https://datatracker.ietf.org/doc/draft-ietf-acme-ari/)).
This module implements version 3 of the ARI draft.
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.no_account
- community.crypto.attributes
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto._acme.basic
- community.crypto._acme.no_account
- community.crypto._attributes
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
options:
certificate_path:
description:

View File

@@ -65,12 +65,12 @@ seealso:
- module: community.crypto.acme_certificate_deactivate_authz
description: Allows to deactivate (invalidate) ACME v2 orders.
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.acme.certificate
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto.attributes.actiongroup_acme
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._acme.certificate
- community.crypto._attributes
- community.crypto._attributes.files
- community.crypto._attributes.actiongroup_acme
attributes:
check_mode:
support: full

View File

@@ -21,10 +21,10 @@ description:
seealso:
- module: community.crypto.acme_certificate
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.attributes
- community.crypto.attributes.actiongroup_acme
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._attributes
- community.crypto._attributes.actiongroup_acme
attributes:
check_mode:
support: full

View File

@@ -80,11 +80,11 @@ seealso:
- module: community.crypto.acme_inspect
description: Allows to debug problems.
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.acme.certificate
- community.crypto.attributes
- community.crypto.attributes.actiongroup_acme
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._acme.certificate
- community.crypto._attributes
- community.crypto._attributes.actiongroup_acme
attributes:
check_mode:
support: none

View File

@@ -48,12 +48,12 @@ seealso:
- module: community.crypto.acme_certificate_deactivate_authz
description: Allows to deactivate (invalidate) ACME v2 orders.
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.acme.certificate
- community.crypto.attributes
- community.crypto.attributes.actiongroup_acme
- community.crypto.attributes.files
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._acme.certificate
- community.crypto._attributes
- community.crypto._attributes.actiongroup_acme
- community.crypto._attributes.files
attributes:
check_mode:
support: none

View File

@@ -40,12 +40,12 @@ seealso:
- module: community.crypto.acme_certificate_deactivate_authz
description: Allows to deactivate (invalidate) ACME v2 orders.
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.attributes
- community.crypto.attributes.actiongroup_acme
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto.attributes.info_module
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._attributes
- community.crypto._attributes.actiongroup_acme
- community.crypto._attributes.idempotent_not_modify_state
- community.crypto._attributes.info_module
options:
order_uri:
description:

View File

@@ -49,11 +49,11 @@ seealso:
- module: community.crypto.acme_certificate_deactivate_authz
description: Allows to deactivate (invalidate) ACME v2 orders.
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.attributes
- community.crypto.attributes.actiongroup_acme
- community.crypto.attributes.files
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._attributes
- community.crypto._attributes.actiongroup_acme
- community.crypto._attributes.files
attributes:
check_mode:
support: none

View File

@@ -16,11 +16,11 @@ description:
- If available, the ARI extension (ACME Renewal Information, U(https://datatracker.ietf.org/doc/draft-ietf-acme-ari/)) is
used. This module implements version 3 of the ARI draft.".
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.no_account
- community.crypto.attributes
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto._acme.basic
- community.crypto._acme.no_account
- community.crypto._attributes
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
attributes:
idempotent:
support: partial

View File

@@ -29,10 +29,10 @@ seealso:
- module: community.crypto.acme_inspect
description: Allows to debug problems.
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.attributes
- community.crypto.attributes.actiongroup_acme
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._attributes
- community.crypto._attributes.actiongroup_acme
attributes:
check_mode:
support: none

View File

@@ -22,8 +22,8 @@ seealso:
description: The specification of the C(tls-alpn-01) challenge (RFC 8737).
link: https://www.rfc-editor.org/rfc/rfc8737.html
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.cryptography_dep.minimum
- community.crypto._attributes
- community.crypto._cryptography_dep.minimum
attributes:
check_mode:
support: none

View File

@@ -32,10 +32,10 @@ seealso:
description: The specification of the C(tls-alpn-01) challenge (RFC 8737).
link: https://www.rfc-editor.org/rfc/rfc8737.html
extends_documentation_fragment:
- community.crypto.acme.basic
- community.crypto.acme.account
- community.crypto.attributes
- community.crypto.attributes.actiongroup_acme
- community.crypto._acme.basic
- community.crypto._acme.account
- community.crypto._attributes
- community.crypto._attributes.actiongroup_acme
attributes:
check_mode:
support: none

View File

@@ -18,9 +18,9 @@ description:
that the signature is correct. It ignores validity dates and key usage completely. If you need to verify that a generated
chain is valid, please use C(openssl verify ...).
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto.cryptography_dep.minimum
- community.crypto._attributes
- community.crypto._attributes.idempotent_not_modify_state
- community.crypto._cryptography_dep.minimum
attributes:
check_mode:
support: full

View File

@@ -16,9 +16,9 @@ description:
- The current version retrieves information on the L(Python cryptography library, https://cryptography.io/) available to
Ansible modules, and on the OpenSSL binary C(openssl) found in the path.
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto._attributes
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
options: {}
"""

View File

@@ -20,10 +20,10 @@ description:
notes:
- O(path) must be specified as the output location of the certificate.
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto.cryptography_dep.minimum
- community.crypto.ecs_credential
- community.crypto._attributes
- community.crypto._attributes.files
- community.crypto._cryptography_dep.minimum
- community.crypto._ecs_credential
attributes:
check_mode:
support: partial

View File

@@ -34,8 +34,8 @@ notes:
when requesting a validation while O(verification_method=dns) or O(verification_method=web_server). Be aware of that if
doing many domain validation requests.
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.ecs_credential
- community.crypto._attributes
- community.crypto._ecs_credential
attributes:
check_mode:
support: none

View File

@@ -14,9 +14,9 @@ description:
- Makes a secure connection and returns information about the presented certificate.
- The module uses the cryptography Python library.
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto.cryptography_dep.minimum
- community.crypto._attributes
- community.crypto._attributes.idempotent_not_modify_state
- community.crypto._cryptography_dep.minimum
attributes:
check_mode:
support: none

View File

@@ -15,7 +15,7 @@ description:
- Module manages L(LUKS,https://en.wikipedia.org/wiki/Linux_Unified_Key_Setup) on given device. Supports creating, destroying,
opening and closing of LUKS container and adding or removing new keys and passphrases.
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto._attributes
attributes:
check_mode:

View File

@@ -16,8 +16,8 @@ requirements:
- "ssh-keygen"
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto._attributes
- community.crypto._attributes.files
attributes:
check_mode:
support: full

View File

@@ -18,8 +18,8 @@ requirements:
- cryptography >= 3.3 (if O(backend=cryptography))
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto._attributes
- community.crypto._attributes.files
attributes:
check_mode:
support: full

View File

@@ -18,9 +18,9 @@ author:
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto.module_csr
- community.crypto._attributes
- community.crypto._attributes.files
- community.crypto._module_csr
attributes:
check_mode:
support: full

View File

@@ -18,11 +18,11 @@ author:
- Felix Fontein (@felixfontein)
- Yanis Guenane (@Spredzy)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto.cryptography_dep.minimum
- community.crypto.name_encoding
- community.crypto._attributes
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
- community.crypto._cryptography_dep.minimum
- community.crypto._name_encoding
options:
path:
description:

View File

@@ -18,8 +18,8 @@ author:
- Yanis Guenane (@Spredzy)
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.module_csr
- community.crypto._attributes
- community.crypto._module_csr
attributes:
check_mode:
support: full

View File

@@ -23,8 +23,8 @@ author:
- Thom Wiggers (@thomwiggers)
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto._attributes
- community.crypto._attributes.files
attributes:
check_mode:
support: full

View File

@@ -16,9 +16,9 @@ description:
- The module uses the cryptography Python library.
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto.cryptography_dep.minimum
- community.crypto._attributes
- community.crypto._attributes.files
- community.crypto._cryptography_dep.minimum
attributes:
check_mode:
support: full

View File

@@ -20,9 +20,9 @@ author:
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto.module_privatekey
- community.crypto._attributes
- community.crypto._attributes.files
- community.crypto._module_privatekey
attributes:
check_mode:
support: full

View File

@@ -17,9 +17,9 @@ author:
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto.module_privatekey_convert
- community.crypto._attributes
- community.crypto._attributes.files
- community.crypto._module_privatekey_convert
attributes:
check_mode:
support: full

View File

@@ -20,10 +20,10 @@ author:
- Felix Fontein (@felixfontein)
- Yanis Guenane (@Spredzy)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto.cryptography_dep.minimum
- community.crypto._attributes
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
- community.crypto._cryptography_dep.minimum
options:
path:
description:

View File

@@ -21,9 +21,9 @@ author:
- Yanis Guenane (@Spredzy)
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.flow
- community.crypto.module_privatekey
- community.crypto._attributes
- community.crypto._attributes.flow
- community.crypto._module_privatekey
attributes:
action:
support: full

View File

@@ -19,9 +19,9 @@ author:
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto.cryptography_dep.minimum
- community.crypto._attributes
- community.crypto._attributes.files
- community.crypto._cryptography_dep.minimum
attributes:
check_mode:
support: full

View File

@@ -16,10 +16,10 @@ version_added: 1.7.0
author:
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto.cryptography_dep.minimum
- community.crypto._attributes
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
- community.crypto._cryptography_dep.minimum
options:
path:
description:

View File

@@ -17,8 +17,8 @@ author:
- Patrick Pichler (@aveexy)
- Markus Teufelberger (@MarkusTeufelberger)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.cryptography_dep.minimum
- community.crypto._attributes
- community.crypto._cryptography_dep.minimum
attributes:
check_mode:
support: full

View File

@@ -17,10 +17,10 @@ author:
- Patrick Pichler (@aveexy)
- Markus Teufelberger (@MarkusTeufelberger)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto.cryptography_dep.minimum
- community.crypto._attributes
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
- community.crypto._cryptography_dep.minimum
options:
path:
description:

View File

@@ -25,13 +25,13 @@ author:
- Markus Teufelberger (@MarkusTeufelberger)
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto.module_certificate
- community.crypto.module_certificate.backend_acme_documentation
- community.crypto.module_certificate.backend_entrust_documentation
- community.crypto.module_certificate.backend_ownca_documentation
- community.crypto.module_certificate.backend_selfsigned_documentation
- community.crypto._attributes
- community.crypto._attributes.files
- community.crypto._module_certificate
- community.crypto._module_certificate.backend_acme_documentation
- community.crypto._module_certificate.backend_entrust_documentation
- community.crypto._module_certificate.backend_ownca_documentation
- community.crypto._module_certificate.backend_selfsigned_documentation
attributes:
check_mode:
support: full

View File

@@ -16,8 +16,8 @@ author:
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto._attributes
- community.crypto._attributes.files
attributes:
check_mode:
support: full

View File

@@ -24,11 +24,11 @@ author:
- Yanis Guenane (@Spredzy)
- Markus Teufelberger (@MarkusTeufelberger)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto.cryptography_dep.minimum
- community.crypto.name_encoding
- community.crypto._attributes
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
- community.crypto._cryptography_dep.minimum
- community.crypto._name_encoding
options:
path:
description:

View File

@@ -19,11 +19,11 @@ author:
- Markus Teufelberger (@MarkusTeufelberger)
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.module_certificate
- community.crypto.module_certificate.backend_entrust_documentation
- community.crypto.module_certificate.backend_ownca_documentation
- community.crypto.module_certificate.backend_selfsigned_documentation
- community.crypto._attributes
- community.crypto._module_certificate
- community.crypto._module_certificate.backend_entrust_documentation
- community.crypto._module_certificate.backend_ownca_documentation
- community.crypto._module_certificate.backend_selfsigned_documentation
attributes:
check_mode:
support: full

View File

@@ -18,10 +18,10 @@ author:
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- ansible.builtin.files
- community.crypto.attributes
- community.crypto.attributes.files
- community.crypto.cryptography_dep.minimum
- community.crypto.name_encoding
- community.crypto._attributes
- community.crypto._attributes.files
- community.crypto._cryptography_dep.minimum
- community.crypto._name_encoding
attributes:
check_mode:
support: full

View File

@@ -15,11 +15,11 @@ description:
author:
- Felix Fontein (@felixfontein)
extends_documentation_fragment:
- community.crypto.attributes
- community.crypto.attributes.info_module
- community.crypto.attributes.idempotent_not_modify_state
- community.crypto.cryptography_dep.minimum
- community.crypto.name_encoding
- community.crypto._attributes
- community.crypto._attributes.info_module
- community.crypto._attributes.idempotent_not_modify_state
- community.crypto._cryptography_dep.minimum
- community.crypto._name_encoding
options:
path:
description: