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

default to true/false #325

Merged
merged 4 commits into from
Jan 2, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 2 additions & 0 deletions changelogs/fragments/325_true_false.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- default to true/false in docs and code
4 changes: 2 additions & 2 deletions plugins/callback/grafana_annotations.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
options:
grafana_url:
description: Grafana annotations api URL
required: True
required: true
env:
- name: GRAFANA_URL
ini:
Expand All @@ -45,7 +45,7 @@
key: validate_grafana_certs
- section: callback_grafana_annotations
key: validate_certs
default: True
default: true
type: bool
aliases: [ validate_grafana_certs ]
http_agent:
Expand Down
10 changes: 5 additions & 5 deletions plugins/doc_fragments/basic_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ class ModuleDocFragment(object):
aliases: [ grafana_password ]
use_proxy:
description:
- If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
- If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
type: bool
default: yes
default: true
client_cert:
description:
- PEM formatted certificate chain file to be used for SSL client authentication.
Expand All @@ -45,8 +45,8 @@ class ModuleDocFragment(object):
type: path
validate_certs:
description:
- If C(no), SSL certificates will not be validated.
- This should only set to C(no) used on personally controlled sites using self-signed certificates.
- If C(false), SSL certificates will not be validated.
- This should only set to C(false) used on personally controlled sites using self-signed certificates.
type: bool
default: yes
default: true
'''
4 changes: 2 additions & 2 deletions plugins/modules/grafana_dashboard.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
description:
- Override existing dashboard when state is present.
type: bool
default: 'no'
default: false
dashboard_id:
description:
- Public Grafana.com dashboard id to import
Expand Down Expand Up @@ -92,7 +92,7 @@
grafana_api_key: "{{ grafana_api_key }}"
state: present
commit_message: Updated by ansible
overwrite: yes
overwrite: true
path: /path/to/dashboards/foo.json

- name: Import Grafana dashboard Zabbix
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/grafana_datasource.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,15 @@
type: str
basic_auth_password:
description:
- The datasource basic auth password, when C(basic auth) is C(yes).
- The datasource basic auth password, when C(basic auth) is C(true).
- Stored as secure data, see C(enforce_secure_data) and notes!
type: str
with_credentials:
description:
- Whether credentials such as cookies or auth headers should be sent with cross-site
requests.
type: bool
default: 'no'
default: false
tls_client_cert:
description:
- The client TLS certificate.
Expand Down Expand Up @@ -123,7 +123,7 @@
description:
- Make this datasource the default one.
type: bool
default: 'no'
default: false
org_id:
description:
- Grafana Organisation ID in which the datasource should be created.
Expand Down Expand Up @@ -217,7 +217,7 @@
description:
- Use trends or not for zabbix datasource type.
type: bool
default: False
default: false
aws_auth_type:
description:
- Type for AWS authentication for CloudWatch datasource type (authType of grafana
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/grafana_folder.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
- This parameter can be useful if you enabled `hide_version` in grafana.ini
required: False
type: bool
default: False
default: false
version_added: "1.2.0"
extends_documentation_fragment:
- community.grafana.basic_auth
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/grafana_notification_channel.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,17 @@
- Required when I(state) is C(present).
is_default:
type: bool
default: 'no'
default: false
description:
- Use this channel for all alerts.
include_image:
type: bool
default: 'no'
default: false
description:
- Capture a visualization image and attach it to notifications.
disable_resolve_message:
type: bool
default: 'no'
default: false
description:
- Disable the resolve message.
reminder_frequency:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/grafana_plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
validate_certs:
description:
- Boolean variable to include --insecure while installing pluging
default: False
default: false
type: bool
'''

Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/grafana_team.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@
description:
- Delete the members not found in the C(members) parameters from the
- list of members found on the Team.
default: False
default: false
type: bool
skip_version_check:
description:
- Skip Grafana version check and try to reach api endpoint anyway.
- This parameter can be useful if you enabled `hide_version` in grafana.ini
required: False
type: bool
default: False
default: false
version_added: "1.2.0"
extends_documentation_fragment:
- community.grafana.basic_auth
Expand Down Expand Up @@ -104,7 +104,7 @@
members:
- [email protected]
- [email protected]
enforce_members: yes
enforce_members: true
state: present

- name: Delete a team
Expand Down
Loading