Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
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: 1 addition & 1 deletion docs/source/roles/agent.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Go agent version we are installing. All valid options are listed in the
`official Sensu documentation`_.

.. _official Sensu documentation:
https://docs.sensu.io/sensu-go/latest/reference/agent/#configuration
https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-schedule/agent/#general-configuration

.. note::

Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/asset.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
description:
- Create, update or delete Sensu Go asset.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/assets/).
U(https://docs.sensu.io/sensu-go/latest/plugins/assets/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/asset_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Retrieve information about Sensu Go assets.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/assets/).
U(https://docs.sensu.io/sensu-go/latest/plugins/assets/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/bonsai_asset.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
- Create or update a Sensu Go asset whose definition is available in the
Bonsai, the Sensu asset index.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/assets/)
U(https://docs.sensu.io/sensu-go/latest/plugins/assets/)
and U(https://bonsai.sensu.io/).
version_added: 1.0.0
extends_documentation_fragment:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/check.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
description:
- Create, update or delete Sensu Go check.
- For more information, refer to the Sensu Go documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/checks/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-schedule/checks/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/check_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Retrieve information about Sensu Go checks.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/checks/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-schedule/checks/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/cluster_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
description:
- Retrieve information about Sensu Go clusters.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/cluster-sensu/).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#cluster-role-bindings).
version_added: 1.9.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/cluster_role.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete Sensu role.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#roles-and-cluster-roles).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#cluster-roles).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/cluster_role_binding.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete Sensu cluster role binding.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#role-bindings-and-cluster-role-bindings).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#cluster-role-bindings).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/cluster_role_binding_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
description:
- Retrieve information about Sensu cluster role bindings.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#role-bindings-and-cluster-role-bindings).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#cluster-role-bindings).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/cluster_role_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
description:
- Retrieve information about Sensu roles.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#roles-and-cluster-roles).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#cluster-roles).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/datastore.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
description:
- Add or remove external datastore provider.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/datastore/).
U(https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/datastore/).
version_added: 1.1.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/datastore_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
description:
- Retrieve information about external Sensu datastores.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/datastore/).
U(https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/datastore/).
version_added: 1.1.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/entity.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete Sensu entity.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/entities/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-entities/entities/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/entity_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Retrieve information about Sensu entities.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/entities/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-entities/entities/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
23 changes: 3 additions & 20 deletions plugins/modules/event.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Send a synthetic event to Sensu.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/events/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-events/events/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand All @@ -36,7 +36,7 @@
notes:
- Metric events bypass the store and are sent off to the event pipeline and corresponding event
handlers. Read more about this at
U(https://docs.sensu.io/sensu-go/latest/reference/events/#metric-only-events).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-events/events/#example-metrics-only-event).
options:
timestamp:
description:
Expand All @@ -56,7 +56,7 @@
type: dict
description:
- Additional check parameters. Find out more at
U(https://docs.sensu.io/sensu-go/latest/reference/events/#check-attributes).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-events/events/#check-attributes).
suboptions:
duration:
description:
Expand Down Expand Up @@ -97,23 +97,6 @@
description:
- The total state change percentage for the check's history.
type: int
metric_attributes:
Comment thread
juremedvesek marked this conversation as resolved.
type: dict
description:
- Metric attributes. Find out more at
U(https://docs.sensu.io/sensu-go/latest/reference/events/#metric-attributes).
suboptions:
handlers:
description:
- An array of Sensu handlers to use for events created by the check.
Each array item must be a string.
type: list
elements: str
points:
description:
- Metric data points including a name, timestamp, value, and tags.
type: list
elements: dict
'''

EXAMPLES = '''
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/event_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Retrieve recent events that Sensu processed.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/events/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-events/events/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete Sensu filter.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/filters/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-filter/filters/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/filter_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Retrieve information about Sensu filters.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/filters/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-filter/filters/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/handler_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
description:
- Retrieve information about Sensu handlers.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/handlers/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/handlers/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/handler_set.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
description:
- Create, update or delete Sensu handler set.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/handlers/#handler-sets).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/handlers/#handler-sets).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/hook.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete Sensu hook.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/hooks/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-schedule/hooks/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/hook_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Retrieve information about Sensu hooks.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/hooks/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-schedule/hooks/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/mutator.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete Sensu mutator.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/mutators/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-transform/mutators/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/mutator_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Retrieve information about Sensu mutators.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/mutators/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-transform/mutators/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/namespace.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete a Sensu namespace.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#namespaces).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/namespaces/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/namespace_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
description:
- Retrieve information about Sensu namespaces.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#namespaces).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/namespaces/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/pipe_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
description:
- Create, update or delete a Sensu pipe handler.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/handlers/#pipe-handlers).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/handlers/#pipe-handlers).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/role.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete Sensu role.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#roles-and-cluster-roles).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#roles).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/role_binding.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete Sensu role binding.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#role-bindings-and-cluster-role-bindings).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#role-bindings).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/role_binding_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
description:
- Retrieve information about Sensu role bindings.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#role-bindings-and-cluster-role-bindings).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#role-bindings).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/role_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
description:
- Retrieve information about Sensu roles.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#roles-and-cluster-roles).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#roles).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/silence.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Create, update or delete Sensu silence.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/silencing/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/silencing/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/silence_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Retrieve information about Sensu silences.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/silencing/).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/silencing/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/socket_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
description:
- Create, update or delete Sensu socket handler.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/handlers/#tcp-udp-handlers).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/handlers/#tcpudp-handlers).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/tessen.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Enable or disable Tessen service.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/tessen/).
U(https://docs.sensu.io/sensu-go/latest/operations/monitor-sensu/tessen/).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
description:
- Create, update, activate or deactivate Sensu user.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#users).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#users).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/user_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
description:
- Retrieve information about Sensu users.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#users).
U(https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#users).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
Expand Down
2 changes: 1 addition & 1 deletion roles/agent/defaults/main.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# Related to /etc/sensu/backend.yml, see
# https://docs.sensu.io/sensu-go/latest/reference/agent/#configuration-summary
# https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-schedule/agent/#general-configuration
agent_backend_urls: "{{ hostvars | sensu.sensu_go.backends(groups) }}"
agent_config:
2 changes: 1 addition & 1 deletion roles/agent/meta/argument_specs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ argument_specs:
- Any option that is valid for the Sensu Go agent version we are
installing.
- All valid options are listed at
U(https://docs.sensu.io/sensu-go/latest/reference/agent/#configuration).
U(https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-schedule/agent/#general-configuration).
- Role copies the key-value pairs from the I(agent_config) variable
verbatim to the configuration file. This means that we must copy
the key names B(exactly) as they appear in the configuration
Expand Down