asc.core.services_elastic role – Deploy the Elastic Stack monitoring server and enrol agents

Note

This role is part of the asc.core collection (version 2.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: git clone git@ssh.dev.azure.com:v3/cloudasc/iac-ansible-collections/core $HOME/.ansible/collections/ansible_collections/asc/core.

To use it in a playbook, specify: asc.core.services_elastic.

Entry point main – Deploy the Elastic Stack monitoring server and enrol agents

New in asc.core 1.0.0

Synopsis

  • Deploys a Dockerised Elastic Stack - an Elasticsearch cluster, Kibana and a Fleet server - on a dedicated VM, with its data held on a separate managed data disk and TLS between the nodes.

  • When the role runs against any other host in the environment it installs the Elastic Agent and enrols it into Fleet, so logs and metrics flow back to this server.

  • A Guacamole connection to Kibana is created for the users tagged for access in users.csv.

Parameters

Parameter

Comments

linux_temp_path

string

added in asc.core 2.0.0

Working directory on Linux hosts for the Elastic agent installer.

Default: "/opt/maintenance"

services_elastic

dictionary

‘services_elastic’ role configuration

elastic_license

string

License type to use

basic for the basic license

trial for the trial license - only valid for 30 days

Choices:

  • "basic"

  • "trial" ← (default)

elastic_password

string

Password for the Elastic user

Default: "randomPassword-42"

elastic_path

path

Path to save the docker configuration and volumes on the server

Default: "/opt/elastic"

elastic_version

string

Version of the Elastic stack to install

Default: "8.2.0"

enabled

boolean

Whether to enable the Elastic stack

Choices:

  • false ← (default)

  • true

kibana_password

string

Password for the Kibana user

Default: "randomPassword-42"

mountpoint

path

Mountpoint for the extra data disk

Default: "/opt"

vm_disk_size

integer

Size of the extra data disk (in GB)

Default: 128

vm_name

string

Name of the VM to deploy

Default: "elastic"

vm_size

string

Size of the VM to deploy (Azure VM size)

Default: "Standard_D2s_v3"

windows_temp_path

string

added in asc.core 2.0.0

Working directory on Windows hosts for the Elastic agent installer.

Default: "C:\\MAINTENANCE"

Authors

  • Ignace De Cock