Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Editing a backend group

Written by
Updated at November 11, 2025

Update group basic settings

Note

To change the group type, you need to use different tools, such as the CLI, Terraform, API.

  1. In the management console, select the folder with your backend group.
  2. Select Application Load Balancer.
  3. In the left-hand panel, select Backend groups.
  4. Click your group name.
  5. Click Edit.
  6. Edit group settings:

    • Backend group Name and Description.

    • Session affinity: If you select this option, the same endpoint will process all requests within one user session.

      Note

      Currently, session affinity only works for a single active backend in a group, containing at least one target group and using the MAGLEV_HASH load balancing mode.

      HTTP and gRPC backend groups support the following session affinity modes:

      • By IP address.
      • By HTTP header.
      • By cookie.

      Stream backend groups only support session affinity by IP address.

      For more information about session affinity and its modes, see this section.

  7. Click Save at the bottom of the page.

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 updating backend group basic settings:

    yc alb backend-group update --help

  2. Run this command:

    yc alb backend-group update \
  --name <backend_group_name> \
  --new-name <new_backend_group_name> \
  --description <backend_group_description> \
  --labels key=value[,<key>=<label_value>] \
  --connection-affinity source-ip=<IP_address_session_affinity_mode>

    Where:

    • --name: Backend group name.

    • --new-name: Backend group new name. The naming requirements are as follows:

      • The name must be from 3 to 63 characters long.
      • It may contain uppercase and lowercase Latin and Cyrillic letters, numbers, hyphens, underscores, and spaces.
      • The first character must be a letter. The last character cannot be a hyphen, underscore, or space.

    • --description: Backend group description. This is an optional setting.

    • --labels key=value: Labels in key=value format. This is an optional setting.

    • --connection-affinity: Session affinity by the source-ip IP address. It can be either true or false. This is an optional setting. You can also use --cookie-affinity: cookie or --header-affinity: HTTP header session affinity modes, but you can only specify one mode. For Stream backend groups, you can only use --connection-affinity mode.

      Note

      Currently, session affinity only works for a single active backend in a group, containing at least one target group and using the MAGLEV_HASH load balancing mode.

    Result:

    id: ds7mi7mlqgct********
name: <backend_group_name>
description: update
folder_id: b1g6hif00bod********
labels:
  bar: buz
  foo: buz
http:
  backends:
  - name: <backend_name>
    backend_weight: "2"
    load_balancing_config:
      panic_threshold: "90"
    port: "80"
    target_groups:
      target_group_ids:
      - ds75pc3146dh********
    healthchecks:
    - timeout: 10s
      interval: 2s
      healthy_threshold: "10"
      unhealthy_threshold: "15"
      healthcheck_port: "80"
      http:
        host: <host_address>
        path: <path>
  connection:
    source_ip: true
created_at: "2022-11-30T17:46:05.599491104Z"

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. Open the Terraform configuration file and edit the fragment describing the backend group:

    resource "yandex_alb_backend_group" "test-backend-group" {
  name        = "<backend_group_name>"
  description = "<backend_group_description>"
  labels      = {
    new-label = "test-label"
  }
  session_affinity {
    connection {
      source_ip = <IP_address_session_affinity_mode>
    }
  }
...
}

    Where yandex_alb_backend_group includes backend group settings:

    • name: Backend group name.

    • description: Backend group description. This is an optional setting.

    • labels: Labels in key=value format. This is an optional setting.

    • session_affinity: Optional session affinity settings.

      Note

      Currently, session affinity only works for a single active backend in a group, containing at least one target group and using the MAGLEV_HASH load balancing mode.

      • connection: Session affinity by the source_ip IP address. It can be either true or false. You can also use cookie or header session affinity modes, but you can only specify one mode. For Stream backend groups consisting of stream_backend resources, you can only use the connection affinity mode.

    For more information about yandex_alb_backend_group properties, see the relevant 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.

    You can check backend group updates in the management console or using this CLI command:

    yc alb backend-group get --name <backend_group_name>

    Timeouts

    The Terraform provider limits operations with Application Load Balancer backend groups to 10 minutes.

    Operations in excess of this time will be interrupted.

    How do I modify these limits?

    Add a timeouts section to the backend group description:

    resource "yandex_alb_backend_group" "<backend_group_name>" {
  ...
  timeouts {
    create = "60m"
    update = "60m"
    delete = "60m"
  }
}

To change backend group basic settings, use the update REST API method for the BackendGroup resource or the BackendGroupService/Update gRPC API call.

Add a backend to a group

  1. In the management console, select the folder with your backend.

  2. Select Application Load Balancer.

  3. In the left-hand panel, select Backend groups.

  4. Click your group name.

  5. Click Create backend.

  6. In the window that opens, specify backend settings:

    • Backend Name.

    • Weight: Backend weight in traffic distribution. If this option is disabled, the backend weight will be 0 and its endpoints will not be receiving traffic.

    • Backend Type: Target group for Application Load Balancer target groups or Bucket for Object Storage buckets. This option works for HTTP backend groups only. gRPC and Stream group backends have the Target group backend type. For more information about backend types, see Backend types.

    • The settings described below only work for Target group backends:

      • Under Load balancing settings:

        • Balancing mode: Load balancing mode.
        • Panic mode threshold: Healthy endpoint threshold triggering panic mode when the load balancer distributes requests across all endpoints, regardless of their health status.
        • Locality aware routing: Share of incoming traffic the load balancer node will route to its availability zone backends. The remaining traffic will be evenly distributed across other availability zones. To learn more, see Locality aware routing.
        • Strict locality: If this option is enabled, the load balancer will return 503 Service Unavailable if no application backends are operational in the request’s originating availability zone.

      • Under Protocol settings:

        • For a HTTP backend group:

          • HTTP/2: With this option enabled, the load balancer will use the HTTP/2 protocol when routing requests to HTTP group backends. By default, the load balancer uses the HTTP/1.1 protocol. gRPC backend groups only support the HTTP/2 protocol.

          • Protocol: Backend connection protocol, e.g., HTTP without encryption or HTTPS with TLS encryption. For HTTPS, specify:

            • SNI. SNI domain name for TLS connections.
            • Trusted root certificate. Specify the root CA for the certificate chain installed on backend endpoints. You can use X.509 certificates in PEM format.

        • For a gRPC backend group:

          • Protocol: Backend connection protocol, e.g., Plain-text or Encrypted. For the encrypted protocol, specify SNI and Trusted root certificate as shown above.

        • For a Stream backend group:

          • PROXY protocol: With this option enabled, the load balancer will send its client connection metadata, e.g. its IP address, to the backend via HAProxy protocol.

          • Protocol: Backend connection protocol, e.g., Plain-text or Encrypted. For the encrypted protocol, specify SNI and Trusted root certificate as shown above.

    • The following settings only work for Bucket backends in HTTP backend groups:

      • Bucket ID format: List or ID.
      • Bucket: Select a bucket from the list or specify its ID.

    • Under HTTP health check, gRPC health check, or Stream health check specify:

      • Timeout, s: Response timeout. Maximum connection time.

      • Interval: Health check request interval.

      • Healthy threshold: Number of consecutive successful checks required before considering the endpoint healthy. The load balancer ignores this setting at start, conducting one health check to identify the endpoint as healthy.

      • Unhealthy threshold: Number of consecutive failed checks required before considering the endpoint unhealthy. The load balancer ignores this setting when receiving 503 Service Unavailable from a backend, following which it is considered unhealthy right away.

      • Port.

      • Type: Health check protocol, e.g., HTTP, gRPC, or Stream. The health check protocol does not need to match the backend group type. Depending on the selected protocol, specify:

        • For the HTTP type:

          • Path: Endpoint request URI path.
          • Authority: HTTP/1.1 Host or HTTP/2 :authority header of the backend endpoint health check requests.
          • HTTP/2: Use HTTP v2 protocol.
          • HTTP codes: HTTP status codes deemed valid during a backend health check.

        • For the gRPC type:

          • Service name: Name of the gRPC service you want to check. If no service is specified, the system will check the backend overall health.

        • For the Stream type:

          • Send: Data sent to the endpoint for a health check.
          • Receive: Data the endpoint must return to pass the health check.

      Alert

      If all backends with health checks enabled in an availability zone fail those checks, traffic will no longer route to that zone, even if functional backends without health checks remain.

      We recommend configuring health checks for all backends.

      To add a health check, at the bottom of the backend section, click Add health check and specify the check settings.

      To remove a health check, click next to the HTTP health check, gRPC health check, or Stream health check title, and select Delete.

  7. Click Add.

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.

Add the backend and a health check to the group.

Alert

If all backends with health checks enabled in an availability zone fail those checks, traffic will no longer route to that zone, even if functional backends without health checks remain.

We recommend configuring health checks for all backends.

All backends within a group must be of the same type: HTTP or Stream.

HTTP backend

Run this command:

yc alb backend-group add-http-backend \
  --backend-group-name <backend_group_name> \
  --name <name_of_backend_you_are_adding> \
  --weight <backend_weight> \
  --port <backend_port> \
  --target-group-id=<target_group_ID> \
  --panic-threshold 90 \
  --http-healthcheck port=80,healthy-threshold=10,unhealthy-threshold=15,expected-statuses=211,\
timeout=10s,interval=2s,host=<host_address>,path=<path>

Where:

  • --name: The name of the backend you want to add or update.
  • --panic-threshold: Panic mode threshold.
  • --http-healthcheck: Health check settings:
    • port: Port.
    • healthy-threshold: Healthy threshold.
    • unhealthy-threshold: Unhealthy threshold.
    • expected-statuses: HTTP status code deemed valid during a backend health check. You can add multiple values separated by a comma: expected-statuses=201,expected-statuses=205,expected-statuses=302. You can use HTTP codes in the range between 100 and 599. If this setting is not specified, the response code will be 200.
    • timeout: Maximum connection time.
    • interval: Interval.
    • host: Host address.
    • path: Path.

Result:

id: a5dqkr2mk3rr********
name: <backend_group_name>
folder_id: aoe197919j8e********
...
        host: <host_address>
        path: <path>
created_at: "2021-02-11T20:46:21.688940670Z"
gRPC backend

Run this command:

yc alb backend-group add-grpc-backend \
  --backend-group-name <backend_group_name> \
  --name <name_of_backend_you_are_adding> \
  --weight <backend_weight> \
  --port <backend_port> \
  --target-group-id=<target_group_ID> \
  --panic-threshold 90 \
  --grpc-healthcheck port=80,healthy-threshold=10,unhealthy-threshold=15,\
timeout=10s,interval=2s,service-name=<gRPC_service_name>

Where:

  • --panic-threshold: Panic mode threshold.
  • --grpc-healthcheck: Resource health check settings:
    • port: Port.
    • healthy-threshold: Healthy threshold.
    • unhealthy-threshold: Unhealthy threshold.
    • timeout: Maximum connection time.
    • interval: Interval.
    • service-name: Name of the gRPC service you want to check. If no service is specified, the system will check the backend overall health.

Result:

id: a5dqkr2mk3rr********
name: <backend_group_name>
folder_id: aoe197919j8e********
...
          grpc:
            service_name: <gRPC_service_name>
...
created_at: "2021-02-11T20:46:21.688940670Z"
Stream backend

Run this command:

yc alb backend-group add-stream-backend \
  --backend-group-name <backend_group_name> \
  --name <name_of_backend_you_are_adding> \
  --weight <backend_weight> \
  --port <backend_port> \
  --target-group-id=<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=<data_to_endpoint>,receive-text=<data_from_endpoint>

Where:

  • --panic-threshold: Panic mode threshold.
  • --enable-proxy-protocol: With this option enabled, the load balancer will send its client connection metadata, e.g. its IP address, to the backend via HAProxy protocol. If you do not set specific values for this option, the load balancer will only send its IP address to the backend.
  • --keep-connections-on-host-health-failure: Keeps the connection alive even if the health check fails.
  • --stream-healthcheck: Health check settings:
    • port: Port.
    • healthy-threshold: Healthy threshold.
    • unhealthy-threshold: Unhealthy threshold.
    • timeout: Maximum connection time.
    • interval: Interval.
    • send-text: Data sent to the endpoint for a health check.
    • receive-text: Data the endpoint must return to pass the health check.

Result:

id: ds77tero4f5********
name: <backend_group_name>
folder_id: b1gu6g9ielh6********
...
            text: <data_to_endpoint>
          receive:
            text: <data_from_endpoint>
    enable_proxy_protocol: true
created_at: "2022-04-06T09:17:57.104324513Z"

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. Open the Terraform configuration file and add your http_backend, grpc_backend, or stream_backend description to the backend group section:

    resource "yandex_alb_backend_group" "test-backend-group" {
  name                     = "<backend_group_name>"

  stream_backend {
    name                   = "<backend_name>"
    weight                 = 1
    port                   = 80
    target_group_ids       = ["<target_group_ID>"]
    load_balancing_config {
      panic_threshold      = 90
    }
    enable_proxy_protocol  = true
    healthcheck {
      timeout              = "10s"
      interval             = "2s"
      healthy_threshold    = 10
      unhealthy_threshold  = 15 
      stream_healthcheck {
        send               = "<data_to_endpoint>"
        receive            = "<data_from_endpoint>"
      }
    }
  }
}

    Where yandex_alb_backend_group includes backend group settings:

    • name: Backend group name.
    • http_backend, grpc_backend, or stream_backend: Backend type. All backends within a group must match the same type: HTTP, gRPC, or Stream.

    Backend parameters:

    • name: Backend name.

    • port: Backend port.

    • weight: Backend weight.

    • target_group_ids: Target group ID. To get a list of available target groups, run the yc alb target-group list CLI command.

    • load_balancing_config: Balancing parameters:

      • panic_threshold: Panic mode threshold.

    • enable_proxy_protocol: With this option enabled, the load balancer will send its client connection metadata, e.g. its IP address, to the backend via HAProxy protocol. If you do not set specific values for this option, the load balancer will only send its IP address to the backend. This option is only available for Stream type backends.

    • healthcheck: Health check settings:

      • timeout: Maximum connection request timeout.
      • interval: Interval.
      • healthy_threshold: Healthy threshold.
      • unhealthy_threshold: Unhealthy threshold.
      • keep_connections_on_host_health_failure: This option maintains connections open even if the target host status changes to Unhealthy.
      • http_healthcheck: HTTP health check settings:
        • path: Path, e.g., /health.
        • host: Host address, e.g., example.com.
        • expected_statuses: List of HTTP status codes corresponding to the Healthy status, e.g., [200, 201, 202].
      • grpc_healthcheck: gRPC health check settings:
        • service_name: Name of the gRPC service you want to check. If no service is specified, the system will check the backend overall health.
      • stream_healthcheck: Stream health check settings:
        • send: Data sent to the endpoint for a health check.
        • receive: Data the endpoint must return to pass the health check.

      Alert

      If all backends with health checks enabled in an availability zone fail those checks, traffic will no longer route to that zone, even if functional backends without health checks remain.

      We recommend configuring health checks for all backends.

    For more information about yandex_alb_backend_group properties, see the relevant 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.

    You can check backend group updates in the management console or using this CLI command:

    yc alb backend-group get --name <backend_group_name>

    Timeouts

    The Terraform provider limits operations with Application Load Balancer backend groups to 10 minutes.

    Operations in excess of this time will be interrupted.

    How do I modify these limits?

    Add a timeouts section to the backend group description:

    resource "yandex_alb_backend_group" "<backend_group_name>" {
  ...
  timeouts {
    create = "60m"
    update = "60m"
    delete = "60m"
  }
}

To change group basic settings, use the addBackend REST API method for the BackendGroup resource or the BackendGroupService/Update gRPC API call.

Update backend settings in a group

  1. In the management console, select the folder with your backend.
  2. Select Application Load Balancer.
  3. In the left-hand panel, select Backend groups.
  4. Click your group name.
  5. Next to the backend name, click and select Edit.
  6. In the window that opens, specify backend settings. For more information about these settings, see above.
  7. Click Save.

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 updating backend settings:

    yc alb backend-group update-<backend_type>-backend --help

  2. Specify new backend settings depending on its type:

    HTTP backend

    Run this command:

    yc alb backend-group update-http-backend \
  --backend-group-name <backend_group_name> \
  --name <backend_name> \
  --weight <backend_weight> \
  --port <backend_port> \
  --target-group-id=<target_group_ID> \
  --panic-threshold 90 \
  --http-healthcheck port=80,healthy-threshold=10,unhealthy-threshold=15,expected-statuses=211,\
timeout=10s,interval=2s,host=your-host.com,path=/ping

    Where:

    • --name: The name of the backend you want to add or update.
    • --panic-threshold: Panic mode threshold.
    • --http-healthcheck: Health check settings:
      • port: Port.
      • healthy-threshold: Healthy threshold.
      • unhealthy-threshold: Unhealthy threshold.
      • expected-statuses: HTTP status code deemed valid during a backend health check. You can add multiple values separated by a comma: expected-statuses=201,expected-statuses=205,expected-statuses=302. You can use HTTP codes in the range between 100 and 599. If this setting is not specified, the response code will be 200.
      • timeout: Maximum connection time.
      • interval: Interval.
      • host: Host address.
      • path: Path.

    Result:

    id: a5dqkr2mk3rr********
name: <backend_group_name>
folder_id: aoe197919j8e********
...
        host: <host_address>
        path: <path>
created_at: "2021-02-11T20:46:21.688940670Z"
    gRPC backend

    Run this command:

    yc alb backend-group update-grpc-backend \
  --backend-group-name <backend_group_name> \
  --name <name_of_backend_you_are_adding> \
  --weight <backend_weight> \
  --port <backend_port> \
  --target-group-id=<target_group_ID> \
  --panic-threshold 90 \
  --grpc-healthcheck port=80,healthy-threshold=10,unhealthy-threshold=15,\
timeout=10s,interval=2s,service-name=<gRPC_service_name>

    Where:

    • --panic-threshold: Panic mode threshold.
    • --grpc-healthcheck: Resource health check settings:
      • port: Port.
      • healthy-threshold: Healthy threshold.
      • unhealthy-threshold: Unhealthy threshold.
      • timeout: Maximum connection time.
      • interval: Interval.
      • service-name: Name of the gRPC service you want to check. If no service is specified, the system will check the backend overall health.

    Result:

    id: a5dqkr2mk3rr********
name: <backend_group_name>
folder_id: aoe197919j8e********
...
          grpc:
            service_name: <gRPC_service_name>
...
created_at: "2021-02-11T20:46:21.688940670Z"
    Stream backend

    Run this command:

    yc alb backend-group update-stream-backend \
  --backend-group-name <backend_group_name> \
  --name <name_of_backend_you_are_adding> \
  --weight <backend_weight> \
  --port <backend_port> \
  --target-group-id=<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=<data_to_endpoint>,receive-text=<data_from_endpoint>

    Where:

    • --panic-threshold: Panic mode threshold.
    • --enable-proxy-protocol: With this option enabled, the load balancer will send its client connection metadata, e.g. its IP address, to the backend via HAProxy protocol. If you do not set specific values for this option, the load balancer will only send its IP address to the backend.
    • --keep-connections-on-host-health-failure: Keeps the connection alive even if the health check fails.
    • --stream-healthcheck: Health check settings:
      • port: Port.
      • healthy-threshold: Healthy threshold.
      • unhealthy-threshold: Unhealthy threshold.
      • timeout: Maximum connection time.
      • interval: Interval.
      • send-text: Data sent to the endpoint for a health check.
      • receive-text: Data the endpoint must return to pass the health check.

    Result:

    id: ds77tero4f5********
name: <backend_group_name>
folder_id: b1gu6g9ielh6********
...
            text: <data_to_endpoint>
          receive:
            text: <data_from_endpoint>
    enable_proxy_protocol: true
created_at: "2022-04-06T09:17:57.104324513Z"

    Alert

    If all backends with health checks enabled in an availability zone fail those checks, traffic will no longer route to that zone, even if functional backends without health checks remain.

    We recommend configuring health checks for all backends.

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. Open the Terraform configuration file and edit your http_backend, grpc_backend, or stream_backend description in the backend group section:

    resource "yandex_alb_backend_group" "test-backend-group" {
  name                     = "<backend_group_name>"

  stream_backend {
    name                   = "<backend_name>"
    weight                 = 1
    port                   = 80
    target_group_ids       = ["<target_group_ID>"]
    load_balancing_config {
      panic_threshold      = 90
    }
    enable_proxy_protocol  = true
    healthcheck {
      timeout              = "10s"
      interval             = "2s"
      healthy_threshold    = 10
      unhealthy_threshold  = 15 
      stream_healthcheck {
        send               = "<data_to_endpoint>"
        receive            = "<data_from_endpoint>"
      }
    }
  }
}

    Where yandex_alb_backend_group includes backend group settings:

    • name: Backend group name.
    • http_backend, grpc_backend, or stream_backend: Backend type. All backends within a group must match the same type: HTTP, gRPC, or Stream.

    Backend parameters:

    • name: Backend name.

    • port: Backend port.

    • weight: Backend weight.

    • target_group_ids: Target group ID. To get a list of available target groups, run the yc alb target-group list CLI command.

    • load_balancing_config: Balancing parameters:

      • panic_threshold: Panic mode threshold.

    • enable_proxy_protocol: With this option enabled, the load balancer will send its client connection metadata, e.g. its IP address, to the backend via HAProxy protocol. If you do not set specific values for this option, the load balancer will only send its IP address to the backend. This option is only available for Stream type backends.

    • healthcheck: Health check settings:

      • timeout: Maximum connection request timeout.
      • interval: Interval.
      • healthy_threshold: Healthy threshold.
      • unhealthy_threshold: Unhealthy threshold.
      • keep_connections_on_host_health_failure: This option maintains connections open even if the target host status changes to Unhealthy.
      • http_healthcheck: HTTP health check settings:
        • path: Path, e.g., /health.
        • host: Host address, e.g., example.com.
        • expected_statuses: List of HTTP status codes corresponding to the Healthy status, e.g., [200, 201, 202].
      • grpc_healthcheck: gRPC health check settings:
        • service_name: Name of the gRPC service you want to check. If no service is specified, the system will check the backend overall health.
      • stream_healthcheck: Stream health check settings:
        • send: Data sent to the endpoint for a health check.
        • receive: Data the endpoint must return to pass the health check.

      Alert

      If all backends with health checks enabled in an availability zone fail those checks, traffic will no longer route to that zone, even if functional backends without health checks remain.

      We recommend configuring health checks for all backends.

    For more information about yandex_alb_backend_group properties, see the relevant 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.

    You can check backend group updates in the management console or using this CLI command:

    yc alb backend-group get --name <backend_group_name>

    Timeouts

    The Terraform provider limits operations with Application Load Balancer backend groups to 10 minutes.

    Operations in excess of this time will be interrupted.

    How do I modify these limits?

    Add a timeouts section to the backend group description:

    resource "yandex_alb_backend_group" "<backend_group_name>" {
  ...
  timeouts {
    create = "60m"
    update = "60m"
    delete = "60m"
  }
}

To update backend settings in a group, use the updateBackend REST API method for the UpdateBackend resource or the BackendGroupService/UpdateBackend gRPC API call.

Remove a backend from a group

To remove a backend from a group:

  1. In the management console, select the folder with your backend.
  2. Select Application Load Balancer.
  3. In the left-hand panel, select Backend groups.
  4. Click your group name.
  5. Click next to the backend name, then select Delete.
  6. In the window that opens, click Delete.

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 removing a backend from a group:

    yc application-load-balancer delete-<backend_type>-backend --help

  2. To delete a backend, run a command depending on its type:

    • HTTP backend:

      yc alb backend-group delete-http-backend \
  --backend-group-name=<backend_group_name> \
  --name=<name_of_backend_to_delete>

    • gRPC backend:

      yc alb backend-group delete-grpc-backend \
  --backend-group-name=<backend_group_name> \
  --name=<name_of_backend_to_delete>

    • Stream backend:

      yc alb backend-group delete-stream-backend \
  --backend-group-name=<backend_group_name> \
  --name=<name_of_backend_to_delete>

    Result:

    id: a5dqkr2mk3rr********
name: <backend_name>
folder_id: aoe197919j8e********
created_at: "2021-02-11T20:46:21.688940670Z"

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. Open the Terraform configuration file and remove your http_backend, grpc_backend, or stream_backend description from the backend group section.

    Sample backend group description in the Terraform configuration:

    resource "yandex_alb_backend_group" "test-backend-group" {
  name                     = "<backend_group_name>"

  http_backend {
    name                   = "<backend_name>"
    weight                 = 1
    port                   = 80
    target_group_ids       = ["<target_group_ID>"]
    load_balancing_config {
      panic_threshold      = 90
    }
    healthcheck {
      timeout              = "10s"
      interval             = "2s"
      healthy_threshold    = 10
      unhealthy_threshold  = 15
      http_healthcheck {
        path               = "/"
      }
    }
  }
}

    For more information about yandex_alb_backend_group properties, see the relevant 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.

    You can check backend group updates in the management console or using this CLI command:

    yc alb backend-group get --name <backend_group_name>

Use the removeBackend REST API method for the BackendGroup resource or the BackendGroupService/RemoveBackend gRPC API call.

See also

Previous
Getting information about a backend group
Next
Deleting a backend group