Contact UsGet started

Editing a backend group

Written by
Updated at October 18, 2024

Update a group's basic parameters

Note

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

  1. In the management console, select the folder where the backend group was created.
  2. Select Application Load Balancer.
  3. In the left-hand panel, select Backend groups.
  4. Click the name of the group.
  5. Click Edit.
  6. Edit the group parameters:

    • Name and Description backend groups.

    • Session affinity: If you select this option, requests within one user session are processed by the same endpoint.

      Note

      Currently, session affinity only works if a single backend is active (has a positive weight) in a group of backends, includes one or more target groups, and the MAGLEV_HASH load balancing mode is selected for it.

      HTTP and gRPC backend groups support the following modes:

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

      For the Stream type, session affinity is always by IP address.

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

  7. At the bottom of the page, click Save.

If you do not 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.

  1. See the description of the CLI command that changes the backend group basic parameters:

    yc alb backend-group update --help

  2. Run this command:

    yc alb backend-group update \
  --name <backend_group_name> \
  --new-name <new_name_for_backend_group> \
  --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: New name for the backend group. The naming requirements are as follows:

      • The name must be from 3 to 63 characters long.
      • It may contain uppercase and lowercase Latin and Russian 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 parameter.

    • --labels key=value: List of labels in key=value format. This is an optional parameter.

    • --connection-affinity: Mode of session affinity by IP address (source-ip). Its possible values are true or false. This is an optional parameter. The --cookie-affinity (by cookie) and --header-affinity (by HTTP header) modes are also available. Only one of the modes can be specified. If the backend group is of the Stream type, the you can only use --connection-affinity.

      Note

      Currently, session affinity only works if a single backend is active (has a positive weight) in a group of backends, includes one or more target groups, and the MAGLEV_HASH load balancing mode is selected for it.

    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"

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

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

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

  1. Open the Terraform configuration file and edit the fragment with the backend group description:

    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 specifies the backend group parameters:

    • name: Backend group name.

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

    • labels: List of labels in key=value format. This is an optional parameter.

    • session_affinity: Session affinity settings. This is an optional parameter.

      Note

      Currently, session affinity only works if a single backend is active (has a positive weight) in a group of backends, includes one or more target groups, and the MAGLEV_HASH load balancing mode is selected for it.

      • connection: Mode of session affinity by IP address (source_ip). It can either be true or false. The cookie and header modes are also available. Only one of the modes should be specified. If the backend group is of the Stream type (consists of the stream_backend resources), you can only use the connection mode for session affinity.

    For more information about the yandex_alb_backend_group resource parameters, see the Terraform provider documentation.

  2. Apply the changes:

    1. In the terminal, change to the folder where you edited the configuration file.

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

      terraform validate

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.

    3. Run the command:

      terraform plan

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

    4. Apply the configuration changes:

      terraform apply

    5. Confirm the changes: type yes in the terminal and press Enter.

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

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

To change the basic parameters of a backend group, 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 where the backend was created.

  2. Select Application Load Balancer.

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

  4. Click the name of the group.

  5. Click Create backend.

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

    • Backend Name.

    • Weight: Backend relative weight when distributing traffic. If the option is disabled in the field, the backend endpoints will not receive any traffic (weight will be equal to 0).

    • Backend Type (for an HTTP backend group): Target group (Application Load Balancer target groups) or Bucket (Object Storage bucket). For a gRPC or Stream backend group, the type of any backend is Target group. For more information about backend types, see Backend types.

    • The settings described below are only applicable to backends of the Target group type:

      • Under Load balancing settings:

        • Balancing mode: Mode for distributing traffic across backend endpoints.
        • Panic mode threshold: Percentage of healthy endpoints for enabling panic mode: the load balancer will distribute requests across all endpoints, regardless of health check results.
        • Locality aware routing: Percentage of incoming traffic that a load balancer node routes to the backends from its availability zone. The remaining traffic is evenly distributed between other availability zones. For more information, see Locality aware routing.
        • Strict locality: If this option is enabled, the load balancer will respond with an error (503 Service Unavailable) if no application backends are running in the availability zone that accepted the request.

      • Under Protocol settings:

        • For a HTTP backend group:

          • HTTP/2: Option to use HTTP/2 when routing requests to the backend of an HTTP backend group. By default, the protocol version is 1.1. Backend groups of the gRPC type only support HTTP/2 connections.

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

            • SNI: Host domain name for Server Name Indication, an extension to the TLS protocol.
            • Trusted root certificate: Specify a root CA for a certificate chain installed on backend endpoints. X.509 certificates in PEM format are supported.

        • For a gRPC backend group:

          • Protocol: Backend connection protocol: Plain-text or Encrypted. For the encrypted protocol, set SNI and Trusted root certificate (see above).

        • For a Stream backend group:

          • PROXY protocol: If this option is enabled, the load balancer will send metadata about its connection to the client, including its IP, to the backend over the PROXY protocol from HAProxy.

          • Protocol: Backend connection protocol: Plain-text or Encrypted. For the encrypted protocol, set SNI and Trusted root certificate (see above).

    • The settings described below are only applicable to backends of the Bucket type in backend groups of the HTTP type:

      • Bucket ID format: Select 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:

      • Timeout, s: Response timeout.

      • Interval: Interval for sending check requests.

      • Healthy threshold: Number of consecutive successful checks at which the endpoint is considered healthy. It is ignored when the load balancer has just started: one health check is enough.

      • Unhealthy threshold: Number of consecutive failed checks after which the endpoint is considered unhealthy. It is ignored if the backend has responded with the 503 Service Unavailable HTTP status code once: it is immediately considered unhealthy.

      • Port.

      • Type: Protocol to use for health checks: HTTP, gRPC, or Stream. The check type may be the same as the backend group type. Also specify:

        • For the HTTP type:

          • Path: Path in the URI of a request to the endpoint.
          • Authority: Value of the Host header for HTTP/1.1 or the :authority pseudo-header for HTTP/2 to be sent to the backend endpoints during health checks.
          • HTTP/2: Option to use HTTP v.2.

        • For the gRPC type:

          • Service name: Name of the gRPC service to be checked. If no service is specified, the backend general health is checked.

        • For the Stream type:

          • Send: Data to be sent to the endpoint for a health check.
          • Receive: Data to be received from the endpoint for it to pass the health check.

      Alert

      If all backends in an availability zone with health checks enabled fail the checks, traffic will stop routing to the zone, even if there are working backends without health checks in the zone.

      We recommend configuring health checks for all backends.

      To add a health check, click Add health check at the bottom of the backend section 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 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.

Add a backend and health check to the group.

Alert

If all backends in an availability zone with health checks enabled fail the checks, traffic will stop routing to the zone, even if there are working backends without health checks in the zone.

We recommend configuring health checks for all backends.

All backends within the 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_being_added> \
  --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,\
timeout=10s,interval=2s,host=<host_address>,path=<path>

Where:

  • --panic-threshold: Panic mode threshold
  • --http-healthcheck: Resource health check parameters:
    • port: Port
    • healthy-threshold: Healthy threshold
    • unhealthy-threshold: Unhealthy threshold
    • timeout: Timeout
    • 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_being_added> \
  --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 parameters:
    • port: Port.
    • healthy-threshold: Healthy threshold.
    • unhealthy-threshold: Unhealthy threshold.
    • timeout: Timeout.
    • interval: Interval.
    • service-name: Name of the gRPC service to check. If no service is specified, the backend general health is checked.

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_to_add> \
  --weight <backend_weight> \
  --port <backend_port> \
  --target-group-id=<target_group_ID> \
  --panic-threshold 90 \
  --enable-proxy-protocol \
  --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: If this option is enabled, the load balancer will send metadata about its connection to the client, including its IP, to the backend over the PROXY protocol from HAProxy. If this option is not specified, only the load balancer's IP address will be provided to the backend.
  • --stream-healthcheck: Resource health check parameters:
    • port: Port.
    • healthy-threshold: Healthy threshold.
    • unhealthy-threshold: Unhealthy threshold.
    • timeout: Timeout.
    • interval: Interval.
    • send-text: Data to send to the endpoint for a health check.
    • receive-text: Data to receive from the endpoint for it 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"

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

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

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

  1. Open the Terraform configuration file and add a section describing the backend (http_backend, grpc_backend, or stream_backend) to the backend group description:

    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 specifies the backend group parameters:

    • name: Backend group name.
    • http_backend, grpc_backend, and stream_backend: Backend type. All backends within the group must be of 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 following CLI command: yc alb target-group list.

    • load_balancing_config: Balancing parameters:

      • panic_threshold: Panic mode threshold.

    • enable_proxy_protocol: With this option enabled, the load balancer will send metadata about its connection to the client, including its IP, to the backend over the PROXY protocol from HAProxy. If the option is not specified, only the load balancer's IP address will be provided to the backend. This parameter is only available for Stream type backends.

    • healthcheck: Health check parameters:

      • timeout: Timeout.
      • interval: Interval.
      • healthy_threshold: Healthy threshold.
      • unhealthy_threshold: Unhealthy threshold.
      • http_healthcheck: HTTP health check parameters:
        • path: Path.
        • host: Host address.
      • grpc_healthcheck: gRPC health check parameters:
        • service_name: Name of the gRPC service to be checked. If no service is specified, the backend general health is checked.
      • stream_healthcheck: Stream health check parameters:
        • send: Data to send to the endpoint for a health check.
        • receive: Data to receive from the endpoint for it to pass the health check.

      Alert

      If all backends in an availability zone with health checks enabled fail the checks, traffic will stop routing to the zone, even if there are working backends without health checks in the zone.

      We recommend configuring health checks for all backends.

    For more information about the yandex_alb_backend_group resource parameters, see the Terraform provider documentation.

  2. Apply the changes:

    1. In the terminal, change to the folder where you edited the configuration file.

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

      terraform validate

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.

    3. Run the command:

      terraform plan

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

    4. Apply the configuration changes:

      terraform apply

    5. Confirm the changes: type yes in the terminal and press Enter.

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

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

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

Update parameters for a backend in a group

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

If you do not 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.

  1. See the description of the CLI command for updating the backend parameters:

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

  2. Set new parameters for the backend depending on its type:

    HTTP backend

    Run this command:

    yc alb backend-group update-http-backend \
  --backend-group-name <backend_group_name> \
  --name <name_of_backend_to_add> \
  --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,\
timeout=10s,interval=2s,host=your-host.com,path=/ping

    Where:

    • --panic-threshold: Panic mode threshold
    • --http-healthcheck: Resource health check parameters:
      • port: Port
      • healthy-threshold: Healthy threshold
      • unhealthy-threshold: Unhealthy threshold
      • timeout: Timeout
      • 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_to_add> \
  --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 parameters:
      • port: Port.
      • healthy-threshold: Healthy threshold.
      • unhealthy-threshold: Unhealthy threshold.
      • timeout: Timeout.
      • interval: Interval.
      • service-name: Name of the gRPC service to check. If no service is specified, the backend general health is checked.

    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_to_add> \
  --weight <backend_weight> \
  --port <backend_port> \
  --target-group-id=<target_group_ID> \
  --panic-threshold 90 \
  --enable-proxy-protocol \
  --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: If this option is enabled, the load balancer will send metadata about its connection to the client, including its IP, to the backend over the PROXY protocol from HAProxy. If this option is not specified, only the load balancer's IP address will be provided to the backend.
    • --stream-healthcheck: Resource health check parameters:
      • port: Port.
      • healthy-threshold: Healthy threshold.
      • unhealthy-threshold: Unhealthy threshold.
      • timeout: Timeout.
      • interval: Interval.
      • send-text: Data to send to the endpoint for a health check.
      • receive-text: Data to receive from the endpoint for it 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 in an availability zone with health checks enabled fail the checks, traffic will stop routing to the zone, even if there are working backends without health checks in the zone.

    We recommend configuring health checks for all backends.

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

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

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

  1. Open the Terraform configuration file and edit the parameters of the section describing the backend (http_backend, grpc_backend, or stream_backend) in the backend group description:

    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 specifies the backend group parameters:

    • name: Backend group name.
    • http_backend, grpc_backend, and stream_backend: Backend type. All backends within the group must be of 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 following CLI command: yc alb target-group list.

    • load_balancing_config: Balancing parameters:

      • panic_threshold: Panic mode threshold.

    • enable_proxy_protocol: With this option enabled, the load balancer will send metadata about its connection to the client, including its IP, to the backend over the PROXY protocol from HAProxy. If the option is not specified, only the load balancer's IP address will be provided to the backend. This parameter is only available for Stream type backends.

    • healthcheck: Health check parameters:

      • timeout: Timeout.
      • interval: Interval.
      • healthy_threshold: Healthy threshold.
      • unhealthy_threshold: Unhealthy threshold.
      • http_healthcheck: HTTP health check parameters:
        • path: Path.
        • host: Host address.
      • grpc_healthcheck: gRPC health check parameters:
        • service_name: Name of the gRPC service to be checked. If no service is specified, the backend general health is checked.
      • stream_healthcheck: Stream health check parameters:
        • send: Data to send to the endpoint for a health check.
        • receive: Data to receive from the endpoint for it to pass the health check.

      Alert

      If all backends in an availability zone with health checks enabled fail the checks, traffic will stop routing to the zone, even if there are working backends without health checks in the zone.

      We recommend configuring health checks for all backends.

    For more information about the yandex_alb_backend_group resource parameters, see the Terraform provider documentation.

  2. Apply the changes:

    1. In the terminal, change to the folder where you edited the configuration file.

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

      terraform validate

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.

    3. Run the command:

      terraform plan

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

    4. Apply the configuration changes:

      terraform apply

    5. Confirm the changes: type yes in the terminal and press Enter.

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

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

To change the backend parameters in the 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 where the backend was created.
  2. Select Application Load Balancer.
  3. In the left-hand panel, select Backend groups.
  4. Click the name of the group.
  5. Next to the backend name, click and select Delete.
  6. In the window that opens, click Delete.

If you do not 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.

  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. Depending on the type of backend, run the command to delete it:

    • 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"

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

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

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

  1. Open the Terraform configuration file and remove the section describing the backend (http_backend, grpc_backend, or stream_backend) from the backend group description.

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

  2. Apply the changes:

    1. In the terminal, change to the folder where you edited the configuration file.

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

      terraform validate

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.

    3. Run the command:

      terraform plan

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

    4. Apply the configuration changes:

      terraform apply

    5. Confirm the changes: type yes in the terminal and press Enter.

    You can check the backend group updates using the management console or 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