sensu.sensu_go.etcd_replicator module – Manage Sensu Go etcd replicators
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.etcd_replicator.
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.9.0
Synopsis
Create, update or delete Sensu etcd replicator.
For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/etcdreplicators/.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
Parameters
Parameter |
Comments |
|---|---|
Sensu API version of the resource to replicate. |
|
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:
|
|
Path to an the PEM-format CA certificate to use for TLS client authentication. Required if insecure is |
|
Path to the PEM-format certificate to use for TLS client authentication. This certificate is required for secure client communication. Required if insecure is |
|
Disable transport security. Only set to Choices:
|
|
Path to the PEM-format key file associated with the cert to use for TLS client authentication. This key and its corresponding certificate are required for secure client communication. Required if insecure is |
|
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. |
|
Namespace to constrain replication to. If you do not include namespace, all namespaces for a given resource are replicated. |
|
Interval at which the resource will be replicated. In seconds. |
|
Name of the resource to replicate. List of all resources is available at https://docs.sensu.io/sensu-go/latest/operations/control-access/rbac/#resources. Required if state is |
|
Target state of the Sensu object. Choices:
|
|
Destination cluster URLs. Required if state is |
See Also
See also
- sensu.sensu_go.etcd_replicator_info
List available Sensu Go etcd replicators.
Examples
- name: Create a minimal replicator
sensu.sensu_go.etcd_replicator:
name: cluster_role_replicator
ca_cert: /etc/sensu/certs/ca.pem
cert: /etc/sensu/certs/cert.pem
key: /etc/sensu/certs/key.pem
url: https://sensu.alpha.example.com:2379
resource: ClusterRole
- name: Create an insecure minimal replicator
sensu.sensu_go.etcd_replicator:
name: role_replicator
insecure: true
url:
- https://sensu.beta.example.com:2379
- https://sensu.gamma.example.com:2379
resource: Role
- name: Create a replicator with all parameters set
sensu.sensu_go.etcd_replicator:
name: role_binding_replicator
ca_cert: /etc/sensu/certs/ca.pem
cert: /etc/sensu/certs/cert.pem
key: /etc/sensu/certs/key.pem
insecure: false
url: https://127.0.0.1:2379
api_version: core/v2
resource: RoleBinding
namespace: default
replication_interval_seconds: 30
- name: Delete a replicator
sensu.sensu_go.etcd_replicator:
name: my_replicator
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Object representing Sensu etcd replicator. Returned: success Sample: |