sensu.sensu_go.datastore module – Manage Sensu external datastore providers
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: sensu.sensu_go.datastore.
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.1.0
Synopsis
Add or remove external datastore provider.
For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/reference/datastore/.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
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:
|
|
Maximum number of requests to buffer in memory. Default: |
|
Number of requests in each PostgreSQL write transaction, as specified in the PostgreSQL configuration. Default: |
|
Number of Goroutines sending data to PostgreSQL, as specified in the PostgreSQL configuration. Set to current PostgreSQL pool size as default. |
|
Attribute that specifies the data source names as a URL or PostgreSQL connection string. See the PostgreSQL docs for more information about connection strings. |
|
Enables round robin scheduling on PostgreSQL. Any existing round robin scheduling will stop and migrate to PostgreSQL as entities check in with keepalives. Sensu will gradually delete the existing etcd scheduler state as keepalives on the etcd scheduler keys expire over time. Choices:
|
|
Maximum time a connection can persist before being destroyed. |
|
Maximum number of number of idle connections to retain. 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. |
|
The maximum number of connections to hold in the PostgreSQL connection pool. |
|
Target state of the Sensu object. Choices:
|
|
When the PostgresConfig resource is created, configuration validation will include connecting to the PostgreSQL database and executing a query to confirm whether the connected user has permission to create database tables. Sensu-backend will try to connect to PostgreSQL indefinitely at 5-second intervals instead of reverting to etcd after 3 attempts. We recommend setting strict to true in most cases. If the connection fails or the user does not have permission to create database tables, resource configuration will fail and the configuration will not be persisted. This extended configuration is useful for debugging when you are not sure whether the configuration is correct or the database is working properly. Choices:
|
Notes
Note
Currently, only one external datastore can be active at a time. The module will fail to perform its operation if this would break that invariant.
See Also
See also
- sensu.sensu_go.datastore_info
List external Sensu datastore providers.
Examples
- name: Add external datastore
sensu.sensu_go.datastore:
name: my-postgres
dsn: postgresql://user:secret@host:port/dbname
- name: Remove external datastore
sensu.sensu_go.datastore:
name: my-postgres
state: absent
- name: Add external datastore with pool_size and max_conn_lifetime specified
sensu.sensu_go.datastore:
name: my-postgres
dsn: postgresql://user:secret@host:port/dbname
pool_size: 1
max_conn_lifetime: "5m30s"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Object representing external datastore provider. Returned: success Sample: |