sensu.sensu_go.secrets_provider_vault – Manage Sensu VaultProvider secrets providers
Note
This plugin is part of the sensu.sensu_go collection (version 1.12.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.secrets_provider_vault
.
New in version 1.6.0: of sensu.sensu_go
Synopsis
Create, update or delete a Sensu Go VaultProvider secrets provider.
For more information, refer to the Sensu Go documentation at https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets-providers/.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
Parameters
Parameter |
Comments |
---|---|
Address of the Vault server. Required if state is |
|
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: “P@ssw0rd!” |
|
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked. Default: “http://localhost:8080” |
|
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: “admin” |
|
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 allowed number of secrets requests in a rate interval. |
|
Maximum number of times to retry failed connections to Vault server. |
|
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. |
|
Maximum number of secrets requests for per second. |
|
Target state of the Sensu object. Choices:
|
|
Timeout (in seconds) for connection to Vault server. |
|
TLS configuration for establishing connection with Vault server. |
|
Path to the certificate file of the trusted certificate authority. |
|
Path to the client certificate file. |
|
Path to the client key file. |
|
Canonical name for the client. |
|
Authentication token to use with Vault. Required if state is |
|
Version of the Vault key/value store. Please refer to https://www.vaultproject.io/docs/secrets/kv for additional information. Required if state is Choices:
|
See Also
See also
- sensu.sensu_go.secrets_provider_env
The official documentation on the sensu.sensu_go.secrets_provider_env module.
- sensu.sensu_go.secrets_provider_info
The official documentation on the sensu.sensu_go.secrets_provider_info module.
- sensu.sensu_go.secret
The official documentation on the sensu.sensu_go.secret module.
- sensu.sensu_go.secret_info
The official documentation on the sensu.sensu_go.secret_info module.
Examples
- name: Create a vault secrets provider
sensu.sensu_go.secrets_provider_vault:
name: my-vault
address: https://my-vault.com
token: VAULT_TOKEN
version: v1
- name: Delete a vault secrets provider
sensu.sensu_go.secrets_provider_vault:
name: my-vault
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Object representing Sensu vault secrets provider. Returned: success Sample: {“client”: {“address”: “https://vaultserver.example.com:8200”, “max_retries”: 2, “rate_limiter”: {“burst”: 100, “limit”: 10}, “timeout”: “20s”, “tls”: {“ca_cert”: “/etc/ssl/certs/vault_ca_cert.pem”}, “token”: “VAULT_TOKEN”, “version”: “v1”}, “metadata”: {“name”: “vault”}} |
Authors
Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Miha Dolinar (@mdolin)
Tadej Borovsak (@tadeboro)