Параметры ELK#

Параметры создания сервиса#

Эти параметры указываются в качестве parameters в методе CreateService.

При создании нового сервиса нужно обязательно указать параметры, отмеченные как Необходимые.

Если выбранная версия ELK поддерживает также другие параметры, то их можно задать внутри параметра options.

version#

Устанавливаемая версия.

Необходимо

Тип данных

Допустимые значения

Да

String

7.11.2
7.12.1
7.13.1
7.14.2
7.15.2
7.16.3
7.17.4
8.0.1
8.1.3
8.2.2

password#

Пароль пользователя Elasticsearch. Если пароль задан, то для входа в Kibana необходимо пройти аутентификацию.

Необходимо

Тип данных

Допустимые значения

Нет

String

Строка длиной от 8 до 128 символов. Не должна содержать символы -, !, :, ;, %, ', ", ` и \

allow_anonymous#

Разрешить анонимный доступ к Kibana.

Необходимо

Тип данных

Допустимые значения

По умолчанию

Нет

Boolean

true
false

false

anonymous_role#

Роль для анонимного доступа.

Необходимо

Тип данных

Допустимые значения

По умолчанию

При указании параметра allow_anonymous = true

Array of strings

viewer
editor

viewer

monitoring#

Подключение к сервису мониторинга.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

По умолчанию

Для всех сервисов, кроме Prometheus

Есть

Boolean

true
false

false

monitor_by#

Идентификатор сервиса мониторинга. Указанный сервис должен быть развёрнут в том же проекте, что и текущий сервис.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Да, если передан параметр monitoring = true. Если monitoring = false, передача параметра невозможна

Есть

String

ID сервиса мониторинга, расположенного в том же VPC, что и текущий сервис

monitoring_labels#

Метки, которые будут назначены метрикам мониторируемого сервиса в сервисе мониторинга.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет. Если monitoring = false, передача параметра невозможна

Есть

Dict

Имя метки может содержать цифры, латинские буквы, символ подчёркивания. Значение метки может содержать любые ASCII-символы.

options#

Контейнер для других параметров ELK.

Примечание

Если имя параметра включает точку, то его нельзя передать в контейнере для дополнительных параметров. Свяжитесь с технической поддержкой, если вам необходимо использовать такой параметр.

Необходимо

Тип данных

Допустимые значения

Нет

Dict

N/A

Параметры создания и редактирования хранилища снимков#

Эти параметры указываются в качестве parameters в методе CreateElasticsearchSnapshotRepository. При добавлении хранилища снимков нужно обязательно указать все параметры, отмеченные как Необходимые. При этом параметр Enabled должен быть всегда равным false, так как при добавлении хранилище снимков может находится только в отключённом состоянии. Чтобы хранилище снимков стало доступным в сервисе, его надо подключить явным образом с помощью метода EnableElasticsearchSnapshotRepository.

Для отключения хранилища снимков следует использовать метод DisableElasticsearchSnapshotRepository, после чего оно перестанет быть доступным в сервисе.

Удалить хранилище снимков можно, воспользовавшись методом DeleteElasticsearchSnapshotRepository. Перед удалением его необходимо отключить. При попытке удалить подключённое хранилище снимков будет выведено сообщение об ошибке, хранилище снимков при этом не будет удалено.

Если параметр fromExistingService задан равным false, то будет создано новое хранилище снимков. Для этого необходимо указать параметры bucketName, userLogin и directoryName.

Если параметр fromExistingService задан равным true, то будет добавлено существующее хранилище снимков. Для этого в параметре recoveryServiceId необходимо указать идентификатор сервиса Elasticsearch или ELK, к которому подключено это хранилище. При этом версии сервисов должны быть совместимы между собой, чтобы данные можно было восстановить из снимков. Хранилище снимков от существующего сервиса будет добавлено в режиме только для чтения и может быть использовано только для восстановления данных из снимка.

Таблицу совместимости версий можно найти в официальной документации Elasticsearch.

Получить список установленных сервисов Elasticsearch или ELK, подходящих для восстановления целевого сервиса можно, воспользовавшись методом ListElasticsearchServicesSuitableForRecovery.

Получить информацию о подключённом к сервису хранилище можно, воспользовавшись методом ListElasticsearchSnapshotRepository.

enabled#

Указывает, подключено ли хранилище снимков.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Да

Есть

Boolean

true
false

fromExistingService#

Указывает, создаётся ли новое хранилище или добавляется хранилище существующего сервиса Elasticsearch или ELK.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Да

Нет

Boolean

true
false

bucketName#

Имя бакета в объектном хранилище. Параметр применим и необходим, только когда fromExistingService равен false.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Нет

String

Имя существующего бакета в объектном хранилище, к которому у пользователя есть доступ.

userLogin#

Логин пользователя с правами на запись в бакет объектного хранилища. Параметр применим и необходим, только когда fromExistingService равен false.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Нет

String

Имя существующего пользователя с правами на запись в бакет объектного хранилища.

directoryName#

Имя каталога в объектном хранилище. Параметр применим и необходим, только когда fromExistingService равен false.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Нет

String

Допустимое имя каталога.

recoveryServiceId#

Идентификатор существующего сервиса Elasticsearch или ELK, из хранилища которого необходимо восстановить данные. Параметр применим и необходим, только когда fromExistingService равен true.

Необходимо

Возможность редактирования

Тип данных

Допустимые значения

Нет

Нет

String

Идентификатор существующего сервиса Elasticsearch или ELK, из хранилища которого необходимо восстановить данные.