sensu.sensu_go.pipeline module – Manage Sensu pipeline
Note
This module is part of the sensu.sensu_go collection (version 1.14.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install sensu.sensu_go.
To use it in a playbook, specify: sensu.sensu_go.pipeline.
Note
The sensu.sensu_go collection will be removed from Ansible 12 due to violations of the Ansible inclusion requirements. The collection has unresolved sanity test failures. See the discussion thread for more information.
New in sensu.sensu_go 1.14.0
Synopsis
Create, update or delete a Sensu pipeline.
For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-process/pipelines/.
Parameters
Parameter |
Comments |
|---|---|
Authentication parameters. Can define each of them with ENV as well. |
|
The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked. This replaces auth.user and auth.password parameters. For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/. |
|
Path to the CA bundle that should be used to validate the backend certificate. If this parameter is not set, module will use the CA bundle that python is using. It is also possible to set this parameter via the SENSU_CA_PATH environment variable. |
|
The Sensu user’s password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked. This parameter is ignored if the auth.api_key parameter is set. Default: |
|
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked. Default: |
|
The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked. This parameter is ignored if the auth.api_key parameter is set. Default: |
|
Flag that controls the certificate validation. If you are using self-signed certificates, you can set this parameter to ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter. It is also possible to set this parameter via the SENSU_VERIFY environment variable. Choices:
|
|
Custom metadata fields that can be accessed within Sensu, as key/value pairs. Default: |
|
The Sensu resource’s name. This name (in combination with the namespace where applicable) uniquely identifies the resource that Ansible operates on. If the resource with selected name already exists, Ansible module will update it to match the specification in the task. Consult the name metadata attribute specification in the upstream docs on https://docs.sensu.io/sensu-go/latest/reference/ for more details about valid names and other restrictions. |
|
RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used. Default: |
|
Target state of the Sensu object. Choices:
|
|
Array of workflows (by names) to use when filtering, mutating, and handling observability events with a pipeline. |
|
Reference for the Sensu event filters to use when filtering events for the pipeline. Each pipeline workflow can reference more than one event filter. If a workflow has more than one filter, Sensu applies the filters in a series, starting with the filter that is listed first. |
|
Name of the Sensu event filter to use for the workflow. You can use the built-in event filters, as well as your existing event filters, in pipeline workflows. |
|
The sensuctl create resource type for the event filter. Event filters should always be type EventFilter. Choices:
|
|
Reference for the Sensu handler to use for event processing in the workflow. Each pipeline workflow must reference one handler. Pipelines ignore any filters and mutators specified in handler definitions. |
|
Name of the Sensu handler to use for the workflow. You can use your existing handlers in pipeline workflows. Pipelines ignore any filters and mutators specified in handler definitions. |
|
The sensuctl create resource type for the handler. Choices:
|
|
Reference for the Sensu mutator to use to mutate event data for the workflow. Each pipeline workflow can reference only one mutator. |
|
Name of the Sensu mutator to use for the workflow. You can use your existing mutators in pipeline workflows. |
|
The sensuctl create resource type for the mutator. Mutators should always be type Mutator. Choices:
|
|
Name of the Sensu pipeline workflow. |
See Also
See also
- sensu.sensu_go.socket_handler
Manage Sensu TCP/UDP handler.
- sensu.sensu_go.handler_info
List Sensu handlers.
- sensu.sensu_go.pipe_handler
Manage Sensu pipe handler.
- sensu.sensu_go.filter
Manage Sensu filters.
- sensu.sensu_go.filter_info
List Sensu info.
- sensu.sensu_go.mutator
Manage Sensu mutators.
- sensu.sensu_go.mutator_info
List Sensu mutators.
Examples
- name: Create a pipeline
sensu.sensu_go.pipeline:
name: this_pipeline
workflows:
- name: this-wf
handler:
name: this_handler
type: tcp_stream_handler
filters:
- name: this_filter
- name: this_filter_2
mutator:
name: this_mutator
- name: Delete pipeline
sensu.sensu_go.pipeline:
name: this_pipeline
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Object representing Sensu pipeline. Returned: success Sample: |