sensu.sensu_go.backend role – Install, configure, and start Sensu Go backend
Note
This role 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.backend
.
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.
Entry point configure
– Configure Sensu Go backend
Synopsis
Write the Sensu Go backend configuration file and optionally copy the keys and certificates over.
Parameters
Parameter |
Comments |
---|---|
Path to the certificate used to secure the Sensu Go API. |
|
Path to the private key corresponding to the Sensu Go API certificate. Must be unencrypted. |
|
Path to the trusted certificate authority for the Sensu Go API certificates. |
|
Any option that is valid for the Sensu Go backend version we are installing. All valid options are listed at https://docs.sensu.io/sensu-go/latest/reference/backend/#configuration. Role copies the key-value pairs from the backend_config variable verbatim to the configuration file. This means that we must copy the key names exactly as they appear in the configuration reference. In a way, the backend_config variable should contain a properly indented copy of the |
|
Path to the certificate used for SSL/TLS connections to the dashboard. |
|
Path to the private key corresponding to the dashboard certificate. Must be unencrypted. |
|
Path to the certificate used for SSL/TLS connections to etcd. This is a client certificate. |
|
Path to the private key for the etcd client certificate file. Must be unencrypted. |
|
Path to the certificate used for SSL/TLS connections between peers. This will be used both for listening on the peer address as well as sending requests to other peers. |
|
Path to the peer certificate’s key. Must be unencrypted. |
|
Path to the trusted certificate authority for the peer certificates. |
|
Path to the trusted certificate authority for the etcd client certificates. |
Entry point main
– Install, configure, and start Sensu Go backend
Synopsis
Install, configure, and start the Sensu Go backend service and initialize it on the first run.
Parameters
Parameter |
Comments |
---|---|
Path to the certificate used to secure the Sensu Go API. |
|
Path to the private key corresponding to the Sensu Go API certificate. Must be unencrypted. |
|
Path to the trusted certificate authority for the Sensu Go API certificates. |
|
Any option that is valid for the Sensu Go backend version we are installing. All valid options are listed at https://docs.sensu.io/sensu-go/latest/reference/backend/#configuration. Role copies the key-value pairs from the backend_config variable verbatim to the configuration file. This means that we must copy the key names exactly as they appear in the configuration reference. In a way, the backend_config variable should contain a properly indented copy of the |
|
Package build to install. Can be any valid build string such as If the version variable is set to latest, this variable is ignored and the latest available build is installed. Default: |
|
Repository channel that serves as a source of packages. Visit the packagecloud site to find all available channels. Default: |
|
Initial admin password to create when initializing backend for the first time. Default: |
|
Initial admin user to create when initializing backend for the first time. Default: |
|
Path to the certificate used for SSL/TLS connections to the dashboard. |
|
Path to the private key corresponding to the dashboard certificate. Must be unencrypted. |
|
Path to the certificate used for SSL/TLS connections to etcd. This is a client certificate. |
|
Path to the private key for the etcd client certificate file. Must be unencrypted. |
|
Path to the certificate used for SSL/TLS connections between peers. This will be used both for listening on the peer address as well as sending requests to other peers. |
|
Path to the peer certificate’s key. Must be unencrypted. |
|
Path to the trusted certificate authority for the peer certificates. |
|
Path to the trusted certificate authority for the etcd client certificates. |
|
Package version to install. Can be any valid version string such as Default: |
Entry point start
– Start Sensu Go backend
Synopsis
Start the Sensu Go backend service and initialize it on the first run.
Parameters
Parameter |
Comments |
---|---|
Initial admin password to create when initializing backend for the first time. Default: |
|
Initial admin user to create when initializing backend for the first time. Default: |