Updating HTTP router settings

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

1. View a description of the CLI command to update a load balancer:

   yc alb http-router update --help
   

2. Run this command with new router settings specified:

   yc alb http-router update <HTTP_router_name> --new-name <new_name_for_HTTP_router>
   

   Result:

   id: a5dld80l32ed********
   name: new-http-router
   folder_id: aoe197919j8e********
   virtual_hosts:
   - name: test-virtual-host
     authority:
     - your-domain.foo.com
     routes:
     - name: test-route
       http:
         match:
           path:
             prefix_match: /
         route:
           backend_group_id: a5d4db973944********
           timeout: 2s
           idle_timeout: 3s
     modify_request_headers:
     - name: Accept-Language
       append: ru-RU
   created_at: "2021-02-11T21:31:01.676592016Z"
   

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. Open the Terraform configuration file and edit the fragment describing your HTTP router.

   ...
   resource "yandex_alb_http_router" "tf-router" {
     name   = "my-http-router"
     labels = {
       tf-label    = "tf-label-value"
       empty-label = ""
     }
   }
   ...
   

   For more information about yandex_alb_http_router properties, see this Terraform article.

2. To add, update, or delete HTTP router virtual hosts, use the yandex_alb_virtual_host resource with your router ID specified in its http_router_id field:

   resource "yandex_alb_virtual_host" "my-virtual-host" {
     name           = "my-virtual-host"
     http_router_id = "${yandex_alb_http_router.tf-router.id}"
     route {
       name                     = "my-route"
       disable_security_profile = true|false
       http_route {
         http_route_action {
           backend_group_id = "${yandex_alb_backend_group.backend-group.id}"
           timeout          = "3s"
         }
       }
     }
   }
   

   For more information about yandex_alb_virtual_host properties, see this Terraform article.

3. Apply the changes:

   1. In the terminal, go to the directory where you edited the configuration file.

   2. Make sure the configuration file is correct using this command:

      terraform validate
      

      If the configuration is correct, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will update all required resources. You can check the HTTP router update using the management console or this CLI command:

   yc alb http-router get <HTTP_router_ID>
   

   Timeouts

   The Terraform provider limits the execution time for operations with Application Load Balancer HTTP routers and virtual hosts to 10 minutes.

   Operations in excess of this time will be interrupted.

   How do I modify these limits?

   Add the timeouts section to the descriptions of the HTTP router and virtual host (the yandex_alb_http_router and yandex_alb_virtual_host resources, respectively).

   Here is an example:

   resource "yandex_alb_http_router" "<router_name>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
       delete = "60m"
     }
   }
   

Use the update REST API method for the HttpRouter resource or the HttpRouterService/Update gRPC API call.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

With the Yandex Cloud CLI, you can add different types of routes to the virtual host:

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. In the configuration file, describe the parameters of the route as a resource nested in a yandex_alb_virtual_host resource. With Terraform, you can add different types of routes to the virtual host:

   HTTP

   gRPC

   ...
   route {
     name                      = "<route_name>"
     disable_security_profile  = true|false
   
     http_route {
       http_match {
         http_method = ["<HTTP_method_1>","<HTTP_method_2>",...,"<HTTP_method_n>"]
         path {
           prefix = "/<request_path_prefix>/"
           # or exact = "<request_path>"
           # or regex = "<regular_expression>"
         }
       }
   
       http_route_action {
         backend_group_id  = "<backend_group_ID>"
         host_rewrite      = "<Host_header_value>"
         timeout           = "<connection_timeout>s"
         idle_timeout      = "<idle_timeout>s"
         prefix_rewrite    = "<new_request_path_prefix>/"
         rate_limit {
           all_requests {
             per_second = <requests_per_second>
             # or per_minute = <requests_per_minute>
           }
           requests_per_ip {
             per_second = <requests_per_second>
             # or per_minute = <requests_per_minute>
           }
         }
       }
     }
   }
   ...
   

   Where:

   • route: Virtual host route description:

     • name: Route name.
     • disable_security_profile: Disabling the Yandex Smart Web Security security profile (optional). The possible values are true (the profile is disabled) or false (the profile is enabled). The default value is false: the security profile is enabled.

     • http_route: Route description for HTTP traffic:

       • http_match: Parameter for filtering incoming HTTP requests (optional):

         • http_method: List of HTTP methods for which requests will be routed (optional). By default, requests with any methods are routed.

         • path: Optionally, parameters for filtering the path of an incoming request:

           • exact: Route requests with the same path as the specified one. For example, to route all requests, specify the / path.
           • prefix: Route requests whose path starts with the specified prefix.
           • regex: Route requests whose path matches the specified RE2 regular expression, e.g., \/[a-z]{10}[0-9]{3}\/.

           The exact, prefix, and regex parameters are mutually exclusive: you can use only one of them.

       • http_route_action: Action applied to HTTP traffic.

         • backend_group_id: ID of the backend group located in the same folder as the HTTP router and virtual host of the new route.
         • host_rewrite: Replacing the Host header in the request with the specified value (optional). You specify the auto_host_rewrite parameter instead of the host_rewrite parameter; in this case the Host header in the request will be automatically replaced with the address of the target VM.
         • timeout: Maximum connection time in seconds (optional). The default value is 60 seconds.
         • idle_timeout: Maximum connection idle timeout (keep-alive time) (optional). If not specified, the idle connection will be terminated immediately.
         • prefix_rewrite: Value to replace the path or part of the path specified in the path parameter (optional).

         • rate_limit: Limits the number of requests per unit of time (optional):

           • all_requests: Limits all incoming requests (optional):

             • per_second: Maximum number of incoming requests to a route per second.
             • per_minute: Maximum number of incoming requests to a route per minute.

             The per_second, and per_minute parameters are mutually exclusive: you can use only one of them.

           • requests_per_ip: Limits incoming requests from a single IP address (optional):

             • per_second: Maximum number of incoming requests to a route from a single IP address per second.
             • per_minute: Maximum number of incoming requests to a route from a single IP address per minute.

             The per_second, and per_minute parameters are mutually exclusive: you can use only one of them.

   ...
   route {
     name                      = "<route_name>"
     disable_security_profile  = true|false
   
     grpc_route {
       grpc_match {
         fqmn {
           prefix = "/<request_FQMN_prefix>"
           # or exact = "<request_FQMN>"
           # or regex = "<regular_expression>"
         }
       }
   
       grpc_route_action {
         backend_group_id = "<backend_group_ID>"
         host_rewrite = "<Host_header_value>"
         max_timeout = "<connection_timeout>s"
         idle_timeout = "<idle_timeout>s"
         rate_limit {
           all_requests {
             per_second = <requests_per_second>
             # or per_minute = <requests_per_minute>
           }
           requests_per_ip {
             per_second = <requests_per_second>
             # or per_minute = <requests_per_minute>
           }
         }
       }
     }
   }
   ...
   

   Where:

   • route: Virtual host route description:

     • name: Route name.
     • disable_security_profile: Disabling the Yandex Smart Web Security security profile (optional). The possible values are true (the profile is disabled) or false (the profile is enabled). The default value is false: the security profile is enabled.

     • grpc_route: Route description for gRPC traffic:

       • grpc_match.fqmn: Parameter for filtering incoming gRPC requests by FQMN (optional):

         • exact: Route requests with the same FQMN as the specified one.
         • prefix: Route requests whose FQMN starts with the specified prefix. For example, you can specify the first word of the service name: /helloworld.
         • regex: Route requests whose FQMN matches the specified RE2 regular expression. For example: \/[a-z]{10}[0-9]{3}.

         The exact, prefix, and regex parameters are mutually exclusive: you can use only one of them.

       • grpc_route_action: Action applied to gRPC traffic.

         • backend_group_id: ID of the backend group located in the same folder as the new route's HTTP router and virtual host.
         • host_rewrite: Replacing the Host header in the request with the specified value (optional). You can specify auto_host_rewrite instead of host_rewrite, in which case the Host header in the request will be automatically replaced with the target VM address.
         • --request-max-timeout: Maximum request timeout in seconds (optional). You can specify a shorter timeout in the grpc-timeout request HTTP header. The default value is 60 seconds.
         • idle_timeout: Maximum connection idle timeout (keep-alive time) (optional). If not specified, the idle connection will be terminated immediately.

         • rate_limit: Limits the number of requests per unit of time (optional):

           • all_requests: Limits all incoming requests (optional):

             • per_second: Maximum number of incoming requests to a route per second.
             • per_minute: Maximum number of incoming requests to a route per minute.

             The per_second, and per_minute parameters are mutually exclusive: you can use only one of them.

           • requests_per_ip: Limits incoming requests from a single IP address (optional):

             • per_second: Maximum number of incoming requests to a route from a single IP address per second.
             • per_minute: Maximum number of incoming requests to a route from a single IP address per minute.

             The per_second, and per_minute parameters are mutually exclusive: you can use only one of them.

   Learn more about the properties of Terraform resources in the relevant provider guide: yandex_alb_virtual_host.

2. Create the resources:

   1. In the terminal, go to the directory where you edited the configuration file.

   2. Make sure the configuration file is correct using this command:

      terraform validate
      

      If the configuration is correct, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will create all the required resources. You can check the new resources and their settings using the management console or this CLI command:

   yc alb virtual-host get <virtual_host_name> \
     --http-router-name <HTTP_router_name>
   

   Timeouts

   The Terraform provider limits the execution time for operations with Application Load Balancer HTTP routers and virtual hosts to 10 minutes.

   Operations in excess of this time will be interrupted.

   How do I modify these limits?

   Add the timeouts section to the descriptions of the HTTP router and virtual host (the yandex_alb_http_router and yandex_alb_virtual_host resources, respectively).

   Here is an example:

   resource "yandex_alb_http_router" "<router_name>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
       delete = "60m"
     }
   }
   

Use the update REST API method for the VirtualHost resource or the VirtualHostService/Update gRPC API call.

The Yandex Cloud CLI currently does not have a dedicated command for reordering routes in a virtual host.

To reorder routes via the CLI, follow these steps:

1. Delete the route in question from the virtual host.
2. Add the route again to the appropriate place in the route list.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. In the configuration file, reorder the routes as resources nested in a yandex_alb_virtual_host resource.

   Example of a virtual host configuration:

   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********"
     }
   }
   

   Learn more about the properties of Terraform resources in the relevant provider guide: yandex_alb_virtual_host.

2. Update the resources:

   1. In the terminal, go to the directory where you edited the configuration file.

   2. Make sure the configuration file is correct using this command:

      terraform validate
      

      If the configuration is correct, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will create all the required resources. You can check the new resources as well as their order and settings using the management console or this CLI command:

   yc alb virtual-host get <virtual_host_name> \
     --http-router-name <HTTP_router_name>
   

   Timeouts

   The Terraform provider limits the execution time for operations with Application Load Balancer HTTP routers and virtual hosts to 10 minutes.

   Operations in excess of this time will be interrupted.

   How do I modify these limits?

   Add the timeouts section to the descriptions of the HTTP router and virtual host (the yandex_alb_http_router and yandex_alb_virtual_host resources, respectively).

   Here is an example:

   resource "yandex_alb_http_router" "<router_name>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
       delete = "60m"
     }
   }
   

Use the update REST API method for the VirtualHost resource or the VirtualHostService/Update gRPC API call.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

1. See the description of the CLI command for changing a route:

     yc alb virtual-host update-http-route --help
   

2. Run this command:

   yc alb virtual-host remove-http-route <route_name> \
     --virtual-host-name <virtual_host_name> \
     --http-router-name <router_name> \
     --request-timeout <timeout>
   

   Where --request-timeout is the new timeout value with the time unit, e.g., 120s.

   Result:

   name: host-one
   routes:
     - name: route-one
       http:
         match:
           path:
             prefix_match: /
         route:
           backend_group_id: ds7d6hg1dg24********
           timeout: 120s
           auto_host_rewrite: false
   

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. Open the Terraform configuration file and edit the value of the timeout parameter for the route in question:

   resource "yandex_alb_virtual_host" "my-virtual-host" {
     name           = "my-virtual-host"
     http_router_id = "${yandex_alb_http_router.tf-router.id}"
     route {
       name = "my-route"
       http_route {
         http_route_action {
           backend_group_id = "${yandex_alb_backend_group.backend-group.id}"
           timeout          = "3s"
         }
       }
     }
   }
   

   For more information about yandex_alb_virtual_host properties, see this Terraform article.

2. Apply the changes:

   1. In the terminal, go to the directory where you edited the configuration file.

   2. Make sure the configuration file is correct using this command:

      terraform validate
      

      If the configuration is correct, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will update all required resources. You can check virtual host updates in the management console or using this CLI command:

   yc alb virtual-host get <virtual_host_ID>
   

   Timeouts

   The Terraform provider limits the execution time for operations with Application Load Balancer HTTP routers and virtual hosts to 10 minutes.

   Operations in excess of this time will be interrupted.

   How do I modify these limits?

   Add the timeouts section to the descriptions of the HTTP router and virtual host (the yandex_alb_http_router and yandex_alb_virtual_host resources, respectively).

   Here is an example:

   resource "yandex_alb_http_router" "<router_name>" {
     ...
     timeouts {
       create = "60m"
       update = "60m"
       delete = "60m"
     }
   }
   

Use the update REST API method for the VirtualHost resource or the VirtualHostService/Update gRPC API call.