Создать группу бэкендов

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

1. Посмотрите описание команды CLI для создания группы бэкендов:

   yc alb backend-group create --help
   

2. Создайте группу бэкендов, выполнив команду:

   yc alb backend-group create <имя_группы_бэкендов>
   

   Результат:

   id: a5dg2cv4ngne********
   name: test-backend-group
   folder_id: aoerb349v3h4********
   created_at: "2021-02-11T20:46:21.688940670Z"
   

3. Добавьте в группу бэкенд и проверку состояния.

   Внимание

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

   Рекомендуется настраивать проверки состояния для всех бэкендов.

   Внутри группы все бэкенды должны быть одного типа — HTTP, gRPC или Stream.

   HTTP-бэкенд

   Выполните команду:

   yc alb backend-group add-http-backend \
     --backend-group-name <имя_бэкенд_группы> \
     --name <имя_добавляемого_бэкенда> \
     --weight <вес_бэкенда> \
     --port <порт_бэкенда> \
     --target-group-id=<идентификатор_целевой_группы> \
     --panic-threshold 90 \
     --http-healthcheck port=80,healthy-threshold=10,unhealthy-threshold=15,expected-statuses=211,\
   timeout=10s,interval=2s,host=<адрес_хоста>,path=<путь>
   

   Где:

   • --name — имя существующего бэкенда, параметры которого хотите обновить, или имя нового бэкенда, который хотите добавить.
   • --panic-threshold — порог для режима паники.
   • --http-healthcheck — параметры проверки состояния ресурсов:
     • port — порт.
     • healthy-threshold — порог работоспособности.
     • unhealthy-threshold — порог неработоспособности.
     • expected-statuses — код состояния HTTP, который будет считаться корректным при проверке состояния бэкенда. Чтобы добавить несколько значений, укажите их через запятую: expected-statuses=201,expected-statuses=205,expected-statuses=302. Коды могут принимать значения от 100 до 599. Если параметр не задан, код ответа будет один — 200.
     • timeout — максимальный период, на который может быть установлено соединение.
     • interval — интервал.
     • host — адрес хоста.
     • path — путь.

   Результат:

   id: a5dqkr2mk3rr********
   name: <имя_группы_бэкендов>
   folder_id: aoe197919j8e********
   http:
     backends:
     - name: <имя_бэкенда>
       backend_weight: "1"
       load_balancing_config:
         panic_threshold: "90"
       port: "80"
       target_groups:
         target_group_ids:
         - a5d2iap3nue9********
       healthchecks:
       - timeout: 10s
         interval: 2s
         healthy_threshold: "10"
         unhealthy_threshold: "15"
         healthcheck_port: "80"
         http:
           host: <адрес_хоста>
           path: <путь>
   created_at: "2021-02-11T20:46:21.688940670Z"
   

   gRPC-бэкенд

   Выполните команду:

   yc alb backend-group add-grpc-backend \
     --backend-group-name <имя_бэкенд_группы> \
     --name <имя_добавляемого_бэкенда> \
     --weight <вес_бэкенда> \
     --port <порт_бэкенда> \
     --target-group-id=<идентификатор_целевой_группы> \
     --panic-threshold 90 \
     --grpc-healthcheck port=80,healthy-threshold=10,unhealthy-threshold=15,\
   timeout=10s,interval=2s,service-name=<имя_gRPC-сервиса>
   

   Где:

   • --panic-threshold — порог для режима паники.
   • --grpc-healthcheck — параметры проверки состояния ресурсов:
     • port — порт.
     • healthy-threshold — порог работоспособности.
     • unhealthy-threshold — порог неработоспособности.
     • timeout — максимальный период, на который может быть установлено соединение.
     • interval — интервал.
     • service-name — имя проверяемого gRPC-сервиса. Если сервис не указан, проверяется общее состояние бэкенда.

   Результат:

   id: a5dqkr2mk3rr********
   name: <имя_группы_бэкендов>
   folder_id: aoe197919j8e********
   grpc:
     backends:
       - name: <имя_бэкенда>
         backend_weight: "12"
         load_balancing_config:
           panic_threshold: "90"
         port: "80"
         target_groups:
           target_group_ids:
             - a5d2iap3nue9********
         healthchecks:
           - timeout: 10s
             interval: 2s
             healthy_threshold: "10"
             unhealthy_threshold: "15"
             healthcheck_port: "80"
             grpc:
               service_name: <имя_gRPC_сервиса>
   created_at: "2023-06-17T13:04:08.567141292Z"
   

   Stream-бэкенд

   Выполните команду:

   yc alb backend-group add-stream-backend \
     --backend-group-name <имя_бэкенд_группы> \
     --name <имя_добавляемого_бэкенда> \
     --weight <вес_бэкенда> \
     --port <порт_бэкенда> \
     --target-group-id=<идентификатор_целевой_группы> \
     --panic-threshold 90 \
     --enable-proxy-protocol \
     --keep-connections-on-host-health-failure \
     --stream-healthcheck port=80,healthy-threshold=10,unhealthy-threshold=15,\
   timeout=10s,interval=2s,send-text=<данные_к_эндпоинту>,receive-text=<данные_от_эндпоинта>
   

   Где:

   • --panic-threshold — порог для режима паники.
   • --enable-proxy-protocol — опция, при которой балансировщик передает бэкенду метаданные своего соединения с клиентом, в том числе его IP-адрес, по протоколу PROXY от HAProxy. Если опция не задана, в бэкенд передается только IP-адрес балансировщика.
   • --keep-connections-on-host-health-failure — опция позволяет сохранять соединение, даже когда проверка состояния неуспешна.
   • --stream-healthcheck — параметры проверки состояния ресурсов:
     • port — порт.
     • healthy-threshold — порог работоспособности.
     • unhealthy-threshold — порог неработоспособности.
     • timeout — максимальный период, на который может быть установлено соединение.
     • interval — интервал.
     • send-text — данные, которые отправляются на эндпоинт для проверки состояния.
     • receive-text — данные, которые должны поступить с эндпоинта, чтобы он прошел проверку состояния.

   Результат:

   id: ds77tero4f5********
   name: <имя_группы_бэкендов>
   folder_id: b1gu6g9ielh6********
   stream:
     backends:
     - name: <имя_бэкенда>
   backend_weight: "1"
       port: "80"
       target_groups:
         target_group_ids:
         - ds7eof3r2cte********
       healthchecks:
         - timeout: 10s
           interval: 2s
           healthy_threshold: "10"
           unhealthy_threshold: "15"
           healthcheck_port: "80"
           stream:
             send:
               text: <данные_к_эндпоинту>
             receive:
               text: <данные_от_эндпоинта>
       enable_proxy_protocol: true
   created_at: "2022-04-06T09:17:57.104324513Z"
   

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform или в зеркале.

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

1. Опишите в конфигурационном файле Terraform параметры ресурса, который необходимо создать:

   resource "yandex_alb_backend_group" "test-backend-group" {
     name                     = "<имя_группы_бэкендов>"
     session_affinity {
       connection {
         source_ip = <режим_привязки_сессий_по_IP-адресу>
       }
     }
     stream_backend {
       name                   = "<имя_бэкенда>"
       weight                 = 1
       port                   = 80
       target_group_ids       = ["<идентификатор_целевой_группы>"]
       load_balancing_config {
         panic_threshold      = 90
       }
       enable_proxy_protocol  = true
       healthcheck {
         timeout              = "10s"
         interval             = "2s"
         healthy_threshold    = 10
         unhealthy_threshold  = 15
         keep_connections_on_host_health_failure = <true_или_false>
         stream_healthcheck {
           send               = "<данные_к_эндпоинту>"
           receive            = "<данные_от_эндпоинта>"
         }
         http_healthcheck {
           path              = "<путь>"
           host              = "<хост>"
           expected_statuses = [<HTTP-коды>]
         }
       }
     }
   }
   

   Где:

   • yandex_alb_backend_group — параметры группы бэкендов:

     • name — имя группы бэкендов.

     • session_affinity — настройки привязки сессий (необязательный параметр).

       Примечание

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

       • connection — режим привязки сессий по IP-адресу (source_ip). Может принимать значения true или false. Также доступны режимы cookie и header. Должен быть указан только один из режимов. Если группа бэкендов имеет тип Stream (состоит из ресурсов stream_backend), то привязка сессий может иметь только режим connection.

     • http_backend, grpc_backend и stream_backend — тип бэкенда. Внутри группы все бэкенды должны быть одного типа — HTTP, gRPC или Stream.

   Параметры бэкенда:

   • name — имя бэкенда.

   • port — порт бэкенда.

   • weight — вес бэкенда.

   • target_group_ids — идентификатор целевой группы. Получить список доступных целевых групп можно с помощью команды CLI: yc alb target-group list.

   • load_balancing_config — параметры балансировки:

     • panic_threshold — порог для режима паники.

   • enable_proxy_protocol — опция, при которой балансировщик передает бэкенду метаданные своего соединения с клиентом, в том числе его IP-адрес, по протоколу PROXY от HAProxy. Если опция не задана, в бэкенд передается только IP-адрес балансировщика. Параметр доступен только для бэкендов типа Stream.

   • healthcheck — параметры проверки состояния:

     • timeout — максимальный период, на который может быть установлено соединение.
     • interval — интервал.
     • healthy_threshold — порог работоспособности.
     • unhealthy_threshold — порог неработоспособности.
     • keep_connections_on_host_health_failure — опция, при которой соединения сохраняются открытыми, даже если целевой хост переходит в статус Unhealthy.
     • http_healthcheck — параметры проверки состояния типа HTTP:
       • path — путь, например /health.
       • host — адрес хоста, например example.com.
       • expected_statuses — список HTTP-кодов, соответствующих статусу Healthy. Например: [200, 201, 202].
     • grpc_healthcheck — параметры проверки состояния типа gRPC:
       • service_name — имя проверяемого gRPC-сервиса. Если сервис не указан, проверяется общее состояние бэкенда.
     • stream_healthcheck — параметры проверки состояния типа Stream:
       • send — данные, которые отправляются на эндпоинт для проверки состояния.
       • receive — данные, которые должны поступить с эндпоинта, чтобы он прошел проверку состояния.

     Внимание

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

     Рекомендуется настраивать проверки состояния для всех бэкендов.

   Подробную информацию о параметрах ресурса yandex_alb_backend_group см. в документации провайдера Terraform.

2. Создайте ресурсы:

   1. В терминале перейдите в папку, где вы отредактировали конфигурационный файл.

   2. Проверьте корректность конфигурационного файла с помощью команды:

      terraform validate
      

      Если конфигурация является корректной, появится сообщение:

      Success! The configuration is valid.
      

   3. Выполните команду:

      terraform plan
      

      В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

   4. Примените изменения конфигурации:

      terraform apply
      

   5. Подтвердите изменения: введите в терминале слово yes и нажмите Enter.

   Terraform создаст все требуемые ресурсы. Проверить появление ресурсов можно в консоли управления или с помощью команды CLI:

   yc alb backend-group list
   

   Ограничения по времени

   Провайдер Terraform ограничивает время на выполнение операций с группами бэкендов Application Load Balancer 10 минутами.

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

   Как изменить эти ограничения?

   Добавьте к описанию группы бэкендов блок timeouts, например:

   resource "yandex_alb_backend_group" "<имя_группы_бэкендов>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
       delete = "60m"
     }
   }
   

Воспользуйтесь методом REST API create для ресурса BackendGroup или вызовом gRPC API BackendGroupService/Create.