Изменение подключения
Важно
Функциональность доступна только в регионе Россия.
Для изменения настроек подключения:
- В консоли управления
выберите каталог. - Выберите сервис Yandex MetaData Hub.
- На панели слева выберите
Connection manager. - В списке подключений нажмите на значок
справа в строке подключения, которое вы хотите изменить. - Выберите пункт Редактировать.
- Измените требуемые параметры подключения, такие как описание, метки, настройки сервера базы данных или данные аутентификации пользователя.
- Нажмите Применить для сохранения изменений.
Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.
По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.
Вы можете изменить настройки подключения к кластеру с управляемой базой данных и к пользовательской инсталляции базы данных.
-
Чтобы изменить настройки подключения к кластеру с управляемой базой данных:
-
Посмотрите описание команды CLI для изменения подключения:
yc metadata-hub connection-manager connection update <тип_базы_данных> --helpВозможные типы баз данных:
postgresql,mysql,clickhouse,mongodb,opensearch,valkey,greenplum,kafka. -
Измените подключение, выполнив команду:
yc metadata-hub connection-manager connection update <тип_базы_данных> <идентификатор_подключения> \ --name <имя_подключения> \ --user <имя_пользователя> \ --password <пароль> \ --managed-cluster-id <идентификатор_кластера>Где:
-
--name— имя подключения. -
--user— имя пользователя для подключения к кластеру. -
--password— пароль пользователя. -
--managed-cluster-id— идентификатор кластера. Идентификатор кластера можно получить со списком кластеров в каталоге.
Идентификатор подключения можно получить со списком подключений в каталоге.
-
-
Вы можете изменить список баз данных для всех подключений, кроме подключений к Managed Service for OpenSearch и Managed Service for Apache Kafka®, выполнив команду:
yc metadata-hub connection-manager connection update <тип_базы_данных> <идентификатор_подключения> \ --databases <список_БД>Где
--databases— список баз данных, разделенный запятыми.Убедитесь, что у пользователя есть необходимые права на доступ к ним.
-
-
Чтобы изменить настройки подключения к пользовательской инсталляции базы данных:
-
Посмотрите описание команды CLI для изменения подключения:
yc metadata-hub connection-manager connection update <тип_базы_данных> --helpВозможные типы баз данных:
postgresql,mysql,clickhouse,mongodb,redis,opensearch,trino,valkey,greenplum,kafka. -
Измените подключение, выполнив команду:
yc metadata-hub connection-manager connection update <тип_базы_данных> <идентификатор_подключения> \ --name <имя_подключения> \ --user <имя_пользователя> \ --password <пароль> \ --ca-certificate <путь_к_сертификату>Где:
-
--name— имя подключения. -
--description— описание подключения. -
--labels— список меток в формате"<ключ>":"<значение>", через запятую. -
--user— имя пользователя для подключения к кластеру. -
--password— пароль пользователя. -
--ca-certificate— путь к файлу CA-сертификата для TLS.По умолчанию TLS включен. Чтобы отключить его, используйте флаг
--tls-disabled.
-
-
Дополнительно вы можете изменить:
-
Список хостов для всех подключений, кроме подключения к Trino, выполнив команду:
yc metadata-hub connection-manager connection update <тип_базы_данных> <идентификатор_подключения> \ --hosts <список_хостов>Где
--hosts— список хостов, разделенных запятой.Важно
Формат записи хостов зависит от типа базы данных. Подробнее см. в справочнике CLI.
-
Параметры координатора для подключения к Trino, выполнив команду:
yc metadata-hub connection-manager connection update trino <идентификатор_подключения> \ --coordinator <параметры_координатора>Где
--coordinator— параметры координатора в формате<хост>:<порт>. -
Список баз данных для всех подключений, кроме подключений к Trino, OpenSearch и Apache Kafka®, выполнив команду:
yc metadata-hub connection-manager connection update <тип_базы_данных> <идентификатор_подключения> \ --databases <список_БД>Где
--databases— список баз данных, разделенный запятыми.Убедитесь, что у пользователя есть необходимые права на доступ к ним.
-
-
Terraform
Terraform распространяется под лицензией Business Source License
Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform
Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.
Внимание
Не изменяйте имя подключения с помощью Terraform. Это приведет к удалению существующего подключения и созданию нового.
Вы можете изменить настройки подключения к кластеру с управляемой базой данных и к пользовательской инсталляции базы данных.
-
Чтобы изменить настройки подключения к кластеру с управляемой базой данных:
-
Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.
-
Чтобы изменить описание подключения и набор меток, измените значения соответствующих полей в описании ресурса:
resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... description = "<описание_подключения>" labels = { "<ключ_1>" = "<значение_1>" "<ключ_2>" = "<значение_2>" ... "<ключ_N>" = "<значение_N>" } ... }Где:
-
description— описание подключения. -
labels— набор меток в формате"<ключ>" = "<значение>".
-
-
Чтобы изменить идентификатор кластера, измените значение поля
managed_cluster_idв блокеparams.<тип_базы_данных>:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { <тип_базы_данных> = { managed_cluster_id = "<идентификатор_кластера>" ... } } } -
Чтобы изменить список баз данных для всех подключений, кроме подключений к Managed Service for OpenSearch и Managed Service for Apache Kafka®, измените значение поля
databasesв блокеparams.<тип_базы_данных>:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { <тип_базы_данных> = { ... databases = [ "<база_данных_1>", "<база_данных_2>", ... "<база_данных_N>" ] ... } } }Где
databases— список баз данных. Убедитесь, что у пользователя есть необходимые права на доступ к ним. -
Чтобы изменить параметры аутентификации для всех подключений, кроме подключений к Managed Service for Apache Kafka®, измените значения полей
userиpassword.rawв блокеparams.<тип_базы_данных>.auth.user_password:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { <тип_базы_данных> = { ... auth = { user_password = { user = "<имя_пользователя>" password = { raw = "<пароль>" } } } } } } -
Чтобы изменить параметры аутентификации для подключений к Managed Service for Apache Kafka®, измените значения полей в блоке
params.kafka.auth.sasl:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { kafka = { ... auth = { sasl = { user = "<имя_пользователя>" password = { raw = "<пароль>" } supported_mechanisms = [ <список_механизмов_аутентификации> ] } } } } }Где
params.kafka.auth— параметры аутентификации. Укажите один из блоков:-
sasl— параметры SASL-аутентификации:-
user— имя пользователя для подключения к кластеру. -
password.raw— пароль пользователя. -
supported_mechanisms— список механизмов аутентификации. Возможные значения:PLAIN— аутентификация с передачей логина и пароля в открытом виде.SCRAM_SHA256— аутентификация с хэшированием SHA-256.SCRAM_SHA512— аутентификация с хэшированием SHA-512.
-
-
disabled— отключает аутентификацию.
-
-
Проверьте корректность настроек.
-
В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.
-
Выполните команду:
terraform validateЕсли в файлах конфигурации есть ошибки, Terraform на них укажет.
-
-
Подтвердите изменение ресурсов.
-
Выполните команду для просмотра планируемых изменений:
terraform planЕсли конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.
-
Если вас устраивают планируемые изменения, внесите их:
-
Выполните команду:
terraform apply -
Подтвердите изменение ресурсов.
-
Дождитесь завершения операции.
-
-
-
-
Чтобы изменить настройки подключения к пользовательской инсталляции базы данных:
-
Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.
-
Чтобы изменить описание подключения и набор меток, измените значения соответствующих полей в описании ресурса:
resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... description = "<описание_подключения>" labels = { "<ключ_1>" = "<значение_1>" "<ключ_2>" = "<значение_2>" ... "<ключ_N>" = "<значение_N>" } ... }Где:
-
description— описание подключения. -
labels— набор меток в формате"<ключ>" = "<значение>".
-
-
Чтобы изменить список хостов для всех подключений, кроме подключений к Trino, измените значение поля
hostsв блокеparams.<тип_базы_данных>.cluster:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { <тип_базы_данных> = { cluster = { hosts = [ { <параметры_хоста_1> }, { <параметры_хоста_2> }, ... { <параметры_хоста_N> } ] ... } ... } } }Важно
Параметры хостов зависят от типа базы данных. Подробнее см. в документации провайдера Terraform
. -
Чтобы изменить параметры координатора для подключений к Trino, измените значения полей
hostиportв блокеparams.trino.cluster.coordinator:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { <тип_базы_данных> = { cluster = { coordinator = { host = "<хост>" port = <порт> } ... } ... } } } -
Чтобы изменить параметры TLS, измените значения полей в блоке
params.<тип_базы_данных>.cluster.tls_params:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { <тип_базы_данных> = { cluster = { ... tls_params = { tls { ca_certificate = "<путь_к_сертификату>" } } } ... } } }Где
params.<тип_базы_данных>.cluster.tls_params— параметры TLS. Укажите один из блоков:tls.ca_certificate— путь к файлу CA-сертификата для TLS.disabled— отключает TLS. По умолчанию TLS включен.
-
Чтобы изменить список баз данных для всех подключений, кроме подключений к Trino, OpenSearch и Apache Kafka®, измените значение поля
databasesв блокеparams.<тип_базы_данных>:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { <тип_базы_данных> = { ... databases = [ "<база_данных_1>", "<база_данных_2>", ... "<база_данных_N>" ] ... } } }Где
databases— список баз данных. Убедитесь, что у пользователя есть необходимые права на доступ к ним. -
Чтобы изменить параметры аутентификации для всех подключений, кроме подключений к Apache Kafka®, измените значения полей
userиpassword.rawв блокеparams.<тип_базы_данных>.auth.user_password:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { <тип_базы_данных> = { ... auth = { user_password = { user = "<имя_пользователя>" password = { raw = "<пароль>" } } } } } } -
Чтобы изменить параметры аутентификации для подключений к Apache Kafka®, измените значения полей в блоке
params.kafka.auth.sasl:resource "yandex_connectionmanager_connection" "<локальное_имя_подключения>" { ... params = { kafka = { ... auth = { sasl = { user = "<имя_пользователя>" password = { raw = "<пароль>" } supported_mechanisms = [ <список_механизмов_аутентификации> ] } } } } }Где
params.kafka.auth— параметры аутентификации. Укажите один из блоков:-
sasl— параметры SASL-аутентификации:-
user— имя пользователя для подключения к кластеру. -
password.raw— пароль пользователя. -
supported_mechanisms— список механизмов аутентификации. Возможные значения:PLAIN— аутентификация с передачей логина и пароля в открытом виде.SCRAM_SHA256— аутентификация с хэшированием SHA-256.SCRAM_SHA512— аутентификация с хэшированием SHA-512.
-
-
disabled— отключает аутентификацию.
-
-
Проверьте корректность настроек.
-
В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.
-
Выполните команду:
terraform validateЕсли в файлах конфигурации есть ошибки, Terraform на них укажет.
-
-
Подтвердите изменение ресурсов.
-
Выполните команду для просмотра планируемых изменений:
terraform planЕсли конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.
-
Если вас устраивают планируемые изменения, внесите их:
-
Выполните команду:
terraform apply -
Подтвердите изменение ресурсов.
-
Дождитесь завершения операции.
-
-
-
Воспользуйтесь методом REST API Connection.Update или методом gRPC API ConnectionService.Update и передайте в запросе идентификатор подключения.
Идентификатор подключения можно получить со списком подключений в каталоге.