Reserve capacity for your workstation

Preview — Reserve capacity for your workstation

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. You can process personal data for this feature as outlined in the Cloud Data Processing Addendum, subject to the obligations and restrictions described in the agreement under which you access Google Cloud. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Compute Engine reservations provide a high level of assurance in obtaining capacity for Compute Engine virtual machine (VM) instances. Reservations help ensure that capacity for VMs with specific properties, such as machine type, is held for your project.

When you create a reservation, you help protect your workloads from errors caused by insufficient capacity. For more information, see the Compute Engine Reservations overview.

This document describes how to configure your workstation configurations to consume reserved capacity by setting a reservation affinity. In the API, these affinity parameters are collectively referred to as ReservationAffinity.

Before you begin

• Create a Compute Engine reservation. The reservation must be in the same project and region, and target the same zone, as your workstation cluster.
• The reservation's machine properties (for example, machine type) must match the properties you intend to use in the workstation configuration.

How reservation affinity works

You can control how a workstation configuration consumes reserved capacity by specifying its reservation affinity. There are three modes:

• Specific reservation: The configuration uses capacity only from a specific matching reservation. You target this reservation using the --reservation-affinity flag with consume-reservation-type=specific-reservation.
• No reservation: The configuration is prevented from using capacity from any reservation. You set this using the --reservation-affinity flag with consume-reservation-type=no-reservation.
• Any matching reservation (default): By default, if you don't specify a reservation affinity, Cloud Workstations uses capacity from any matching reservations available in the project. This behavior occurs because the underlying Compute Engine instances default to using any matching reservation.

Configure reservation affinity

To control reservation usage, you specify the --reservation-affinity flag when creating or updating a workstation configuration.

Consume a specific reservation

To create a workstation configuration that consumes capacity only from a specific named reservation, run the following gcloud CLI command:

gcloud beta workstations configs create WORKSTATION_CONFIG_ID \
    --cluster=WORKSTATION_CLUSTER_ID \
    --region=REGION \
    --project=PROJECT_ID \
    --machine-type=MACHINE_TYPE \
    --reservation-affinity=consume-reservation-type=specific-reservation,key=compute.googleapis.com/reservation-name,values=RESERVATION_NAME

Replace the following:

• WORKSTATION_CONFIG_ID: the ID of the workstation configuration.
• WORKSTATION_CLUSTER_ID: the ID of the workstation cluster.
• REGION: the region of the workstation cluster.
• PROJECT_ID: the ID of the project.
• MACHINE_TYPE: the machine type for the VMs in the workstation configuration—for example, e2-standard-4. This machine type must match the machine type of the reservation.
• RESERVATION_NAME: the name of the specific Compute Engine reservation to use capacity from.

If you configure workstations to consume a specific reservation, workstations started using this configuration draw capacity only from that reservation. If the reservation runs out of capacity, the configuration will be degraded until capacity becomes available in the reservation.

Prevent using any reservation

To create a workstation configuration that does not use capacity from any reservation, use --reservation-affinity=consume-reservation-type=no-reservation:

gcloud beta workstations configs create WORKSTATION_CONFIG_ID \
    --cluster=WORKSTATION_CLUSTER_ID \
    --region=REGION \
    --project=PROJECT_ID \
    --machine-type=MACHINE_TYPE \
    --reservation-affinity=consume-reservation-type=no-reservation

You can use the same variable replacements as listed in the previous section.