Создать HTTP-роутер для gRPC-трафика

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

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

1. Посмотрите описание команды CLI для создания HTTP-роутера:

   yc alb http-router create --help
   

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

   yc alb http-router create <имя_HTTP-роутера>
   

   Результат:

   id: a5dcsselagj4********
   name: <имя_HTTP-роутера>
   folder_id: aoerb349v3h4********
   created_at: "2022-06-16T21:04:59.438292069Z"
   

3. Посмотрите описание команды CLI для создания виртуального хоста:

   yc alb virtual-host create --help
   

4. Создайте виртуальный хост, указав имя HTTP-роутера и настройки виртуального хоста:

   yc alb virtual-host create <имя_виртуального_хоста> \
     --http-router-name <имя_HTTP-роутера> \
     --authority * \
     --rate-limit rps=100,all-requests \
     --security-profile-id <идентификатор_профиля_безопасности>
   

   Где:

   • --http-router-name — имя HTTP-роутера.
   • --authority — домены для заголовков :authority, которые будут связаны с этим виртуальным хостом. Поддерживаются символы подстановки, например *.foo.com или *-bar.foo.com.
   • --rate-limit — (опционально) ограничение на скорость запросов:
     • rps или rpm – количество запросов, которые можно принять в секунду или минуту.
     • all-requests — ограничение на все входящие запросы.
     • requests-per-ip — ограничение на количество запросов для каждого IP-адреса в отдельности. То есть в единицу времени для каждого IP-адреса можно принять указанное количество запросов.
   • --security-profile-id — (опционально) идентификатор профиля безопасности сервиса Yandex Smart Web Security. Профиль безопасности позволяет настроить фильтрацию входящих запросов, подключить WAF и установить лимиты на количество запросов для защиты от вредоносной активности. Подробнее см. Профили безопасности.

   Результат:

   done (1s)
   name: <имя_виртуального_хоста>
   authority:
     - *
   rate_limit:
     all_requests:
       per_second: "100"
   

5. Посмотрите описание команды CLI для добавления маршрута:

   yc alb virtual-host append-grpc-route --help
   

6. Добавьте маршрут, указав идентификатор или имя HTTP-роутера и параметры маршрутизации:

   yc alb virtual-host append-grpc-route <имя_маршрута> \
     --virtual-host-name <имя_виртуального_хоста> \
     --http-router-name <имя_HTTP-роутера> \
     --prefix-fqmn-match / \
     --backend-group-name <имя_группы_бэкендов> \
     --request-max-timeout 60s \
     --rate-limit rps=50,requests-per-ip
   

   Где:

   • --virtual-host-name — имя виртуального хоста.

   • --http-router-name — имя HTTP-роутера.

   • --prefix-fqmn-match — параметр для маршрутизации всех запросов с определенным началом. После параметра укажите FQMN /.

     Также, чтобы задать условие для маршрутизации, вы можете использовать опции:

     • --exact-fqmn-match — для маршрутизации всех запросов, совпадающих с указанным FQMN. После параметра укажите /<FQMN>/.
     • --regex-fqmn-match — для маршрутизации всех запросов, удовлетворяющих регулярному выражению стандарта RE2. После параметра укажите /<регулярное_выражение>.

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

   • --rate-limit — ограничение на скорость запросов.

   • --request-max-timeout — максимальный тайм-аут ожидания запроса, в секундах. Клиент может указать в запросе HTTP-заголовок grpc-timeout с меньшим тайм-аутом.

   Подробную информацию о параметрах команды yc alb virtual-host append-grpc-route см. в справочнике CLI.

   Результат:

   done (1s)
   name: <имя_виртуального_хоста>
   authority:
   - *
   routes:
   - name: <имя_маршрута>
     grpc:
      match:
        fqmn:
         prefix_match: /helloworld
      route:
        backend_group_id: ds7snban2dvn********
        max_timeout: 60s
   

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

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

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

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

1. Опишите в конфигурационном файле параметры HTTP-роутера и виртуального хоста:

   resource "yandex_alb_http_router" "tf-router" {
     name          = "<имя_HTTP-роутера>"
     labels        = {
       tf-label    = "tf-label-value"
       empty-label = ""
     }
   }
   
   resource "yandex_alb_virtual_host" "my-virtual-host" {
     name                    = "<имя_виртуального_хоста>"
     http_router_id          = yandex_alb_http_router.tf-router.id
     route {
       name                  = "<имя_маршрута>"
       grpc_route {
         grpc_route_action {
           backend_group_id  = "<идентификатор_группы_бэкендов>"
           max_timeout       = "60s"
         }
       }
     }
     route_options {
       security_profile_id   = "<идентификатор_профиля_безопасности>"
     }
   }
   

   Где:

   • yandex_alb_http_router — описание HTTP-роутера:

     • name — имя HTTP-роутера. Формат имени:

       • длина — от 2 до 63 символов;
       • может содержать строчные буквы латинского алфавита, цифры и дефисы;
       • первый символ — буква, последний — не дефис.

     • labels — метки для HTTP-роутера. Укажите пару ключ — значение.

   • yandex_alb_virtual_host — описание виртуального хоста:

     • name — имя виртуального хоста. Формат имени:

       • длина — от 2 до 63 символов;
       • может содержать строчные буквы латинского алфавита, цифры и дефисы;
       • первый символ — буква, последний — не дефис.

     • http_router_id — идентификатор HTTP-роутера.

     • route — описание маршрута HTTP-роутера:

       • name — имя маршрута.
       • grpc_route — описание маршрута для gRPC-трафика:
         • grpc_route_action — параметр для указания действия с gRPC-трафиком.
           • backend_group_id — идентификатор группы бэкэндов.
           • max_timeout — максимальный тайм-аут ожидания запроса, в секундах. Клиент может указать в запросе HTTP-заголовок grpc-timeout с меньшим тайм-аутом.

     • route_options — (опционально) дополнительные параметры виртуального хоста:

       • security_profile_id — идентификатор профиля безопасности сервиса Yandex Smart Web Security. Профиль безопасности позволяет настроить фильтрацию входящих запросов, подключить WAF и установить лимиты на количество запросов для защиты от вредоносной активности. Подробнее см. Профили безопасности.

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

   • Ресурс yandex_alb_http_router.
   • Ресурс yandex_alb_virtual_host.

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

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

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

      terraform validate
      

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

      Success! The configuration is valid.
      

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

      terraform plan
      

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

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

      terraform apply
      

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

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

   yc alb http-router get <имя_HTTP-роутера>
   

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