sensu.sensu_go.backend – Install, configure, and start Sensu Go backend
Note
This role is part of the sensu.sensu_go collection (version 1.12.0).
To install it use: ansible-galaxy collection install sensu.sensu_go.
To use it in a playbook, specify: sensu.sensu_go.backend.
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 | Choices/Defaults | Comments |
|---|---|---|
| api_cert_file
string
|
Path to the certificate used to secure the Sensu Go API.
|
|
| api_key_file
string
|
Path to the private key corresponding to the Sensu Go API certificate. Must be unencrypted.
|
|
| api_trusted_ca_file
string
|
Path to the trusted certificate authority for the Sensu Go API certificates.
|
|
| backend_config
dictionary
|
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 /etc/sensu/backend.yml file.
|
|
| dashboard_cert_file
string
|
Path to the certificate used for SSL/TLS connections to the dashboard.
|
|
| dashboard_key_file
string
|
Path to the private key corresponding to the dashboard certificate. Must be unencrypted.
|
|
| etcd_cert_file
string
|
Path to the certificate used for SSL/TLS connections to etcd. This is a client certificate.
|
|
| etcd_key_file
string
|
Path to the private key for the etcd client certificate file. Must be unencrypted.
|
|
| etcd_peer_cert_file
string
|
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.
|
|
| etcd_peer_key_file
string
|
Path to the peer certificate's key. Must be unencrypted.
|
|
| etcd_peer_trusted_ca_file
string
|
Path to the trusted certificate authority for the peer certificates.
|
|
| etcd_trusted_ca_file
string
|
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 | Choices/Defaults | Comments |
|---|---|---|
| api_cert_file
string
|
Path to the certificate used to secure the Sensu Go API.
|
|
| api_key_file
string
|
Path to the private key corresponding to the Sensu Go API certificate. Must be unencrypted.
|
|
| api_trusted_ca_file
string
|
Path to the trusted certificate authority for the Sensu Go API certificates.
|
|
| backend_config
dictionary
|
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 /etc/sensu/backend.yml file.
|
|
| build
string
|
Default:
"latest"
|
Package build to install.
Can be any valid build string such as
8290 or a special value latest.
If the version variable is set to latest, this variable is ignored and the latest available build is installed.
|
| channel
string
|
Default:
"stable"
|
Repository channel that serves as a source of packages.
Visit the packagecloud site to find all available channels.
|
| cluster_admin_password
string
|
Default:
"P@ssw0rd!"
|
Initial admin password to create when initializing backend for the first time.
|
| cluster_admin_username
string
|
Default:
"admin"
|
Initial admin user to create when initializing backend for the first time.
|
| dashboard_cert_file
string
|
Path to the certificate used for SSL/TLS connections to the dashboard.
|
|
| dashboard_key_file
string
|
Path to the private key corresponding to the dashboard certificate. Must be unencrypted.
|
|
| etcd_cert_file
string
|
Path to the certificate used for SSL/TLS connections to etcd. This is a client certificate.
|
|
| etcd_key_file
string
|
Path to the private key for the etcd client certificate file. Must be unencrypted.
|
|
| etcd_peer_cert_file
string
|
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.
|
|
| etcd_peer_key_file
string
|
Path to the peer certificate's key. Must be unencrypted.
|
|
| etcd_peer_trusted_ca_file
string
|
Path to the trusted certificate authority for the peer certificates.
|
|
| etcd_trusted_ca_file
string
|
Path to the trusted certificate authority for the etcd client certificates.
|
|
| version
string
|
Default:
"latest"
|
Package version to install.
Can be any valid version string such as 6.2.5 or special value latest.
|
Entry point start – Start Sensu Go backend
Synopsis
- Start the Sensu Go backend service and initialize it on the first run.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| cluster_admin_password
string
|
Default:
"P@ssw0rd!"
|
Initial admin password to create when initializing backend for the first time.
|
| cluster_admin_username
string
|
Default:
"admin"
|
Initial admin user to create when initializing backend for the first time.
|
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/backend_role.html