Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add action_group and check_mode attributes #320

Merged
merged 7 commits into from
Nov 5, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions plugins/doc_fragments/action_group.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# -*- coding: utf-8 -*-

# Copyright: (c) 2022, Brian Scholer (@briantist)
# 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

from __future__ import (absolute_import, division, print_function)
__metaclass__ = type


class ModuleDocFragment(object):

DOCUMENTATION = r'''
options: {}
attributes:
action_group:
description: Use C(group/community.hashi_vault.vault) in C(module_defaults) to set defaults for this module.
support: full
membership:
- community.hashi_vault.vault
'''
1 change: 1 addition & 0 deletions plugins/modules/vault_kv1_get.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
description: Documentation for the Vault KV secrets engine, version 1.
link: https://www.vaultproject.io/docs/secrets/kv/kv-v1
extends_documentation_fragment:
- community.hashi_vault.action_group
- community.hashi_vault.connection
- community.hashi_vault.auth
- community.hashi_vault.engine_mount
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/vault_kv2_delete.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
description: Documentation for the Vault KV secrets engine, version 2.
link: https://www.vaultproject.io/docs/secrets/kv/kv-v2
extends_documentation_fragment:
- community.hashi_vault.action_group
- community.hashi_vault.connection
- community.hashi_vault.auth
- community.hashi_vault.engine_mount
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/vault_kv2_get.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
description: Documentation for the Vault KV secrets engine, version 2.
link: https://www.vaultproject.io/docs/secrets/kv/kv-v2
extends_documentation_fragment:
- community.hashi_vault.action_group
- community.hashi_vault.connection
- community.hashi_vault.auth
- community.hashi_vault.engine_mount
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/vault_login.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
- ref: community.hashi_vault.vault_login_token filter <ansible_collections.community.hashi_vault.vault_login_token_filter>
description: The official documentation for the C(community.hashi_vault.vault_login_token) filter plugin.
extends_documentation_fragment:
- community.hashi_vault.action_group
- community.hashi_vault.connection
- community.hashi_vault.auth
notes:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/vault_pki_generate_certificate.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
description: HVAC library reference about the PKI engine.
link: https://hvac.readthedocs.io/en/stable/usage/secrets_engines/pki.html#generate-certificate
extends_documentation_fragment:
- community.hashi_vault.action_group
- community.hashi_vault.connection
- community.hashi_vault.auth
- community.hashi_vault.engine_mount
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/vault_read.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
- ref: community.hashi_vault.hashi_vault lookup <ansible_collections.community.hashi_vault.hashi_vault_lookup>
description: The official documentation for the C(community.hashi_vault.hashi_vault) lookup plugin.
extends_documentation_fragment:
- community.hashi_vault.action_group
- community.hashi_vault.connection
- community.hashi_vault.auth
options:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/vault_token_create.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
- ref: community.hashi_vault.vault_login_token filter <ansible_collections.community.hashi_vault.vault_login_token_filter>
description: The official documentation for the C(community.hashi_vault.vault_login_token) filter plugin.
extends_documentation_fragment:
- community.hashi_vault.action_group
- community.hashi_vault.connection
- community.hashi_vault.auth
- community.hashi_vault.token_create
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/vault_write.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
- ref: community.hashi_vault.vault_read lookup <ansible_collections.community.hashi_vault.vault_read_lookup>
description: The official documentation for the C(community.hashi_vault.vault_read) lookup plugin.
extends_documentation_fragment:
- community.hashi_vault.action_group
- community.hashi_vault.connection
- community.hashi_vault.auth
- community.hashi_vault.wrapping
Expand Down