Steampunk Ansible Documentation - sensu.sensu_go.secrets_provider_vault (1.14.0) - module - Manage Sensu VaultProvider secrets providers

Install collection

Install with ansible-galaxy collection install sensu.sensu_go:==1.14.0

Add to requirements.yml

  collections:
    - name: sensu.sensu_go
      version: 1.14.0

Description

Create, update or delete a Sensu Go VaultProvider secrets provider.

For more information, refer to the Sensu Go documentation at U(https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets-providers/).

Requirements

python >= 2.7

Usage examples

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- name: Delete a vault secrets provider
  sensu.sensu_go.secrets_provider_vault:
    name: my-vault
    state: absent

Inputs

tls:
description:
- TLS configuration for establishing connection with Vault server.
suboptions:
ca_cert:
description:
- Path to the certificate file of the trusted certificate authority.
type: str
client_cert:
description:
- Path to the client certificate file.
type: str
client_key:
description:
- Path to the client key file.
type: str
cname:
description:
- Canonical name for the client.
type: str
type: dict

auth:
description:
- Authentication parameters. Can define each of them with ENV as well.
suboptions:
api_key:
description:
- 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 I(auth.user) and I(auth.password) parameters.
- For more information about the API key, refer to the official Sensu documentation
at U(https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/).
type: str
version_added: 1.3.0
version_added_collection: sensu.sensu_go
ca_path:
description:
- 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 I(SENSU_CA_PATH) environment
variable.
type: path
version_added: 1.5.0
version_added_collection: sensu.sensu_go
password:
default: P@ssw0rd!
description:
- 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 I(auth.api_key) parameter is set.
type: str
url:
default: http://localhost:8080
description:
- Location of the Sensu backend API. If this is not set the value of the SENSU_URL
environment variable will be checked.
type: str
user:
default: admin
description:
- 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 I(auth.api_key) parameter is set.
type: str
verify:
default: true
description:
- Flag that controls the certificate validation.
- If you are using self-signed certificates, you can set this parameter to C(false).
- ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates
in production, see the I(auth.ca_path) parameter.
- It is also possible to set this parameter via the I(SENSU_VERIFY) environment
variable.
type: bool
version_added: 1.5.0
version_added_collection: sensu.sensu_go
type: dict

name:
description:
- 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 I(name) metadata attribute specification in the upstream docs on U(https://docs.sensu.io/sensu-go/latest/reference/)
for more details about valid names and other restrictions.
required: true
type: str

state:
choices:
- present
- absent
default: present
description:
- Target state of the Sensu object.
type: str

token:
description:
- Authentication token to use with Vault.
- Required if I(state) is C(present).
type: str

address:
description:
- Address of the Vault server.
- Required if I(state) is C(present).
type: str

timeout:
description:
- Timeout (in seconds) for connection to Vault server.
type: int

version:
choices:
- v1
- v2
description:
- Version of the Vault key/value store.
- Please refer to U(https://www.vaultproject.io/docs/secrets/kv) for additional information.
- Required if I(state) is C(present).
type: str

rate_limit:
description:
- Maximum number of secrets requests for per second.
type: float

burst_limit:
description:
- Maximum allowed number of secrets requests in a rate interval.
type: int

max_retries:
description:
- Maximum number of times to retry failed connections to Vault server.
type: int

Outputs

object:
  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
  type: dict

sensu.sensu_go.secrets_provider_vault (1.14.0) — module