1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Add attributes to consul, datadog, jenkins, pagerduty, rundeck, and sensu modules (#5957)

* Add attributes to consul, datadog, jenkins, pagerduty, rundeck, and sensu modules.

* Fix error.
This commit is contained in:
Felix Fontein 2023-02-24 09:23:56 +01:00 committed by GitHub
parent bad4b4b086
commit 1f1ae558f9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 174 additions and 14 deletions

View file

@ -33,6 +33,13 @@ requirements:
- python-consul - python-consul
- requests - requests
author: "Steve Gargan (@sgargan)" author: "Steve Gargan (@sgargan)"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
state: state:
type: str type: str

View file

@ -19,6 +19,13 @@ description:
author: author:
- Steve Gargan (@sgargan) - Steve Gargan (@sgargan)
- Colin Nolan (@colin-nolan) - Colin Nolan (@colin-nolan)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
mgmt_token: mgmt_token:
description: description:

View file

@ -26,6 +26,13 @@ requirements:
author: author:
- Steve Gargan (@sgargan) - Steve Gargan (@sgargan)
- Colin Nolan (@colin-nolan) - Colin Nolan (@colin-nolan)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
state: state:
description: description:

View file

@ -20,7 +20,14 @@ requirements:
- python-consul - python-consul
- requests - requests
author: author:
- Steve Gargan (@sgargan) - Steve Gargan (@sgargan)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
id: id:
description: description:

View file

@ -22,6 +22,13 @@ author:
requirements: requirements:
- datadog-api-client - datadog-api-client
- Python 3.6+ - Python 3.6+
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
api_key: api_key:
description: description:

View file

@ -19,11 +19,18 @@ DOCUMENTATION = '''
module: datadog_event module: datadog_event
short_description: Posts events to Datadog service short_description: Posts events to Datadog service
description: description:
- "Allows to post events to Datadog (www.datadoghq.com) service." - "Allows to post events to Datadog (www.datadoghq.com) service."
- "Uses http://docs.datadoghq.com/api/#events API." - "Uses http://docs.datadoghq.com/api/#events API."
author: author:
- "Artūras 'arturaz' Šlajus (@arturaz)" - "Artūras 'arturaz' Šlajus (@arturaz)"
- "Naoya Nakazawa (@n0ts)" - "Naoya Nakazawa (@n0ts)"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
api_key: api_key:
type: str type: str

View file

@ -19,6 +19,13 @@ description:
- The type C(event-v2) was added in community.general 4.8.0. - The type C(event-v2) was added in community.general 4.8.0.
author: Sebastian Kornehl (@skornehl) author: Sebastian Kornehl (@skornehl)
requirements: [datadog] requirements: [datadog]
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
api_key: api_key:
description: description:

View file

@ -20,6 +20,13 @@ requirements:
author: author:
- Brett Milford (@brettmilford) - Brett Milford (@brettmilford)
- Tong He (@unnecessary-username) - Tong He (@unnecessary-username)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
args: args:
description: description:

View file

@ -17,6 +17,13 @@ description:
requirements: requirements:
- "python-jenkins >= 0.4.12" - "python-jenkins >= 0.4.12"
author: "Sergio Millan Rodriguez (@sermilrod)" author: "Sergio Millan Rodriguez (@sermilrod)"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: full
options: options:
config: config:
type: str type: str

View file

@ -17,6 +17,12 @@ short_description: Add or remove Jenkins plugin
description: description:
- Ansible module which helps to manage Jenkins plugins. - Ansible module which helps to manage Jenkins plugins.
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
group: group:
type: str type: str
@ -129,8 +135,9 @@ notes:
parameter to point to the Jenkins server. The module must be used on the parameter to point to the Jenkins server. The module must be used on the
host where Jenkins runs as it needs direct access to the plugin files. host where Jenkins runs as it needs direct access to the plugin files.
extends_documentation_fragment: extends_documentation_fragment:
- url - ansible.builtin.url
- files - ansible.builtin.files
- community.general.attributes
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -18,6 +18,15 @@ description:
- The C(jenkins_script) module takes a script plus a dict of values - The C(jenkins_script) module takes a script plus a dict of values
to use within the script and returns the result of the script being run. to use within the script and returns the result of the script being run.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
script: script:
type: str type: str

View file

@ -22,6 +22,13 @@ author:
- "Bruce Pennypacker (@bpennypacker)" - "Bruce Pennypacker (@bpennypacker)"
requirements: requirements:
- PagerDuty API access - PagerDuty API access
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
state: state:
type: str type: str

View file

@ -18,6 +18,13 @@ author:
- "Amanpreet Singh (@ApsOps)" - "Amanpreet Singh (@ApsOps)"
requirements: requirements:
- PagerDuty API access - PagerDuty API access
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
name: name:
type: str type: str

View file

@ -19,6 +19,15 @@ author:
- Adam Vaughan (@adamvaughan) - Adam Vaughan (@adamvaughan)
requirements: requirements:
- PagerDuty integration key - PagerDuty integration key
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
details:
- Check mode simply does nothing except returning C(changed=true) in case the I(url) seems to be correct.
diff_mode:
support: none
options: options:
integration_key: integration_key:
description: description:
@ -78,8 +87,6 @@ options:
required: false required: false
default: true default: true
type: bool type: bool
notes:
- Supports C(check_mode). Note that check mode simply does nothing except returning C(changed=true) in case the I(url) seems to be correct.
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -19,6 +19,13 @@ author: Zainab Alsaffar (@zanssa)
requirements: requirements:
- pdpyras python module = 4.1.1 - pdpyras python module = 4.1.1
- PagerDuty API Access - PagerDuty API Access
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
access_token: access_token:
description: description:
@ -56,8 +63,6 @@ options:
- Required if I(state=present). - Required if I(state=present).
type: list type: list
elements: str elements: str
notes:
- Supports C(check_mode).
''' '''
EXAMPLES = r''' EXAMPLES = r'''

View file

@ -19,6 +19,11 @@ short_description: Manage Rundeck ACL policies
description: description:
- Create, update and remove Rundeck ACL policies through HTTP API. - Create, update and remove Rundeck ACL policies through HTTP API.
author: "Loic Blot (@nerzhul)" author: "Loic Blot (@nerzhul)"
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
state: state:
type: str type: str
@ -76,7 +81,9 @@ options:
version_added: '0.2.0' version_added: '0.2.0'
validate_certs: validate_certs:
version_added: '0.2.0' version_added: '0.2.0'
extends_documentation_fragment: url extends_documentation_fragment:
- ansible.builtin.url
- community.general.attributes
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -17,6 +17,11 @@ description:
- This module runs a Rundeck job specified by ID. - This module runs a Rundeck job specified by ID.
author: "Phillipe Smith (@phsmith)" author: "Phillipe Smith (@phsmith)"
version_added: 3.8.0 version_added: 3.8.0
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
job_id: job_id:
type: str type: str
@ -68,7 +73,8 @@ options:
default: false default: false
extends_documentation_fragment: extends_documentation_fragment:
- community.general.rundeck - community.general.rundeck
- url - ansible.builtin.url
- community.general.attributes
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -21,6 +21,11 @@ short_description: Manage Rundeck projects
description: description:
- Create and remove Rundeck projects through HTTP API. - Create and remove Rundeck projects through HTTP API.
author: "Loic Blot (@nerzhul)" author: "Loic Blot (@nerzhul)"
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
state: state:
type: str type: str
@ -67,7 +72,9 @@ options:
version_added: '0.2.0' version_added: '0.2.0'
validate_certs: validate_certs:
version_added: '0.2.0' version_added: '0.2.0'
extends_documentation_fragment: url extends_documentation_fragment:
- ansible.builtin.url
- community.general.attributes
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -18,6 +18,13 @@ description:
- Most options do not have a default and will not be added to the check definition unless specified. - Most options do not have a default and will not be added to the check definition unless specified.
- All defaults except I(path), I(state), I(backup) and I(metric) are not managed by this module, - All defaults except I(path), I(state), I(backup) and I(metric) are not managed by this module,
- they are simply specified for your convenience. - they are simply specified for your convenience.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
name: name:
type: str type: str

View file

@ -16,6 +16,13 @@ short_description: Manages Sensu client configuration
description: description:
- Manages Sensu client configuration. - Manages Sensu client configuration.
- 'For more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/clients.html)' - 'For more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/clients.html)'
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
state: state:
type: str type: str

View file

@ -16,6 +16,13 @@ short_description: Manages Sensu handler configuration
description: description:
- Manages Sensu handler configuration - Manages Sensu handler configuration
- 'For more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/handlers.html)' - 'For more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/handlers.html)'
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
state: state:
type: str type: str

View file

@ -17,6 +17,13 @@ short_description: Manage Sensu silence entries
description: description:
- Create and clear (delete) a silence entries via the Sensu API - Create and clear (delete) a silence entries via the Sensu API
for subscriptions and checks. for subscriptions and checks.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
check: check:
type: str type: str

View file

@ -15,6 +15,13 @@ module: sensu_subscription
short_description: Manage Sensu subscriptions short_description: Manage Sensu subscriptions
description: description:
- Manage which I(sensu channels) a machine should subscribe to - Manage which I(sensu channels) a machine should subscribe to
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
name: name:
type: str type: str