Class: Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::BoostConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/workstations/v1beta/workstations.rb

Overview

A boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the boost config by passing the boost config ID in the start request. If the workstation user does not provide a boost config ID in the start request, the system will choose a VM from the pool provisioned under the default config.

Instance Attribute Summary collapse

Instance Attribute Details

#accelerators ⇒ ::Array<::Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::Accelerator>

Returns Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to none.

Returns:



704
705
706
707
 
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 704

class BoostConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#boot_disk_size_gb ⇒ ::Integer

Returns Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is 30 GB. Defaults to 50 GB.

Returns:

  • (::Integer) —

    Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is 30 GB. Defaults to 50 GB.



704
705
706
707
 
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 704

class BoostConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#enable_nested_virtualization ⇒ ::Boolean

Returns Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration.

Defaults to false.

Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the same restrictions as Compute Engine instances:

  • Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed.
  • Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound.
  • Machine Type: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.

Returns:

  • (::Boolean) —

    Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration.

    Defaults to false.

    Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the same restrictions as Compute Engine instances:

    • Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed.
    • Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound.
    • Machine Type: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.


704
705
706
707
 
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 704

class BoostConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#id ⇒ ::String

Returns Required. The ID to be used for the boost configuration.

Returns:

  • (::String) —

    Required. The ID to be used for the boost configuration.



704
705
706
707
 
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 704

class BoostConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#machine_type ⇒ ::String

Returns Optional. The type of machine that boosted VM instances will use—for example, e2-standard-4. For more information about machine types that Cloud Workstations supports, see the list of available machine types. Defaults to e2-standard-4.

Returns:

  • (::String) —

    Optional. The type of machine that boosted VM instances will use—for example, e2-standard-4. For more information about machine types that Cloud Workstations supports, see the list of available machine types. Defaults to e2-standard-4.



704
705
706
707
 
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 704

class BoostConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pool_size ⇒ ::Integer

Returns Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to 0.

Returns:

  • (::Integer) —

    Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to 0.



704
705
706
707
 
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 704

class BoostConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#reservation_affinity ⇒ ::Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::ReservationAffinity

Returns Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

  • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
  • Using reservations incurs charges, regardless of utilization.
  • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.

Returns:

  • (::Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::ReservationAffinity) —

    Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

    • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
    • Using reservations incurs charges, regardless of utilization.
    • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.


704
705
706
707
 
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 704

class BoostConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end