Управлять маршрутами

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

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

С помощью Yandex Cloud CLI вы можете добавлять в виртуальный хост разные типы маршрутов:

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

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

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

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

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

   HTTP

   gRPC

   ...
   route {
     name                      = "<имя_маршрута>"
     disable_security_profile  = true|false
   
     http_route {
       http_match {
         http_method = ["<HTTP-метод_1>","<HTTP-метод_2>",...,"<HTTP-метод_n>"]
         path {
           prefix = "/<префикс_пути_запроса>/"
           # или exact = "<путь_запроса>"
           # или regex = "<регулярное_выражение>"
         }
       }
   
       http_route_action {
         backend_group_id  = "<идентификатор_группы_бэкендов>"
         host_rewrite      = "<значение_заголовка_Host>"
         timeout           = "<таймаут_соединения>s"
         idle_timeout      = "<таймаут-простоя>s"
         prefix_rewrite    = "<новый_префикс_пути_запроса>/"
         rate_limit {
           all_requests {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
           requests_per_ip {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
         }
       }
     }
   }
   ...
   

   Где:

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

     • name — имя маршрута.
     • disable_security_profile — (опционально) опция отключения профиля безопасности сервиса Yandex Smart Web Security. Возможные значения: true (профиль отключен) или false (профиль включен). По умолчанию профиль безопасности включен (значение false).

     • http_route — описание маршрута для HTTP-трафика:

       • http_match — (опционально) параметр для фильтрации входящих HTTP-запросов:

         • http_method — (опционально) список HTTP-методов, запросы с которыми будут маршрутизироваться. По умолчанию маршрутизируются запросы с любыми методами.

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

           • exact — маршрутизировать запросы, путь в которых идентичен заданному пути. Например, чтобы маршрутизировать все запросы, укажите путь /.
           • prefix — маршрутизировать запросы, путь в которых начинается с заданного префикса.
           • regex — маршрутизировать запросы, путь в которых удовлетворяет заданному регулярному выражению стандарта RE2. Например: \/[a-z]{10}[0-9]{3}\/.

           Параметры exact, prefix и regex — взаимоисключающие: вы можете использовать только один из них.

       • http_route_action — параметр для указания действия с HTTP-трафиком.

         • backend_group_id — идентификатор группы бэкендов, расположенной в том же каталоге, в котором находятся HTTP-роутер и виртуальный хост, для которых создается маршрут.
         • host_rewrite — (опционально) замена заголовка Host в запросе на указанное значение. Вместо параметра host_rewrite вы можете указать параметр auto_host_rewrite — в этом случае заголовок Host в запросе автоматически будет заменяться на адрес целевой виртуальной машины.
         • timeout — (опционально) максимальное время, на которое может быть установлено соединение, в секундах. Значение по умолчанию — 60 секунд.
         • idle_timeout — (опционально) максимальное время keep-alive, в течение которого соединение может простаивать без передачи данных. Если не задано, соединение без передачи данных будет сразу разрываться.
         • prefix_rewrite — (опционально) значение, на которое будет заменен путь или часть пути запроса, указанные в параметре path.

         • rate_limit — (опционально) параметр для ограничения количества запросов за единицу времени:

           • all_requests — (опционально) ограничение на все входящие запросы:

             • per_second — максимальное количество входящих запросов, которые могут поступать в маршрут за одну секунду.
             • per_minute — максимальное количество входящих запросов, которые могут поступать в маршрут за одну минуту.

             Параметры per_second и per_minute — взаимоисключающие: вы можете использовать только один из них.

           • requests_per_ip — (опционально) ограничение на входящие запросы с одного IP-адреса:

             • per_second — максимальное количество входящих запросов с одного IP-адреса, которые могут поступать в маршрут за одну секунду.
             • per_minute — максимальное количество входящих запросов с одного IP-адреса, которые могут поступать в маршрут за одну минуту.

             Параметры per_second и per_minute — взаимоисключающие: вы можете использовать только один из них.

   ...
   route {
     name                      = "<имя_маршрута>"
     disable_security_profile  = true|false
   
     grpc_route {
       grpc_match {
         fqmn {
           prefix = "/<префикс_FQMN_запроса>"
           # или exact = "<FQMN_запроса>"
           # или regex = "<регулярное_выражение>"
         }
       }
   
       grpc_route_action {
         backend_group_id = "<идентификатор_группы_бэкендов>"
         host_rewrite = "<значение_заголовка_Host>"
         max_timeout = "<таймаут_соединения>s"
         idle_timeout = "<таймаут-простоя>s"
         rate_limit {
           all_requests {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
           requests_per_ip {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
         }
       }
     }
   }
   ...
   

   Где:

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

     • name — имя маршрута.
     • disable_security_profile — (опционально) опция отключения профиля безопасности сервиса Yandex Smart Web Security. Возможные значения: true (профиль отключен) или false (профиль включен). По умолчанию профиль безопасности включен (значение false).

     • grpc_route — описание маршрута для gRPC-трафика:

       • grpc_match.fqmn — (опционально) параметр для фильтрации входящих gRPC-запросов по FQMN:

         • exact — маршрутизировать запросы, FQMN в которых идентичен заданному.
         • prefix — маршрутизировать запросы, FQMN в которых начинается с заданного префикса. Например, вы можете указать первое слово в имени сервиса: /helloworld.
         • regex — маршрутизировать запросы, FQMN в которых удовлетворяет заданному регулярному выражению стандарта RE2. Например: \/[a-z]{10}[0-9]{3}.

         Параметры exact, prefix и regex — взаимоисключающие: вы можете использовать только один из них.

       • grpc_route_action — параметр для указания действия с gRPC-трафиком.

         • backend_group_id — идентификатор группы бэкендов, расположенной в том же каталоге, в котором находятся HTTP-роутер и виртуальный хост, для которых создается маршрут.
         • host_rewrite — (опционально) замена заголовка Host в запросе на указанное значение. Вместо параметра host_rewrite вы можете указать параметр auto_host_rewrite — в этом случае заголовок Host в запросе автоматически будет заменяться на адрес целевой виртуальной машины.
         • max_timeout — (опционально) максимальный таймаут ожидания запроса в секундах. Клиент может указать в запросе HTTP-заголовок grpc-timeout с меньшим значением таймаута. Значение по умолчанию — 60 секунд.
         • idle_timeout — (опционально) максимальное время keep-alive, в течение которого соединение может простаивать без передачи данных. Если не задано, соединение без передачи данных будет сразу разрываться.

         • rate_limit — (опционально) параметр для ограничения количества запросов за единицу времени:

           • all_requests — (опционально) ограничение на все входящие запросы:

             • per_second — максимальное количество входящих запросов, которые могут поступать в маршрут за одну секунду.
             • per_minute — максимальное количество входящих запросов, которые могут поступать в маршрут за одну минуту.

             Параметры per_second и per_minute — взаимоисключающие: вы можете использовать только один из них.

           • requests_per_ip — (опционально) ограничение на входящие запросы с одного IP-адреса:

             • per_second — максимальное количество входящих запросов с одного IP-адреса, которые могут поступать в маршрут за одну секунду.
             • per_minute — максимальное количество входящих запросов с одного IP-адреса, которые могут поступать в маршрут за одну минуту.

             Параметры per_second и per_minute — взаимоисключающие: вы можете использовать только один из них.

   Более подробную информацию о параметрах используемых ресурсов в Terraform см. в документации провайдера: 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 virtual-host get <имя_виртуального_хоста> \
     --http-router-name <имя_HTTP-роутера>
   

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

   Провайдер Terraform ограничивает время на выполнение операций с HTTP-роутерами и виртуальными хостами Application Load Balancer 10 минутами.

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

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

   Добавьте к описанию HTTP-роутера и виртуального хоста блоки timeouts (ресурсы yandex_alb_http_router и yandex_alb_virtual_host соответственно).

   Пример:

   resource "yandex_alb_http_router" "<имя_роутера>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
       delete = "60m"
     }
   }
   

Воспользуйтесь методом REST API update для ресурса VirtualHost или вызовом gRPC API VirtualHostService/Update.

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

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

С помощью Yandex Cloud CLI вы можете изменять в виртуальном хосте разные типы маршрутов:

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

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

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

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

1. Измените в конфигурационном файле параметры маршрута как ресурса, вложенного в ресурс типа yandex_alb_virtual_host. С помощью Terraform вы можете изменять в виртуальном хосте разные типы маршрутов:

   HTTP

   gRPC

   ...
   route {
     name                      = "<имя_маршрута>"
     disable_security_profile  = true|false
   
     http_route {
       http_match {
         http_method = ["<HTTP-метод_1>","<HTTP-метод_2>",...,"<HTTP-метод_n>"]
         path {
           prefix = "/<префикс_пути_запроса>/"
           # или exact = "<путь_запроса>"
           # или regex = "<регулярное_выражение>"
         }
       }
   
       http_route_action {
         backend_group_id  = "<идентификатор_группы_бэкендов>"
         host_rewrite      = "<значение_заголовка_Host>"
         timeout           = "<таймаут_соединения>s"
         idle_timeout      = "<таймаут-простоя>s"
         prefix_rewrite    = "<новый_префикс_пути_запроса>/"
         rate_limit {
           all_requests {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
           requests_per_ip {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
         }
       }
     }
   }
   ...
   

   Где:

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

     • name — имя маршрута.
     • disable_security_profile — (опционально) опция отключения профиля безопасности сервиса Yandex Smart Web Security. Возможные значения: true (профиль отключен) или false (профиль включен). По умолчанию профиль безопасности включен (значение false).

     • http_route — описание маршрута для HTTP-трафика:

       • http_match — (опционально) параметр для фильтрации входящих HTTP-запросов:

         • http_method — (опционально) список HTTP-методов, запросы с которыми будут маршрутизироваться. По умолчанию маршрутизируются запросы с любыми методами.

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

           • exact — маршрутизировать запросы, путь в которых идентичен заданному пути. Например, чтобы маршрутизировать все запросы, укажите путь /.
           • prefix — маршрутизировать запросы, путь в которых начинается с заданного префикса.
           • regex — маршрутизировать запросы, путь в которых удовлетворяет заданному регулярному выражению стандарта RE2. Например: \/[a-z]{10}[0-9]{3}\/.

           Параметры exact, prefix и regex — взаимоисключающие: вы можете использовать только один из них.

       • http_route_action — параметр для указания действия с HTTP-трафиком.

         • backend_group_id — идентификатор группы бэкендов, расположенной в том же каталоге, в котором находятся HTTP-роутер и виртуальный хост, для которых создается маршрут.
         • host_rewrite — (опционально) замена заголовка Host в запросе на указанное значение. Вместо параметра host_rewrite вы можете указать параметр auto_host_rewrite — в этом случае заголовок Host в запросе автоматически будет заменяться на адрес целевой виртуальной машины.
         • timeout — (опционально) максимальное время, на которое может быть установлено соединение, в секундах. Значение по умолчанию — 60 секунд.
         • idle_timeout — (опционально) максимальное время keep-alive, в течение которого соединение может простаивать без передачи данных. Если не задано, соединение без передачи данных будет сразу разрываться.
         • prefix_rewrite — (опционально) значение, на которое будет заменен путь или часть пути запроса, указанные в параметре path.

         • rate_limit — (опционально) параметр для ограничения количества запросов за единицу времени:

           • all_requests — (опционально) ограничение на все входящие запросы:

             • per_second — максимальное количество входящих запросов, которые могут поступать в маршрут за одну секунду.
             • per_minute — максимальное количество входящих запросов, которые могут поступать в маршрут за одну минуту.

             Параметры per_second и per_minute — взаимоисключающие: вы можете использовать только один из них.

           • requests_per_ip — (опционально) ограничение на входящие запросы с одного IP-адреса:

             • per_second — максимальное количество входящих запросов с одного IP-адреса, которые могут поступать в маршрут за одну секунду.
             • per_minute — максимальное количество входящих запросов с одного IP-адреса, которые могут поступать в маршрут за одну минуту.

             Параметры per_second и per_minute — взаимоисключающие: вы можете использовать только один из них.

   ...
   route {
     name                      = "<имя_маршрута>"
     disable_security_profile  = true|false
   
     grpc_route {
       grpc_match {
         fqmn {
           prefix = "/<префикс_FQMN_запроса>"
           # или exact = "<FQMN_запроса>"
           # или regex = "<регулярное_выражение>"
         }
       }
   
       grpc_route_action {
         backend_group_id = "<идентификатор_группы_бэкендов>"
         host_rewrite = "<значение_заголовка_Host>"
         max_timeout = "<таймаут_соединения>s"
         idle_timeout = "<таймаут-простоя>s"
         rate_limit {
           all_requests {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
           requests_per_ip {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
         }
       }
     }
   }
   ...
   

   Где:

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

     • name — имя маршрута.
     • disable_security_profile — (опционально) опция отключения профиля безопасности сервиса Yandex Smart Web Security. Возможные значения: true (профиль отключен) или false (профиль включен). По умолчанию профиль безопасности включен (значение false).

     • grpc_route — описание маршрута для gRPC-трафика:

       • grpc_match.fqmn — (опционально) параметр для фильтрации входящих gRPC-запросов по FQMN:

         • exact — маршрутизировать запросы, FQMN в которых идентичен заданному.
         • prefix — маршрутизировать запросы, FQMN в которых начинается с заданного префикса. Например, вы можете указать первое слово в имени сервиса: /helloworld.
         • regex — маршрутизировать запросы, FQMN в которых удовлетворяет заданному регулярному выражению стандарта RE2. Например: \/[a-z]{10}[0-9]{3}.

         Параметры exact, prefix и regex — взаимоисключающие: вы можете использовать только один из них.

       • grpc_route_action — параметр для указания действия с gRPC-трафиком.

         • backend_group_id — идентификатор группы бэкендов, расположенной в том же каталоге, в котором находятся HTTP-роутер и виртуальный хост, для которых создается маршрут.
         • host_rewrite — (опционально) замена заголовка Host в запросе на указанное значение. Вместо параметра host_rewrite вы можете указать параметр auto_host_rewrite — в этом случае заголовок Host в запросе автоматически будет заменяться на адрес целевой виртуальной машины.
         • max_timeout — (опционально) максимальный таймаут ожидания запроса в секундах. Клиент может указать в запросе HTTP-заголовок grpc-timeout с меньшим значением таймаута. Значение по умолчанию — 60 секунд.
         • idle_timeout — (опционально) максимальное время keep-alive, в течение которого соединение может простаивать без передачи данных. Если не задано, соединение без передачи данных будет сразу разрываться.

         • rate_limit — (опционально) параметр для ограничения количества запросов за единицу времени:

           • all_requests — (опционально) ограничение на все входящие запросы:

             • per_second — максимальное количество входящих запросов, которые могут поступать в маршрут за одну секунду.
             • per_minute — максимальное количество входящих запросов, которые могут поступать в маршрут за одну минуту.

             Параметры per_second и per_minute — взаимоисключающие: вы можете использовать только один из них.

           • requests_per_ip — (опционально) ограничение на входящие запросы с одного IP-адреса:

             • per_second — максимальное количество входящих запросов с одного IP-адреса, которые могут поступать в маршрут за одну секунду.
             • per_minute — максимальное количество входящих запросов с одного IP-адреса, которые могут поступать в маршрут за одну минуту.

             Параметры per_second и per_minute — взаимоисключающие: вы можете использовать только один из них.

   Более подробную информацию о параметрах используемых ресурсов в Terraform см. в документации провайдера: 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 virtual-host get <имя_виртуального_хоста> \
     --http-router-name <имя_HTTP-роутера>
   

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

   Провайдер Terraform ограничивает время на выполнение операций с HTTP-роутерами и виртуальными хостами Application Load Balancer 10 минутами.

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

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

   Добавьте к описанию HTTP-роутера и виртуального хоста блоки timeouts (ресурсы yandex_alb_http_router и yandex_alb_virtual_host соответственно).

   Пример:

   resource "yandex_alb_http_router" "<имя_роутера>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
       delete = "60m"
     }
   }
   

Воспользуйтесь методом REST API updateRoute для ресурса VirtualHost или вызовом gRPC API VirtualHostService/UpdateRoute.

В Yandex Cloud CLI в настоящий момент нет отдельной команды, позволяющей изменять порядок маршрутов в виртуальном хосте.

Чтобы изменить порядок маршрутов с помощью CLI, воспользуйтесь следующим порядком действий:

1. Удалите нужный маршрут из виртуального хоста.
2. Заново добавьте маршрут в нужное место в списке маршрутов.

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

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

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

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

1. Измените в конфигурационном файле порядок маршрутов как ресурсов, вложенных в ресурс типа yandex_alb_virtual_host.

   Пример конфигурации виртуального хоста:

   resource "yandex_alb_virtual_host" "my-virtual-host" {
     name           = "test-virtual-host"
     http_router_id = "ds76j5n6a39g********"
   
     rate_limit {
       all_requests {
         per_second = 5
       }
       requests_per_ip {
         per_second = 3
       }
     }
   
     route {
       name = "my-first-http-route"
       disable_security_profile = false
   
       http_route {
         http_match {
           http_method = ["GET","POST"]
           path {
             prefix = "/myapp/"
           }
         }
   
         http_route_action {
           backend_group_id = "ds7dnf2s5dco********"
           host_rewrite = "myapp"
           idle_timeout = "3s"
           prefix_rewrite = "/yourapp/"
           rate_limit {
             all_requests {
               per_second = 12
             }
             requests_per_ip {
               per_minute = 120
             }
           }
           timeout = "10s"
         }
       }
     }
   
     route {
       name = "my-first-grpc-route"
       disable_security_profile = false
   
       grpc_route {
         grpc_match {
           fqmn {
             prefix = "/"
           }
         }
   
         grpc_route_action {
           backend_group_id = "ds7dq9nsrgpc********"
           host_rewrite = "myapp"
           idle_timeout = "5s"
           max_timeout = "10s"
           rate_limit {
             all_requests {
               per_minute = 0
               per_second = 12
             }
             requests_per_ip {
               per_minute = 0
               per_second = 6
             }
           }
         }
       }
     }
   
     authority        = ["example.com"]
   
     modify_request_headers {
       name           = "Accept-Language"
       append         = "ru-RU"
     }
   
     modify_response_headers {
       name           = "Accept-Language"
       append         = "ru-RU"
     }
   
     route_options {
       security_profile_id = "fevu5fnuk6vf********"
     }
   }
   

   Информацию о параметрах используемых ресурсов в Terraform см. в документации провайдера: 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 virtual-host get <имя_виртуального_хоста> \
     --http-router-name <имя_HTTP-роутера>
   

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

   Провайдер Terraform ограничивает время на выполнение операций с HTTP-роутерами и виртуальными хостами Application Load Balancer 10 минутами.

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

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

   Добавьте к описанию HTTP-роутера и виртуального хоста блоки timeouts (ресурсы yandex_alb_http_router и yandex_alb_virtual_host соответственно).

   Пример:

   resource "yandex_alb_http_router" "<имя_роутера>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
       delete = "60m"
     }
   }
   

Воспользуйтесь методом REST API update для ресурса VirtualHost или вызовом gRPC API VirtualHostService/Update.

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

   ...
   route {
     name                      = "<имя_маршрута>"
     disable_security_profile  = true|false
   
     http_route {
       http_match {
         http_method = ["<HTTP-метод_1>","<HTTP-метод_2>",...,"<HTTP-метод_n>"]
         path {
           prefix = "/api/users/"
           # или exact = "<путь_запроса>"
           # или regex = "<регулярное_выражение>"
         }
       }
   
       http_route_action {
         backend_group_id  = "ds7m9iupbcaq********"
         host_rewrite      = "<значение_заголовка_Host>"
         timeout           = "<таймаут_соединения>s"
         idle_timeout      = "<таймаут-простоя>s"
         regex_rewrite {
           regex      = "^/api/users/(.*)"
           substitute = "/api/v1/users/\\1"
         }
         rate_limit {
           all_requests {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
           requests_per_ip {
             per_second = <количество_запросов_в_секунду>
             # или per_minute = <количество_запросов_в_минуту>
           }
         }
       }
     }
   }
   ...
   

   Где:

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

     • http_route — описание маршрута для HTTP-трафика:

       • path — параметр для фильтрации пути входящего запроса:

         • prefix — фильтр с указанием префикса пути, по которому будут отбираться запросы, поступающие в создаваемый маршрут.

     • http_route_action — параметр для указания действия с HTTP-трафиком:

       • backend_group_id — идентификатор группы бэкендов, в которой доступен старый API-интерфейс.

       • regex_rewrite — параметр, задающий настройки замены в пути HTTP-запроса:

         • regex — регулярное выражение стандарта RE2, при соответствии которому строка пути запроса будет изменена. В приведенном примере регулярное выражение описывает путь, начинающийся с префикса /api/users/, после которого следует любое количество любых символов (или не следует ничего). При этом все, что следует после префикса, сохраняется в группу (карман).
         • substitute — строка, на которую будет заменен путь, соответствующий регулярному выражению, которое задано в свойстве regex. В приведенном примере путь будет заменен на строку, состоящую из префикса /api/v1/users/ и содержимого группы (кармана), которое было сохранено в регулярном выражении.

       Примечание

       Параметры regex_rewrite и prefix_rewrite — взаимоисключающие: вы можете использовать только один из них.

     Более подробную информацию о параметрах используемых ресурсов в Terraform см. в документации провайдера: 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 virtual-host get <имя_виртуального_хоста> \
     --http-router-name <имя_HTTP-роутера>
   

Чтобы модифицировать параметры HTTP-запроса в маршруте виртуального хоста, при создании или изменении маршрута для HTTP-трафика задайте необходимые настройки замены в поле regexRewrite (для REST API) или regex_rewrite (для gRPC API).

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

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

С помощью Yandex Cloud CLI вы можете удалять из виртуального хоста разные типы маршрутов:

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

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

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

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

1. Удалите в конфигурационном файле описание маршрута как ресурса, вложенного в ресурс типа yandex_alb_virtual_host.

   Пример конфигурации виртуального хоста:

   resource "yandex_alb_virtual_host" "my-virtual-host" {
     name           = "test-virtual-host"
     http_router_id = "ds76j5n6a39g********"
   
     rate_limit {
       all_requests {
         per_second = 5
       }
       requests_per_ip {
         per_second = 3
       }
     }
   
     route {
       name = "my-first-http-route"
       disable_security_profile = false
   
       http_route {
         http_match {
           http_method = ["GET","POST"]
           path {
             prefix = "/myapp/"
           }
         }
   
         http_route_action {
           backend_group_id = "ds7dnf2s5dco********"
           host_rewrite = "myapp"
           idle_timeout = "3s"
           prefix_rewrite = "/yourapp/"
           rate_limit {
             all_requests {
               per_second = 12
             }
             requests_per_ip {
               per_minute = 120
             }
           }
           timeout = "10s"
         }
       }
     }
   
     route {
       name = "my-first-grpc-route"
       disable_security_profile = false
   
       grpc_route {
         grpc_match {
           fqmn {
             prefix = "/"
           }
         }
   
         grpc_route_action {
           backend_group_id = "ds7dq9nsrgpc********"
           host_rewrite = "myapp"
           idle_timeout = "5s"
           max_timeout = "10s"
           rate_limit {
             all_requests {
               per_minute = 0
               per_second = 12
             }
             requests_per_ip {
               per_minute = 0
               per_second = 6
             }
           }
         }
       }
     }
   
     authority        = ["example.com"]
   
     modify_request_headers {
       name           = "Accept-Language"
       append         = "ru-RU"
     }
   
     modify_response_headers {
       name           = "Accept-Language"
       append         = "ru-RU"
     }
   
     route_options {
       security_profile_id = "fevu5fnuk6vf********"
     }
   }
   

   Информацию о параметрах используемых ресурсов в Terraform см. в документации провайдера: 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 virtual-host get <имя_виртуального_хоста> \
     --http-router-name <имя_HTTP-роутера>
   

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

   Провайдер Terraform ограничивает время на выполнение операций с HTTP-роутерами и виртуальными хостами Application Load Balancer 10 минутами.

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

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

   Добавьте к описанию HTTP-роутера и виртуального хоста блоки timeouts (ресурсы yandex_alb_http_router и yandex_alb_virtual_host соответственно).

   Пример:

   resource "yandex_alb_http_router" "<имя_роутера>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
       delete = "60m"
     }
   }
   

Воспользуйтесь методом REST API removeRoute для ресурса VirtualHost или вызовом gRPC API VirtualHostService/RemoveRoute.