Change HTTP router parameters

Written by

Yandex Cloud

Adding a route to a virtual host

To change the HTTP router parameters:

Management console

CLI

Terraform

In the management console, select the folder where the HTTP router was created.
Select Application Load Balancer.
On the left-hand panel, select HTTP routers.
Click on the name of the router you need.
Click Edit.
Edit the router settings.
At the bottom of the page, click Save.

If you don't have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

View a description of the CLI command to update a load balancer:
```
yc alb http-router update --help
```

Run the command, indicating the new router parameters:

yc alb http-router update <HTTP router name> --new-name <new HTTP router name>

Result:

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

For more information about Terraform, see the documentation.

Open the Terraform configuration file and edit the fragment with the HTTP router description.
```
...
resource "yandex_alb_http_router" "tf-router" {
  name   = "my-http-router"
  labels = {
    tf-label    = "tf-label-value"
    empty-label = ""
  }
}
...
```
For more information about the yandex_alb_http_router resource in Terraform, see the provider documentation.

To add, update, or delete an HTTP router's virtual hosts, use the yandex_alb_virtual_host resource indicating the router in the 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"
    http_route {
      http_route_action {
        backend_group_id = "${yandex_alb_backend_group.backend-group.id}"
        timeout          = "3s"
      }
    }
  }
}

For more information about the yandex_alb_virtual_host resource in Terraform, see the provider documentation.

Check the configuration using the command:
```
terraform validate
```
If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
Run the command:
```
terraform plan
```
The terminal will display a list of resources with parameters. No changes are made at this step. If there are errors in the configuration, Terraform points them out.
Apply the configuration changes:
```
terraform apply
```
Confirm the changes: type yes into the terminal and press Enter.

You can verify the change to the HTTP router using the management console or the following CLI command:
```
yc alb http-router get <HTTP router ID>
```

Adding a route to a virtual host

To add a new route to an HTTP router's virtual host:

Management console

CLI

Terraform

In the management console, select the folder where the HTTP router was created.
Select Application Load Balancer.
On the left-hand panel, select HTTP routers.
Click on the name of the router you need.
Click Edit.
Click Add route.
Set the route parameters and click Save.

If you don't have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

See the description of the CLI command for managing virtual hosts:

yc alb virtual-host --help

You can add a new route to the beginning, end, or specific position in the host's route list.

Add a route to the end of a host's route list

View a description of the CLI command for adding a route to the end of a host's route list:
```
yc alb virtual-host append-http-route --help
```

Run the command:

yc alb virtual-host append-http-route <route name> \
  --virtual-host-name <virtual host name> \
  --http-router-name <HTTP router name> \
  --match-http-method GET \
  --exact-path-match / \
  --backend-group-name <backend group name> \
  --request-timeout <request timeout>s \
  --request-idle-timeout <request idle timeout>s

Result:

name: test-virtual-host
authority:
- your-domain.foo.com
routes:
- name: test-route
  http:
    match:
      path:
        prefix_match: /
    route:
      backend_group_id: a5d3e9ko2qf0tbk0s27b
      timeout: 2s
      idle_timeout: 3s
- name: test-route-toend
...

Add a route to the beginning of a host's route list

View a description of the CLI command for adding a route to the beginning of a host's route list:
```
yc alb virtual-host prepend-http-route --help
```

Run the command:

yc alb virtual-host prepend-http-route <route name> \
  --virtual-host-name <virtual host name> \
  --http-router-name <HTTP router name> \
  --match-http-method GET \
  --exact-path-match / \
  --backend-group-name <backend group name> \
  --request-timeout <request timeout>s \
  --request-idle-timeout <request idle timeout>s

Result:

name: test-virtual-host
authority:
- your-domain.foo.com
routes:
- name: test-route-tostart
  http:
    match:
      http_method:
      - GET
      path:
        exact_match: /
    route:
      backend_group_id: a5d3e9ko2qf0tbk0s27b
      timeout: 2s
      idle_timeout: 3s
- name: test-route
...

Add a route before a specific route

View a description of the CLI command for adding a route before a specific route:
```
yc alb virtual-host insert-http-route --help
```

Run the command:

yc alb virtual-host insert-http-route <route name> \
  --virtual-host-name <virtual host name> \
  --before <name of the route to add a new route before> \
  --http-router-name <HTTP router name> \
  --match-http-method GET \
  --exact-path-match / \
  --backend-group-name <backend group name> \
  --request-timeout <request timeout>s \
  --request-idle-timeout <request idle timeout>s

Result:

done (2s)
name: test-virtual-host
authority:
- your-domain.foo.com
routes:
- name: test-route-insbefore
  http:
    match:
      http_method:
      - GET
      path:
        exact_match: /
    route:
      backend_group_id: a5d3e9ko2qf0tbk0s27b
      timeout: 2s
      idle_timeout: 3s
- name: test-route
...

Add a route after a specific route

View a description of the CLI command for adding a new route after a specific route:
```
yc alb virtual-host insert-http-route --help
```

Run the command:

yc alb virtual-host insert-http-route <route name> \
  --virtual-host-name <virtual host name> \
  --after <name of the route to add a new route after> \
  --http-router-name <HTTP router name> \
  --match-http-method GET \
  --exact-path-match / \
  --backend-group-name <backend group name> \
  --request-timeout <request timeout>s \
  --request-idle-timeout <request idle timeout>s

Result:

done (2s)
name: test-virtual-host
authority:
- your-domain.foo.com
routes:
- name: test-route
  http:
    match:
      path:
        prefix_match: /
    route:
      backend_group_id: a5d3e9ko2qf0tbk0s27b
      timeout: 2s
      idle_timeout: 3s
- name: test-route-insafter
...

For more information about Terraform, see the documentation.

Open the Terraform configuration file and edit the fragment with the virtual host description by adding the route section:

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 the yandex_alb_virtual_host resource in Terraform, see the provider documentation.

The sequence of routes inside a virtual host description matters. For more information, see the concept.

Check the configuration using the command:
```
terraform validate
```
If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
Run the command:
```
terraform plan
```
The terminal will display a list of resources with parameters. No changes are made at this step. If there are errors in the configuration, Terraform points them out.
Apply the configuration changes:
```
terraform apply
```
Confirm the changes: type yes into the terminal and press Enter.

You can verify the change to the virtual host using the management console or the following CLI command:
```
yc alb virtual-host get <virtual host ID>
```

Change HTTP router parameters

Adding a route to a virtual host

Was the article helpful?