Справочник конфигурации

В этом разделе описаны параметры конфигурации Тarantool Cluster Manager.

Параметры конфигурации TCM делятся на следующие секции:

• cluster
• http
• log
• storage
• addon
• limits
• security
• mode
• feature
• initial
• migrations
• default-cluster

Секции cluster определяет параметры взаимодействия TCM с подключенными кластерами Tarantool.

• cluster.connection-rate-limit
• cluster.tarantool-timeout
• cluster.tarantool-ping-timeout
• cluster.tt-command
• cluster.refresh-state-period
• cluster.refresh-state-timeout
• cluster.discovery-period
• cluster.sharding-index
• cluster.skew-time
• cluster.fragmentation-threshold
• cluster.connectivity-check-timeout
• cluster.backoff-initial-delay
• cluster.backoff-max-delay
• cluster.backoff-failure-threshold
• cluster.connection-pool-check-timeout
• cluster.watcher-retry-delay
• cluster.stats-max-space-length
• cluster.stats-timeout

Ограничение скорости подключения к экземплярам Tarantool.

Тип: uint

Значение по умолчанию: 512

Переменная окружения: TCM_CLUSTER_CONNECTION_RATE_LIMIT

Параметр командной строки: –cluster.connection-rate-limit

Время ожидания получения ответа от экземпляров Tarantool.

Тип: time.Duration

Значение по умолчанию: 10s

Переменная окружения: TCM_CLUSTER_TARANTOOL_TIMEOUT

Параметр командной строки: –cluster.tarantool-timeout

Время ожидания получения ответа на ping от экземпляров Tarantool.

Тип: time.Duration

Значение по умолчанию: 5s

Переменная окружения: TCM_CLUSTER_TARANTOOL_PING_TIMEOUT

Параметр командной строки: –cluster.tarantool-ping-timeout

Команда для запуска утилиты tt на хостах с экземплярами кластера.

Тип: string

Значение по умолчанию: tt

Переменная окружения: TCM_CLUSTER_TT_COMMAND

Параметр командной строки: –cluster.tt-command

Интервал времени для обновления состояния экземпляров кластера на Stateboard.

Тип: time.Duration

Значение по умолчанию: 5s

Переменная окружения: TCM_CLUSTER_REFRESH_STATE_PERIOD

Параметр командной строки: –cluster.refresh-state-period

Ограничение времени на обновление состояния экземпляра. При достижении этого ограничения выводится сообщение об ошибке.

Тип: time.Duration

Значение по умолчанию: 4s

Переменная окружения: TCM_CLUSTER_REFRESH_STATE_TIMEOUT

Параметр командной строки: –cluster.refresh-state-timeout

Интервал времени для проверки лидерства в наборах реплик.

Тип: time.Duration

Значение по умолчанию: 4s

Переменная окружения: TCM_CLUSTER_DISCOVERY_PERIOD

Параметр командной строки: –cluster.discovery-period

Имя поля спейса, используемое в качестве ключа шардирования.

Тип: string

Значение по умолчанию: bucket_id

Переменная окружения: TCM_CLUSTER_SHARDING_INDEX

Параметр командной строки: –cluster.sharding-index

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

Тип: time.Duration

Значение по умолчанию: 30s

Переменная окружения: TCM_CLUSTER_SKEW_TIME

Параметр командной строки: –cluster.skew-time

Количество выделенных слэбов, указывающее на высокую фрагментацию памяти. При достижении этого числа выводится предупреждение.

См. также: engines-memtx

Тип: int

Значение по умолчанию: 40

Переменная окружения: TCM_CLUSTER_FRAGMENTATION_THRESHOLD

Параметр командной строки: –cluster.fragmentation-threshold

Максимальное время ожидания ответа от узла кластера при проверке доступности. Если узел не отвечает в течение этого времени, проверка считается неудачной.

Тип: time.Duration

Значение по умолчанию: 3s

Переменная окружения: TCM_CLUSTER_CONNECTIVITY_CHECK_TIMEOUT

Параметр командной строки: –cluster.connectivity-check-timeout

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

Тип: time.Duration

Значение по умолчанию: 1s

Переменная окружения: TCM_CLUSTER_BACKOFF_INITIAL_DELAY

Параметр командной строки: –cluster.backoff-initial-delay

Максимальная задержка между попытками переподключения. После достижения этой задержки ее рост прекращается.

Тип: time.Duration

Значение по умолчанию: 30s

Переменная окружения: TCM_CLUSTER_BACKOFF_MAX_DELAY

Параметр командной строки: –cluster.backoff-max-delay

Количество неудачных попыток подключения, после которого TCM прекращает дальнейшие попытки и помечает узел как недоступный.

Тип: int

Значение по умолчанию: 3

Переменная окружения: TCM_CLUSTER_BACKOFF_FAILURE_THRESHOLD

Параметр командной строки: –cluster.backoff-failure-threshold

Максимальное время ожидания ответа на подключение от пула к узлу кластера. Используется для проверки актуальности подключения.

Тип: time.Duration

Значение по умолчанию: 3s

Переменная окружения: TCM_CLUSTER_CONNECTION_POOL_CHECK_TIMEOUT

Параметр командной строки: –cluster.connection-pool-check-timeout

Задержка между попытками переподключения к системе наблюдения (watch) после сбоя.

Тип: time.Duration

Значение по умолчанию: 1s

Переменная окружения: TCM_CLUSTER_WATCHER_RETRY_DELAY

Параметр командной строки: –cluster.watcher-retry-delay

Максимальное количество записей в буфере статистики, которое сохраняется перед отправкой или обработкой.

Тип: int

Значение по умолчанию: 10000

Переменная окружения: TCM_CLUSTER_STATS_MAX_SPACE_LENGTH

Параметр командной строки: –cluster.stats-max-space-length

Максимальное время ожидания ответа от узла при запросе статистики. Если узел не отвечает в течение этого времени, запрос считается неудачным.

Тип: time.Duration

Значение по умолчанию: 1m

Переменная окружения: TCM_CLUSTER_STATS_TIMEOUT

Параметр командной строки: –cluster.stats-timeout

Секция http определяет параметры HTTP-соединений между TCM и клиентами.

• http.network
• http.host
• http.port
• http.request-size
• http.websocket.read-buffer-size
• http.websocket.write-buffer-size
• http.websocket.keepalive-ping-interval
• http.websocket.handshake-timeout
• http.websocket.init-timeout
• http.websession-cookie.name
• http.websession-cookie.path
• http.websession-cookie.domain
• http.websession-cookie.ttl
• http.websession-cookie.secure
• http.websession-cookie.http-only
• http.websession-cookie.same-site
• http.websession-cookie.cleanup-period
• http.cors.enabled
• http.cors.allowed-origins
• http.cors.allowed-methods
• http.cors.allowed-headers
• http.cors.exposed-headers
• http.cors.allow-credentials
• http.cors.debug
• http.tls.enabled
• http.tls.cert-file
• http.tls.key-file
• http.tls.server-name
• http.tls.min-version
• http.tls.max-version
• http.tls.curve-preferences
• http.tls.cipher-suites
• http.read-timeout
• http.read-header-timeout
• http.write-timeout
• http.idle-timeout
• http.disable-general-options-handler
• http.max-header-bytes
• http.api-timeout
• http.api-update-interval
• http.frontend-dir
• http.show-stack-trace
• http.trace
• http.max-static-size
• http.graphql.complexity

Схема адресации, используемая TCM.

Возможные значения:

• tcp: IPv4-адрес
• tcp6: IPv6-адрес
• unix: доменный сокет Unix

Тип: string

Значение по умолчанию: tcp

Переменная окружения: TCM_HTTP_NETWORK

Параметр командной строки: –http.network

Имя хоста, на котором работает TCM.

Тип: string

Значение по умолчанию: 127.0.0.1

Переменная окружения: TCM_HTTP_HOST

Параметр командной строки: –http.host

Порт, на котором работает TCM.

Тип: int

Значение по умолчанию: 8080

Переменная окружения: TCM_HTTP_PORT

Параметр командной строки: –http.port

Максимальный размер (в байтах) HTTP-запроса клиента к TCM.

Тип: int64

Значение по умолчанию: 1572864

Переменная окружения: TCM_HTTP_REQUEST_SIZE

Параметр командной строки: –http.request-size

Размер (в байтах) буфера чтения для соединений WebSocket.

Тип: int

Значение по умолчанию: 16384

Переменная окружения: TCM_HTTP_WEBSOCKET_READ_BUFFER_SIZE

Параметр командной строки: –http.websocket.read-buffer-size

Размер (в байтах) буфера записи для соединений WebSocket.

Тип: int

Значение по умолчанию: 16384

Переменная окружения: TCM_HTTP_WEBSOCKET_WRITE_BUFFER_SIZE

Параметр командной строки: –http.websocket.write-buffer-size

Интервал времени для отправки keepalive-пингов WebSocket.

Тип: time.Duration

Значение по умолчанию: 20s

Переменная окружения: TCM_HTTP_WEBSOCKET_KEEPALIVE_PING_INTERVAL

Параметр командной строки: –http.websocket.keepalive-ping-interval

Ограничение по времени для завершения процедуры установления соединения WebSocket с клиентом.

Тип: time.Duration

Значение по умолчанию: 10s

Переменная окружения: TCM_HTTP_WEBSOCKET_HANDSHAKE_TIMEOUT

Параметр командной строки: –http.websocket.handshake-timeout

Ограничение по времени для установления соединения WebSocket с клиентом.

Тип: time.Duration

Значение по умолчанию: 15s

Переменная окружения: TCM_HTTP_WEBSOCKET_INIT_TIMEOUT

Параметр командной строки: –http.websocket.init-timeout

Имя cookie, которое TCM отправляет клиентам.

Это значение используется в качестве имени cookie в HTTP-заголовке ответа Set-Cookie.

Тип: string

Значение по умолчанию: tcm

Переменная окружения: TCM_HTTP_WEBSESSION_COOKIE_NAME

Параметр командной строки: –-http.websession-cookie.name

Путь URL, который должен присутствовать в запрошенном URL для отправки cookie.

Это значение используется в атрибуте Path HTTP-заголовка ответа Set-Cookie.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_HTTP_WEBSESSION_COOKIE_PATH

Параметр командной строки: –-http.websession-cookie.path

Домен, на который можно отправлять cookie.

Это значение используется в атрибуте Domain HTTP-заголовка ответа Set-Cookie.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_HTTP_WEBSESSION_COOKIE_DOMAIN

Параметр командной строки: –-http.websession-cookie.domain

Максимальное время жизни cookie TCM.

Это значение используется в атрибуте Max-Age HTTP-заголовка ответа Set-Cookie.

Тип: time.Duration

Значение по умолчанию: 2h0m0s

Переменная окружения: TCM_HTTP_WEBSESSION_COOKIE_TTL

Параметр командной строки: –-http.websession-cookie.ttl

Указывает, может ли cookie отправляться только по протоколу HTTPS. В этом случае cookie никогда не отправляется по незашифрованному HTTP, что предотвращает атаки типа «человек посередине» (man-in-the-middle).

При значении true атрибут Secure добавляется в HTTP-заголовок ответа Set-Cookie.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_HTTP_WEBSESSION_COOKIE_SECURE

Параметр командной строки: –-http.websession-cookie.secure

Указывает, что доступ к cookie невозможен через JavaScript API Document.cookie. Это помогает предотвратить атаки межсайтовой обработки скриптов (XSS).

При значении true атрибут HttpOnly добавляется в HTTP-заголовок ответа Set-Cookie.

Тип: bool

Значение по умолчанию: true

Переменная окружения: TCM_HTTP_WEBSESSION_COOKIE_HTTP_ONLY

Параметр командной строки: –-http.websession-cookie.http-only

Указывает, можно ли отправлять cookie TCM вместе с межсайтовыми запросами. Возможные значения - константы http.SameSite из Go:

• SameSiteDefaultMode
• SameSiteLaxMode
• SameSiteStrictMode
• SameSiteNoneMode

Подробнее о режимах SameSite см. в документации заголовка Set-Cookie в веб-документации MDN.

Это значение используется в атрибуте SameSite HTTP-заголовка ответа Set-Cookie.

Тип: http.SameSite

Значение по умолчанию: SameSiteDefaultMode

Переменная окружения: TCM_HTTP_WEBSESSION_COOKIE_SAME_SITE

Параметр командной строки: –-http.websession-cookie.same-site

Интервал между запусками очистки устаревших сессий. Сессия считается устаревшей, если она не обновлялась в течение времени, заданного в переменной http.websession-cookie.ttl.

Тип: time.Duration

Значение по умолчанию: 2m0s

Переменная окружения: TCM_HTTP_WEBSESSION_COOKIE_CLEANUP_PERIOD

Флаг командной строки: –http.websession-cookie.cleanup-period

Указывает, используется ли механизм Cross-Origin Resource Sharing (CORS).

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_HTTP_CORS_ENABLED

Параметр командной строки: –http.cors.enabled

Источники, с которыми может совместно использоваться HTTP-ответ, разделенные точкой с запятой.

Указанные значения отправляются в HTTP-заголовках ответа Access-Control-Allow-Origin.

Тип: []string

Значение по умолчанию: []

Переменная окружения: TCM_HTTP_CORS_ALLOWED_ORIGINS

Параметр командной строки: –http.cors.allowed-origins

Методы HTTP-запросов, разрешенные при доступе к ресурсу, разделенные точкой с запятой.

Указанные значения отправляются в HTTP-заголовке Access-Control-Allow-Methods ответа на предварительный CORS-запрос.

Тип: []string

Значение по умолчанию: []

Переменная окружения: TCM_HTTP_CORS_ALLOWED_METHODS

Параметр командной строки: –http.cors.allowed-methods

HTTP-заголовки, разрешенные при выполнении фактического запроса, разделенные точкой с запятой.

Указанные значения отправляются в HTTP-заголовке Access-Control-Allow-Headers ответа на предварительный CORS-запрос.

Тип: []string

Значение по умолчанию: []

Переменная окружения: TCM_HTTP_CORS_ALLOWED_HEADERS

Параметр командной строки: –http.cors.allowed-headers

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

Указанные значения отправляются в HTTP-заголовках ответа Access-Control-Expose-Headers.

Тип: []string

Значение по умолчанию: []

Переменная окружения: TCM_HTTP_CORS_EXPOSED_HEADERS

Параметр командной строки: –http.cors.exposed-headers

Определяет, следует ли предоставлять ответному сообщению доступ к JavaScript-коду фронтенда, когда режим учетных данных запроса имеет значение include.

При значении true отправляется HTTP-заголовок ответа Access-Control-Allow-Credentials.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_HTTP_CORS_ALLOW_CREDENTIALS

Параметр командной строки: –http.cors.allow-credentials

Для целей отладки.

Тип: bool

Значение по умолчанию: false

Указывает, включен ли TLS для клиентских подключений к TCM.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_HTTP_TLS_ENABLED

Параметр командной строки: –http.tls.enabled

Путь к файлу TLS-сертификата. Обязателен при включенном TLS.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_HTTP_TLS_CERT_FILE

Параметр командной строки: –http.tls.cert-file

Путь к файлу закрытого ключа TLS. Обязателен при включенном TLS.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_HTTP_TLS_KEY_FILE

Параметр командной строки: –http.tls.key-file

TLS-сервер.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_HTTP_TLS_SERVER_NAME

Параметр командной строки: –http.tls.server-name

Минимальная версия протокола TLS.

Тип: uint16

Значение по умолчанию: 0

Переменная окружения: TCM_HTTP_TLS_MIN_VERSION

Параметр командной строки: –http.tls.min-version

Максимальная версия протокола TLS.

Тип: uint16

Значение по умолчанию: 0

Переменная окружения: TCM_HTTP_TLS_MAX_VERSION

Параметр командной строки: –http.tls.max-version

Эллиптические кривые, используемые для TLS-соединений. Возможные значения - константы tls.CurveID из Go:

• CurveP256
• CurveP384
• CurveP521
• X25519

Тип: []tls.CurveID

Значение по умолчанию: []

Переменная окружения: TCM_HTTP_TLS_CURVE_PREFERENCES

Параметр командной строки: –http.tls.curve-preferences

Включенные наборы шифров TLS. Поддерживаемые шифры:

• Наборы шифров TLS 1.0 - 1.2:

  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

• Наборы шифров TLS 1.3:

• TLS_AES_128_GCM_SHA256

• TLS_AES_256_GCM_SHA384

• TLS_CHACHA20_POLY1305_SHA256

• TLS_FALLBACK_SCSV не является стандартным набором шифров, а служит индикатором того, что клиент выполняет откат версии

• TLS_FALLBACK_SCSV uint16 = 0x5600

• TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305 = TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256

• TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305 = TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA25

Подробная информация о шифрах приведена в документации по константам tls.TLS_* из Golang.

В примере ниже показана настройка наборов шифров:

 
http:  tls:    cipher-suites:      - TLS_AES_256_GCM_SHA384      - TLS_AES_128_GCM_SHA256      - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384      - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256      - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384      - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256      - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384      - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256

Тип: []uint16

Значение по умолчанию: []

Переменная окружения: TCM_HTTP_TLS_CIPHER_SUITES

Параметр командной строки: –http.tls.cipher-suites

Время ожидания чтения входящего запроса.

Тип: time.Duration

Значение по умолчанию: 30s

Переменная окружения: TCM_HTTP_READ_TIMEOUT

Параметр командной строки: –http.read-timeout

Время ожидания чтения заголовков входящего запроса.

Тип: time.Duration

Значение по умолчанию: 30s

Переменная окружения: TCM_HTTP_READ_HEADER_TIMEOUT

Параметр командной строки: –http.read-header-timeout

Время ожидания записи ответа.

Тип: time.Duration

Значение по умолчанию: 30s

Переменная окружения: TCM_HTTP_WRITE_TIMEOUT

Параметр командной строки: –http.write-timeout

Время ожидания для неактивных соединений.

Тип: time.Duration

Значение по умолчанию: 30s

Переменная окружения: TCM_HTTP_IDLE_TIMEOUT

Параметр командной строки: –http.idle-timeout

Определяет, разрешены ли клиентские запросы с HTTP-методом OPTIONS.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_HTTP_DISABLE_GENERAL_OPTIONS_HANDLER

Параметр командной строки: –http.disable-general-options-handler

Максимальный размер (в байтах) заголовка в запросе клиента к TCM.

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_HTTP_MAX_HEADER_BYTES

Параметр командной строки: –http.max-header-bytes

Время ожидания обновления Stateboard.

Тип: time.Duration

Значение по умолчанию: 8s

Переменная окружения: TCM_HTTP_API_TIMEOUT

Параметр командной строки: –http.api-timeout

Интервал обновления Stateboard.

Тип: time.Duration

Значение по умолчанию: 5s

Переменная окружения: TCM_HTTP_API_UPDATE_INTERVAL

Параметр командной строки: –http.api-update-interval

Каталог с пользовательскими файлами фронтенда TCM (для целей разработки).

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_HTTP_FRONTEND_DIR

Параметр командной строки: –http.frontend-dir

Определяет, отображаются ли трассировки стека ошибок (error stack trace) в веб-интерфейсе.

Тип: bool

Значение по умолчанию: true

Переменная окружения: TCM_HTTP_SHOW_STACK_TRACE

Параметр командной строки: –http.show-stack-trace

Определяет, записывается ли вся информация о трассировке запросов в журналы.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_HTTP_TRACE

Параметр командной строки: –http.trace

Максимальный размер (в байтах) статического содержимого, передаваемого TCM.

Тип: int

Значение по умолчанию: 104857600

Переменная окружения: TCM_HTTP_MAX_STATIC_SIZE

Параметр командной строки: –http.max-static-size

Максимальная сложность GraphQL-запросов, обрабатываемых TCM. Если это значение превышено, TCM возвращает ошибку.

Тип: int

Значение по умолчанию: 40

Переменная окружения: TCM_HTTP_GRAPHQL_COMPLEXITY

Параметр командной строки: –http.graphql.complexity

The log section defines the TCM logging parameters.

• log.default.add-source
• log.default.show-stack-trace
• log.default.level
• log.default.format
• log.default.output
• log.default.no-colorized
• log.default.file.name
• log.default.file.maxsize
• log.default.file.maxage
• log.default.file.maxbackups
• log.default.file.compress
• log.default.syslog.protocol
• log.default.syslog.output
• log.default.syslog.priority
• log.default.syslog.facility
• log.default.syslog.tag
• log.default.syslog.timeout
• log.outputs

Включать ли исходные файлы в журнал TCM.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_LOG_DEFAULT_ADD_SOURCE

Параметр командной строки: --log.default.add-source

Включать ли данные трассировки стека (stack trace) в журнал TCM.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_LOG_DEFAULT_SHOW_STACK_TRACE

Параметр командной строки: --log.default.show-stack-trace

Уровень журналирования TCM по умолчанию.

Возможные значения:

• VERBOSE
• INFO
• WARN
• ALARM

Тип: string

Значение по умолчанию: INFO

Переменная окружения: TCM_LOG_DEFAULT_LEVEL

Параметр командной строки: --log.default.level

Формат записей в журнале TCM.

Возможные значения:

• struct
• json

Тип: string

Значение по умолчанию: struct

Переменная окружения: TCM_LOG_DEFAULT_FORMAT

Параметр командной строки: --log.default.format

Вариант вывода для журанала TCM.

Возможные значения:

• stdout
• stderr
• file
• syslog

Тип: string

Значение по умолчанию: stdout

Переменная окружения: TCM_LOG_DEFAULT_OUTPUT

Параметр командной строки: --log.default.output

Применять ли цветовую маркировку при выводе журнала в stdout.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_LOG_DEFAULT_NO_COLORIZED

Параметр командной строки: --log.default.no-colorized

Имя файла журнала TCM.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_LOG_DEFAULT_FILE_NAME

Параметр командной строки: --log.default.file.name

Максимальный размер файла журнала TCM (в байтах).

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_LOG_DEFAULT_FILE_MAXSIZE

Параметр командной строки: --log.default.file.maxsize

Максимальное время хранения файла журнала TCM (в днях).

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_LOG_DEFAULT_FILE_MAXAGE

Параметр командной строки: --log.default.file.maxage

Максимальное количество резервных копий журнала TCM.

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_LOG_DEFAULT_FILE_MAXBACKUPS

Параметр командной строки: --log.default.file.maxbackups

Применять ли сжатие к файлам журнала TCM при ротации.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_LOG_DEFAULT_FILE_COMPRESS

Параметр командной строки: --log.default.file.compress

Сетевой протокол, используемый для подключения к серверу syslog. Обычно это tcp, udp или unix. Все возможные значения указаны в документации Go net.Dial.

Тип: string

Значение по умолчанию: tcp

Переменная окружения: TCM_LOG_DEFAULT_SYSLOG_PROTOCOL

Параметр командной строки: --log.default.syslog.protocol

URI сервера syslog.

Тип: string

Значение по умолчанию: 127.0.0.1:5514

Переменная окружения: TCM_LOG_DEFAULT_SYSLOG_OUTPUT

Параметр командной строки: --log.default.syslog.output

Уровень строгости (severity) сервера syslog.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_LOG_DEFAULT_SYSLOG_PRIORITY

Параметр командной строки: --log.default.syslog.priority

Средство ведения (facility) журнала в syslog.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_LOG_DEFAULT_SYSLOG_FACILITY

Параметр командной строки: --log.default.syslog.facility

Тег для syslog.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_LOG_DEFAULT_SYSLOG_TAG

Параметр командной строки: --log.default.syslog.tag

Время ожидания для подключения к серверу syslog.

Тип: time.Duration

Значение по умолчанию: 10s

Переменная окружения: TCM_LOG_DEFAULT_SYSLOG_TIMEOUT

Параметр командной строки: --log.default.syslog.timeout

Массив выходных данных журнала, которые TCM использует в дополнение к выходным данным по умолчанию, которые определяются параметрами log.default.*. Каждый элемент массива может включать параметры группы log.default. Если параметр пропущен, его значение берется из файла log.default.

Тип: []LogOuputConfig

Значение по умолчанию: []

Переменная окружения: TCM_LOG_OUTPUTS

Параметр командной строки: --log-outputs

Секция storage определяет параметры хранилища TCM.

• storage.provider

Параметры хранилища etcd:

• storage.etcd.prefix
• storage.etcd.endpoints
• storage.etcd.dial-timeout
• storage.etcd.auto-sync-interval
• storage.etcd.dial-keep-alive-time
• storage.etcd.dial-keep-alive-timeout
• storage.etcd.bootstrap-timeout
• storage.etcd.max-call-send-msg-size
• storage.etcd.username
• storage.etcd.password
• storage.etcd.password-file
• storage.etcd.tls.enabled
• storage.etcd.tls.auto
• storage.etcd.tls.cert-file
• storage.etcd.tls.key-file
• storage.etcd.tls.trusted-ca-file
• storage.etcd.tls.client-cert-auth
• storage.etcd.tls.crl-file
• storage.etcd.tls.insecure-skip-verify
• storage.etcd.tls.skip-client-san-verify
• storage.etcd.tls.server-name
• storage.etcd.tls.cipher-suites
• storage.etcd.tls.allowed-cn
• storage.etcd.tls.allowed-hostname
• storage.etcd.tls.empty-cn
• storage.etcd.permit-without-stream
• storage.etcd.embed.enabled
• storage.etcd.embed.endpoints
• storage.etcd.embed.advertises
• storage.etcd.embed.tls.enabled
• storage.etcd.embed.tls.auto
• storage.etcd.embed.tls.cert-file
• storage.etcd.embed.tls.key-file
• storage.etcd.embed.tls.trusted-ca-file
• storage.etcd.embed.tls.client-cert-auth
• storage.etcd.embed.tls.crl-file
• storage.etcd.embed.tls.insecure-skip-verify
• storage.etcd.embed.tls.skip-client-san-verify
• storage.etcd.embed.tls.server-name
• storage.etcd.embed.tls.cipher-suites
• storage.etcd.embed.tls.allowed-cn
• storage.etcd.embed.tls.allowed-hostname
• storage.etcd.embed.tls.empty-cn
• storage.etcd.embed.peer-endpoints
• storage.etcd.embed.peer-advertises
• storage.etcd.embed.peer-tls.enabled
• storage.etcd.embed.peer-tls.auto
• storage.etcd.embed.peer-tls.cert-file
• storage.etcd.embed.peer-tls.key-file
• storage.etcd.embed.peer-tls.trusted-ca-file
• storage.etcd.embed.peer-tls.client-cert-auth
• storage.etcd.embed.peer-tls.crl-file
• storage.etcd.embed.peer-tls.insecure-skip-verify
• storage.etcd.embed.peer-tls.skip-client-san-verify
• storage.etcd.embed.peer-tls.server-name
• storage.etcd.embed.peer-tls.cipher-suites
• storage.etcd.embed.peer-tls.allowed-cn
• storage.etcd.embed.peer-tls.allowed-hostname
• storage.etcd.embed.peer-tls.empty-cn
• storage.etcd.embed.grpc-keep-alive-timeout
• storage.etcd.embed.grpc-keep-alive-interval
• storage.etcd.embed.grpc-keep-alive-min-time
• storage.etcd.embed.workdir
• storage.etcd.embed.waldir
• storage.etcd.embed.max-request-bytes
• storage.etcd.embed.debug
• storage.etcd.embed.start-timeout
• storage.etcd.embed.log-level
• storage.etcd.embed.initial-cluster
• storage.etcd.embed.initial-cluster-token
• storage.etcd.embed.name
• storage.etcd.embed.initial-cluster-state
• storage.etcd.embed.self-signed-cert-validity

Параметры хранилища Tarantool:

• storage.tarantool.prefix
• storage.tarantool.addr
• storage.tarantool.addrs
• storage.tarantool.auth
• storage.tarantool.timeout
• storage.tarantool.reconnect
• storage.tarantool.max-reconnects
• storage.tarantool.username
• storage.tarantool.password
• storage.tarantool.password-file
• storage.tarantool.rate-limit
• storage.tarantool.rate-limit-action
• storage.tarantool.concurrency
• storage.tarantool.skip-schema
• storage.tarantool.transport
• storage.tarantool.ssl.key-file
• storage.tarantool.ssl.cert-file
• storage.tarantool.ssl.ca-file
• storage.tarantool.ssl.ciphers
• storage.tarantool.ssl.password
• storage.tarantool.ssl.password-file
• storage.tarantool.required-protocol-info.auth
• storage.tarantool.required-protocol-info.version
• storage.tarantool.required-protocol-info.features
• storage.tarantool.embed.enabled
• storage.tarantool.embed.workdir
• storage.tarantool.embed.executable
• storage.tarantool.embed.config-filename
• storage.tarantool.embed.config
• storage.tarantool.embed.args
• storage.tarantool.embed.env

Тип хранилища, используемого для хранения конфигурации TCM.

Возможные значения:

• etcd
• tarantool

Тип: string

Значение по умолчанию: etcd

Переменная окружения: TCM_STORAGE_PROVIDER

Параметр командной строки: –storage.provider

Префикс для параметров конфигурации TCM в etcd.

Тип: string

Значение по умолчанию: "/tcm"

Переменная окружения: TCM_STORAGE_ETCD_PREFIX

Параметр командной строки: –storage.etcd.prefix

Массив URI узлов кластера etcd, где хранится конфигурация TCM, разделенных точкой с запятой (;).

Тип: []string

Значение по умолчанию: ["http://127.0.0.1:2379"]

Переменная окружения: TCM_STORAGE_ETCD_ENDPOINTS

Параметр командной строки: –storage.etcd.endpoints

Время ожидания подключения к etcd.

Тип: time.Duration

Значение по умолчанию: 10s

Переменная окружения: TCM_STORAGE_ETCD_DIAL_TIMEOUT

Параметр командной строки: –storage.etcd.dial-timeout

Интервал автоматической синхронизации.

Тип: time.Duration

Значение по умолчанию: 0 (отключено)

Переменная окружения: TCM_STORAGE_ETCD_AUTO_SYNC_INTERVAL

Параметр командной строки: –storage.etcd.auto-sync-interval

Время удержания соединения (keep-alive) при подключении.

Тип: time.Duration

Значение по умолчанию: 30s

Переменная окружения: TCM_STORAGE_ETCD_DIAL_KEEP_ALIVE_TIME

Параметр командной строки: –storage.etcd.dial-keep-alive-time

Время ожидания удержания соединения (keep-alive) при подключении.

Тип: time.Duration

Значение по умолчанию: 30s

Переменная окружения: TCM_STORAGE_ETCD_DIAL_KEEP_ALIVE_TIMEOUT

Параметр командной строки: –storage.etcd.dial-keep-alive-timeout

Время ожидания начальной загрузки.

Тип: time.Duration

Значение по умолчанию: 30s

Переменная окружения: TCM_STORAGE_ETCD_BOOTSTRAP_TIMEOUT

Параметр командной строки: –storage.etcd.bootstrap-timeout

Максимальный размер (в байтах) транзакции между TCM и etcd.

Тип: int

Значение по умолчанию: 2097152

Переменная окружения: TCM_STORAGE_ETCD_MAX_CALL_SEND_MSG_SIZE

Параметр командной строки: –storage.etcd.max-call-send-msg-size

Имя пользователя для доступа к хранилищу etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_USERNAME

Параметр командной строки: –storage.etcd.username

Пароль для доступа к хранилищу etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_PASSWORD

Параметр командной строки: –storage.etcd.password

Путь к файлу с паролем для доступа к хранилищу etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_PASSWORD_FILE

Параметр командной строки: –storage.etcd.password-file

Указывает, включено ли TLS для подключений к etcd.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_STORAGE_ETCD_TLS_ENABLED

Параметр командной строки: –storage.etcd.tls.enabled

Использовать сгенерированные сертификаты для подключений к etcd.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_STORAGE_ETCD_TLS_AUTO

Параметр командной строки: –storage.etcd.tls.auto

Путь к файлу TLS-сертификата для подключений к etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_TLS_CERT_FILE

Параметр командной строки: –storage.etcd.tls.cert-file

Путь к файлу закрытого TLS-ключа для подключений к etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_TLS_KEY_FILE

Параметр командной строки: –storage.etcd.tls.key-file

Путь к файлу сертификата доверенного центра сертификации (CA) для подключений к etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_TLS_TRUSTED_CA_FILE

Параметр командной строки: –storage.etcd.tls.trusted-ca-file

Указывает, включена ли аутентификация клиента по сертификату.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_STORAGE_ETCD_TLS_CLIENT_CERT_AUTH

Параметр командной строки: –storage.etcd.tls.client-cert-auth

Путь к файлу списка отзыва сертификатов клиента.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_TLS_CRL_FILE

Параметр командной строки: –storage.etcd.tls.crl-file

Пропускать проверку сертификата клиента в подключениях к etcd.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_STORAGE_ETCD_TLS_INSECURE_SKIP_VERIFY

Параметр командной строки: –storage.etcd.tls.insecure-skip-verify

Пропускать проверку поля SAN в сертификате клиента для подключений к etcd.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_STORAGE_ETCD_TLS_SKIP_CLIENT_SAN_VERIFY

Параметр командной строки: –storage.etcd.tls.skip-client-san-verify

Имя TLS-сервера для подключений к etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_TLS_SERVER_NAME

Параметр командной строки: –storage.etcd.tls.server-name

Наборы шифров TLS для подключений к etcd. Возможные значения - константы Golang tls.TLS_*.

Тип: []uint16

Значение по умолчанию: []

Переменная окружения: TCM_STORAGE_ETCD_TLS_CIPHER_SUITES

Параметр командной строки: –storage.etcd.tls.cipher-suites

Разрешенное общее имя (Common Name) для аутентификации в подключениях к etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_TLS_ALLOWED_CN

Параметр командной строки: –storage.etcd.tls.allowed-cn

Разрешенное имя TLS-сертификата для аутентификации в подключениях к etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_ETCD_TLS_ALLOWED_HOSTNAME

Параметр командной строки: –storage.etcd.tls.allowed-hostname

Разрешено ли пустое общее имя (Common Name) в подключениях к etcd.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_STORAGE_ETCD_TLS_EMPTY_CN

Параметр командной строки: –storage.etcd.tls.empty-cn

Разрешена ли отправка keepalive-пингов на сервер etcd без активных потоков.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_STORAGE_ETCD_PERMIT_WITHOUT_STREAM

Параметр командной строки: –storage.etcd.permit-without-stream

Параметры storage.etcd.embed.* определяют конфигурацию встроенного кластера etcd, используемого в качестве хранилища TCM. Этот кластер можно использовать для целей разработки, когда рабочий или тестовый кластер etcd недоступен или не требуется.

См. также tcm_backend_store_embed.

Префикс для параметров конфигурации TCM в хранилище конфигурации на базе Tarantool.

Тип: string

Значение по умолчанию: "/tcm"

Переменная окружения: TCM_STORAGE_TARANTOOL_PREFIX

Параметр командной строки: –storage.tarantool.prefix

URI для подключения к хранилищу конфигурации на базе Tarantool.

Тип: string

Значение по умолчанию: "unix/:/tmp/tnt_config_instance.sock"

Переменная окружения: TCM_STORAGE_TARANTOOL_ADDR

Параметр командной строки: –storage.tarantool.addr

Массив URI хранилища конфигурации на базе Tarantool.

Тип: []string

Значение по умолчанию: ["unix/:/tmp/tnt_config_instance.sock"]

Переменная окружения: TCM_STORAGE_TARANTOOL_ADDRS

Параметр командной строки: –storage.tarantool.addrs

Метод аутентификации для хранилища конфигурации на базе Tarantool.

Возможные значения - константы Go go-tarantool/Auth:

• AutoAuth (0)
• ChapSha1Auth
• PapSha256Auth

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_STORAGE_TARANTOOL_AUTH

Параметр командной строки: –storage.tarantool.auth

Время ожидания запросов к хранилищу конфигурации на базе Tarantool.

См. также go-tarantool.Opts.

Тип: time.Duration

Значение по умолчанию: 0s

Переменная окружения: TCM_STORAGE_TARANTOOL_TIMEOUT

Параметр командной строки: –storage.tarantool.timeout

Интервал между попытками переподключения к хранилищу конфигурации на базе Tarantool.

См. также go-tarantool.Opts.

Тип: time.Duration

Значение по умолчанию: 0s

Переменная окружения: TCM_STORAGE_TARANTOOL_RECONNECT

Параметр командной строки: –storage.tarantool.reconnect

Максимальное количество попыток переподключения к хранилищу конфигурации на базе Tarantool.

См. также go-tarantool.Opts.

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_STORAGE_TARANTOOL_MAX_RECONNECTS

Параметр командной строки: –storage.tarantool.max-reconnects

Имя пользователя для подключения к хранилищу конфигурации на базе Tarantool.

См. также go-tarantool.Opts.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_USERNAME

Параметр командной строки: –storage.tarantool.username

Пароль для подключения к хранилищу конфигурации на базе Tarantool.

См. также go-tarantool.Opts.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_PASSWORD

Параметр командной строки: –storage.tarantool.password

Путь к файлу с паролем для подключения к хранилищу конфигурации на базе Tarantool.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_PASSWORD_FILE

Параметр командной строки: –storage.tarantool.password-file

Ограничение частоты запросов при подключении к хранилищу конфигурации на базе Tarantool.

См. также go-tarantool.Opts.

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_STORAGE_TARANTOOL_RATE_LIMIT

Параметр командной строки: –storage.tarantool.rate-limit

Действие, выполняемое при достижении storage.tarantool.rate-limit.

См. также go-tarantool.Opts.

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_STORAGE_TARANTOOL_RATE_LIMIT_ACTION

Параметр командной строки: –storage.tarantool.rate-limit-action

Количество отдельных мьютексов (mutex) для очередей запросов и буферов внутри подключения к хранилищу конфигурации TCM на базе Tarantool.

См. также go-tarantool.Opts.

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_STORAGE_TARANTOOL_CONCURRENCY

Параметр командной строки: –storage.tarantool.concurrency

Загружать ли схему из хранилища конфигурации TCM на базе Tarantool.

См. также go-tarantool.Opts.

Тип: bool

Значение по умолчанию: true

Переменная окружения: TCM_STORAGE_TARANTOOL_SKIP_SCHEMA

Параметр командной строки: –storage.tarantool.skip-schema

Тип подключения к хранилищу конфигурации TCM на базе Tarantool.

См. также go-tarantool.Opts.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_TRANSPORT

Параметр командной строки: –storage.tarantool.transport

Путь к файлу закрытого TLS-ключа для подключения к хранилищу конфигурации TCM на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_SSL_KEY_FILE

Параметр командной строки: –storage.tarantool.ssl.key-file

Путь к SSL-сертификату для подключения к хранилищу конфигурации TCM на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_SSL_CERT_FILE

Параметр командной строки: –storage.tarantool.ssl.cert-file

Путь к сертификату доверенного центра сертификации (CA) для подключения к хранилищу конфигурации TCM на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_SSL_CA_FILE

Параметр командной строки: –storage.tarantool.ssl.ca-file

Список наборов шифров SSL, которые можно использовать для подключения к хранилищу конфигурации TCM на базе Tarantool. Возможные значения приведены в uri.params.ssl_ciphers

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_SSL_CIPHERS

Параметр командной строки: –storage.tarantool.ssl.ciphers

Пароль для зашифрованного закрытого SSL-ключа, используемого для подключения к хранилищу конфигурации TCM на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_SSL_PASSWORD

Параметр командной строки: –storage.tarantool.ssl.password

Текстовый файл с паролями для зашифрованных закрытых SSL-ключей, используемых для подключения к хранилищу конфигурации TCM на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_STORAGE_TARANTOOL_SSL_PASSWORD_FILE

Параметр командной строки: –storage.tarantool.ssl.password-file

Метод аутентификации для хранилища конфигурации TCM на базе Tarantool.

Возможные значения - константы Go go-tarantool/Auth:

• AutoAuth (0)
• ChapSha1Auth
• PapSha256Auth

См. также go-tarantool.ProtocolInfo.

Тип: int

Значение по умолчанию: 0

Переменная окружения: TCM_STORAGE_TARANTOOL_SSL_REQUIRED_PROTOCOL_INFO_AUTH

Параметр командной строки: --storage.tarantool.required-protocol-info.auth

Версия протокола Tarantool.

См. также go-tarantool.ProtocolInfo.

Тип: uint64

Значение по умолчанию: 0

Переменная окружения: TCM_STORAGE_TARANTOOL_SSL_REQUIRED_PROTOCOL_INFO_VERSION

Параметр командной строки: --storage.tarantool.required-protocol-info.version

Массив функций протокола Tarantool.

См. также go-tarantool.ProtocolInfo.

Тип: []int

Значение по умолчанию: []

Переменная окружения: TCM_STORAGE_TARANTOOL_SSL_REQUIRED_PROTOCOL_INFO_FEATURES

Параметр командной строки: --storage.tarantool.required-protocol-info.features

Параметры группы storage.tarantool.embed определяют конфигурацию встроенного кластера Tarantool, используемого в качестве хранилища TCM. Этот кластер можно использовать для целей разработки, когда рабочий или тестовый кластер недоступен или не требуется.

См. также tcm_backend_store_embed.

Секция addon определяет настройки, связанные с дополнениями TCM.

• addon.enabled
• addon.addons-dir
• addon.max-upload-size
• addon.dev-addons-dir

Включение функциональности дополнений в TCM.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_ADDON_ENABLED

Параметр командной строки: –addon.enabled

Каталог, из которого TCM берет дополнения.

Тип: string

Значение по умолчанию: addons

Переменная окружения: TCM_ADDON_ADDONS_DIR

Параметр командной строки: –addon.addons-dir

Максимальный размер дополнения (в байтах) для загрузки в TCM.

Тип: int64

Значение по умолчанию: 104857600

Переменная окружения: TCM_ADDON_MAX_UPLOAD_SIZE

Параметр командной строки: –addon.max-upload-size

Дополнительные каталоги дополнений для целей разработки, разделенные точкой с запятой (;).

Тип: []string

Значение по умолчанию: []

Переменная окружения: TCM_ADDON_DEV_ADDONS_DIR

Параметр командной строки: –addon.dev-addons-dir

Секция limits определяет ограничения для различных объектов в TCM и отношений между ними.

• limits.users-count
• limits.clusters-count
• limits.roles-count
• limits.webhooks-count
• limits.user-secrets-count
• limits.user-websessions-count
• limits.linked-cluster-users

Максимальное количество пользователей в TCM.

Тип: int

Значение по умолчанию: 1000

Переменная окружения: TCM_LIMITS_USERS_COUNT

Параметр командной строки: --limits.users-count

Максимальное количество кластеров в TCM.

Тип: int

Значение по умолчанию: 10

Переменная окружения: TCM_LIMITS_CLUSTERS_COUNT

Параметр командной строки: --limits.clusters-count

Максимальное количество ролей в TCM.

Тип: int

Значение по умолчанию: 100

Переменная окружения: TCM_LIMITS_ROLES_COUNT

Параметр командной строки: --limits.roles-count

Максимальное количество вебхуков (webhooks) в TCM.

Тип: int

Значение по умолчанию: 200

Переменная окружения: TCM_LIMITS_WEBHOOKS_COUNT

Параметр командной строки: --limits.webhooks-count

Максимальное количество секретов у одного пользователя TCM.

Тип: int

Значение по умолчанию: 10

Переменная окружения: TCM_LIMITS_USER_SECRETS_COUNT

Параметр командной строки: --limits.user-secrets-count

Максимальное количество открытых сессий у одного пользователя TCM.

Тип: int

Значение по умолчанию: 10

Переменная окружения: TCM_LIMITS_USER_WEBSESSIONS_COUNT

Параметр командной строки: --limits.user-websessions-count

Максимальное количество кластеров, к которым пользователь может иметь доступ.

Тип: int

Значение по умолчанию: 10

Переменная окружения: TCM_LIMITS_LINKED_CLUSTER_USERS

Параметр командной строки: --limits.linked-cluster-users

Секция security определяет параметры безопасности TCM.

• security.auth
• security.hash-cost
• security.encryption-key
• security.encryption-key-file
• security.bootstrap-password
• security.bootstrap-api-token
• security.integrity-check
• security.signature-private-key-file

Способы входа в TCM.

Возможные значения:

• local
• ldap

Тип: []string

Значение по умолчанию: [local]

Переменная окружения: TCM_SECURITY_AUTH

Параметр командной строки: –security.auth

Стоимость хэширования паролей пользователей.

Тип: int

Значение по умолчанию: 12

Переменная окружения: TCM_SECURITY_HASH_COST

Параметр командной строки: –security.hash-cost

Ключ шифрования паролей, который используется TCM для доступа к кластерам Tarantool и etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_SECURITY_ENCRYPTION_KEY

Параметр командной строки: –security.encryption-key

Путь к файлу с ключом шифрования паролей, который используется TCM для доступа к кластерам Tarantool и etcd.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_SECURITY_ENCRYPTION_KEY_FILE

Параметр командной строки: –security.encryption-key-file

Пароль для первого входа пользователя admin. Только для тестовых целей.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_SECURITY_BOOTSTRAP_PASSWORD

Параметр командной строки: –security.bootstrap-password

API-токен по умолчанию для пользователя admin. Только для тестовых целей.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_SECURITY_BOOTSTRAP_API_TOKEN

Параметр командной строки: –security.bootstrap-api-token

Определяет, нужно ли проверять цифровую подпись. Если значение true, при обнаружении неверной подписи возникает ошибка.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_SECURITY_INTEGRITY_CHECK

Параметр командной строки: –security.integrity-check

Путь к файлу с приватным ключом для подписи данных TCM.

Тип: string

Значение по умолчанию: ""

Переменная окружения: TCM_SECURITY_SIGNATURE_PRIVATE_KEY_FILE

Параметр командной строки: –security.signature-private-key-file

Секция mode содержит единственый параметр, который определяет режим работы TCM.

Режим TCM: production, development или test.

Тип: string

Значение по умолчанию: production

Переменная окружения: TCM_MODE

Параметр командной строки: –mode

Секция feature определяет параметры безопасности TCM.

• feature.ttgraph
• feature.column-store
• feature.tqe
• feature.api-token
• feature.tuples
• feature.tcf

Определяет, включена ли интеграция с Tarantool Graph DB.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_FEATURE_TTGRAPH

Параметр командной строки: –feature.ttgraph

Определяет, включена ли интеграция с Tarantool Column Store.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_FEATURE_COLUMN_STORE

Параметр командной строки: –feature.column-store

Определяет, включена ли интеграция с Tarantool Queue Enterprise.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_FEATURE_TQE

Параметр командной строки: –feature.tqe

Определяет, включено ли использование API-токенов.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_FEATURE_API_TOKEN

Параметр командной строки: –feature.api-token

Определяет, включено ли использование кортежей.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_FEATURE_TUPLES

Параметр командной строки: –feature.tuples

Определяет, включено ли использование TCF.

Тип: bool

Значение по умолчанию: false

Переменная окружения: TCM_FEATURE_TCF

Параметр командной строки: –feature.tcf

Секция initial-settings определяет сущности, которые создаются автоматически при первом запуске TCM.

См. также tcm_configuration_initial.

Массив кластеров, создаваемых в TCM автоматически при первом запуске.

См. также tcm_configuration_initial.

Тип: []Cluster

Значение по умолчанию: []

Идентификатор кластера. Пропустите этот параметр, чтобы сгенерировать идентификатор автоматически. Укажите значение 00000000-0000-0000-0000-000000000000, чтобы настроить кластер по умолчанию при запуске TCM.

Тип: string

Значение по умолчанию: "" (идентификатор генерируется автоматически)

Имя кластера.

Тип: string

Значение по умолчанию: ""

Описание кластера.

Тип: string

Значение по умолчанию: ""

Цвет для выделения кластера в TCM. Возможные значения:

• dark
• gray
• red
• pink
• grape
• violet
• indigo
• blue
• cyan
• green
• lime
• yellow
• orange
• teal
• пустая строка (без цвета)

Тип: string

Значение по умолчанию: "" (без цвета)

URL дополнительных сервисов для кластера. См. также tcm_connect_clusters_connect_new.

Тип: []ClusterUrl

Значение по умолчанию: []

Метка URL для отображения в TCM. Обычно это имя связанного сервиса.

Тип: string

Значение по умолчанию: ""

URL-адрес связанного сервиса.

Тип: string

Значение по умолчанию: ""

Тип хранилища, используемого для хранения конфигурации кластера.

Возможные значения:

• etcd
• tarantool
• пустая строка (не определено)

Тип: string

Значение по умолчанию: ""

Массив URI узлов кластера etcd, в котором хранится конфигурация кластера Tarantool.

Тип: []string

Значение по умолчанию: []

Интервал автоматической синхронизации.

Тип: time.Duration

Значение по умолчанию: 0 (отключено)

Время ожидания при подключении к etcd.

Тип: time.Duration

Значение по умолчанию: 0 (не задано)

Время поддержания соединения (keep-alive) при подключении.

Тип: time.Duration

Значение по умолчанию: 0 (не задано)

Время ожидания для решения о поддержании соединения (keep-alive) при подключении.

Тип: time.Duration

Значение по умолчанию: 0 (не задано)

Максимальный размер (в байтах) запроса от кластера к его хранилищу конфигурации etcd.

Тип: int

Значение по умолчанию: 2097152

Максимальный размер (в байтах) ответа кластеру от его хранилища конфигурации etcd.

Тип: int

Значение по умолчанию: 0 (без ограничений)

Имя пользователя для доступа к хранилищу etcd кластера.

Тип: string

Значение по умолчанию: ""

Пароль для доступа к хранилищу etcd кластера.

Тип: string

Значение по умолчанию: ""

Определяет, должен ли etcd отказывать в создании клиента для устаревшего кластера.

Тип: bool

Значение по умолчанию: false

Определяет, можно ли отправлять keepalive-пинги на сервер etcd без активных потоков.

Тип: bool

Значение по умолчанию: false

Префикс для параметров конфигурации кластера в etcd.

Тип: string

Значение по умолчанию: ""

Указывает, включён ли TLS для подключений к хранилищу etcd кластера.

Тип: bool

Значение по умолчанию: false

Путь к файлу TLS-сертификата, используемому для подключений к etcd.

Тип: string

Значение по умолчанию: ""

Путь к файлу закрытого TLS-ключа, используемому для подключений к etcd.

Тип: string

Значение по умолчанию: ""

Путь к файлу сертификата доверенного центра сертификации (CA), используемому для подключений к etcd.

Тип: string

Значение по умолчанию: ""

Указывает, включена ли аутентификация клиента по сертификату.

Тип: bool

Значение по умолчанию: false

Путь к файлу списка отзыва клиентских сертификатов (CRL).

Тип: string

Значение по умолчанию: ""

Пропуск проверки клиентского сертификата в подключениях к etcd.

Тип: bool

Значение по умолчанию: false

Пропуск проверки поля SAN в клиентском сертификате для подключений к etcd.

Тип: bool

Значение по умолчанию: false

Имя TLS-сервера для подключений к etcd.

Тип: string

Значение по умолчанию: ""

Наборы шифров TLS для подключений к etcd. Возможные значения - константы Golang tls.TLS_*.

Тип: []uint16

Значение по умолчанию: []

Разрешённое общее имя (Common Name) для аутентификации в подключениях к etcd.

Тип: string

Значение по умолчанию: ""

Разрешённое имя TLS-сертификата для аутентификации в подключениях к etcd.

Тип: string

Значение по умолчанию: ""

Определяет, разрешено ли пустое общее имя (Common Name) в подключениях к etcd.

Тип: bool

Значение по умолчанию: false

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

Тип: string

Значение по умолчанию: ""

Пароль для подключения к хранилищу конфигурации кластера на базе Tarantool.

Тип: string

Значение по умолчанию: ""

Массив URI хранилища конфигурации кластера на базе Tarantool.

Тип: []string

Значение по умолчанию: []

Метод аутентификации для хранилища конфигурации кластера на базе Tarantool.

Возможные значения - константы Go go-tarantool/Auth:

• AutoAuth (0)
• ChapSha1Auth
• PapSha256Auth

Тип: string

Значение по умолчанию: ""

Префикс для параметров конфигурации кластера в хранилище конфигурации на базе Tarantool.

Тип: string

Значение по умолчанию: ""

Путь к файлу закрытого TLS-ключа, используемому для подключения к хранилищу конфигурации кластера на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Путь к SSL-сертификату, используемому для подключения к хранилищу конфигурации кластера на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Путь к сертификату доверенного центра сертификации (CA), используемому для подключения к хранилищу конфигурации кластера на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Список наборов шифров SSL, которые можно использовать для подключения к хранилищу конфигурации кластера на базе Tarantool. Возможные значения перечислены в uri.params.ssl_ciphers.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Пароль для зашифрованного закрытого SSL-ключа, используемого для подключения к хранилищу конфигурации кластера на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Текстовый файл с паролями для зашифрованных закрытых SSL-ключей, используемых для подключения к хранилищу конфигурации кластера на базе Tarantool.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Имя пользователя для подключения к экземплярам кластера.

Тип: string

Значение по умолчанию: ""

Пароль для подключения к экземплярам кластера.

Тип: string

Значение по умолчанию: ""

Метод аутентификации для подключения к кластеру.

Возможные значения - константы Go go-tarantool/Auth:

• AutoAuth (0)
• ChapSha1Auth
• PapSha256Auth

Тип: string

Значение по умолчанию: ""

Время ожидания запросов к кластеру.

Тип: time.Duration

Значение по умолчанию: 0 (не задано)

Ограничение скорости запросов к кластеру.

Тип: uint

Значение по умолчанию: 0 (не задано)

Путь к файлу закрытого TLS-ключа, используемому для подключения к экземплярам кластера.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Путь к SSL-сертификату, используемому для подключения к экземплярам кластера.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Путь к сертификату доверенного центра сертификации (CA), используемому для подключения к экземплярам кластера.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Список наборов шифров SSL, которые можно использовать для подключения к экземплярам кластера. Возможные значения перечислены в uri.params.ssl_ciphers.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Пароль для зашифрованного закрытого SSL-ключа, используемого для подключения к экземплярам кластера.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Текстовый файл с паролями для зашифрованных закрытых SSL-ключей, используемых для подключения к экземплярам кластера.

См. также Подключения.

Тип: string

Значение по умолчанию: ""

Настройки журнала аудита, включая вывод в консоль, файл, syslog и фильтрацию событий.

Включает или отключает ведение журнала аудита.

Тип: bool

Значение по умолчанию: false

Включает вывод журнала аудита в стандартный поток вывода (stdout).

Тип: bool

Значение по умолчанию: false

Задает метод вывода журнала аудита. Возможные значения: file, syslog.

Тип: string

Значение по умолчанию: file

Путь к файлу, в который будет записываться журнал аудита. Файл будет создан в рабочем каталоге TCM. У пользователя, от имени которого запускается TCM, должны быть права на чтение и запись в указанный каталог.

Тип: string

Значение по умолчанию: ""

Максимальный размер файла в мегабайтах до выполнения ротации.

Тип: int

Значение по умолчанию: 0

Максимальное количество сохраняемых резервных файлов.

Тип: int

Значение по умолчанию: 0

Максимальный срок хранения журналов в днях.

Тип: int

Значение по умолчанию: 0

Включает сжатие резервных файлов журнала.

Тип: bool

Значение по умолчанию: false

Протокол syslog. Возможные значения: udp, tcp.

Тип: string

Значение по умолчанию: udp

Адрес и порт сервера syslog.

Тип: string

Значение по умолчанию: ""

Уровень приоритета сообщений syslog.

Тип: string

Значение по умолчанию: ""

Категория (facility) syslog для сообщений.

Тип: string

Значение по умолчанию: ""

Максимальное время ожидания ответа от сервера syslog.

Тип: time.Duration

Значение по умолчанию: 2s

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

Тип: string

Значение по умолчанию: []

Секция migrations содержит настройки миграций.

Максимально допустимое время выполнения длительных миграций для предотвращения прерывания. Значение задано по умолчанию.

Тип: time.Duration

Default value: 6m0s

Переменная окружения: TCM_MIGRATIONS_DURATION

Параметр командной строки: --migrations.duration

Секция default-cluster управляет кластером по умолчанию.

Определяет, будет ли кластер по умолчанию (Default cluster) создан автоматически.

Тип: string

Возможные значения: true или false

Значение по умолчанию: true

Переменная окружения: TCM_DEFAULT_CLUSTER

Параметр командной строки: –default-cluster