Class: Google::Cloud::Workstations::V1::WorkstationConfig::Host

Inherits:

Object

• Object
• Google::Cloud::Workstations::V1::WorkstationConfig::Host

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/workstations/v1/workstations.rb

Overview

Runtime host for a workstation.

Defined Under Namespace

Classes: GceInstance

Instance Attribute Summary

• #gce_instance ⇒ ::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance

  Specifies a Compute Engine instance as the host.

Instance Attribute Details

#gce_instance ⇒ ::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance

Returns Specifies a Compute Engine instance as the host.

Returns:

• (::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance) —

  Specifies a Compute Engine instance as the host.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 287

class Host
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A runtime using a Compute Engine instance.
  # @!attribute [rw] machine_type
  #   @return [::String]
  #     Optional. The type of machine to use for VM instances—for example,
  #     `"e2-standard-4"`. For more information about machine types that
  #     Cloud Workstations supports, see the list of
  #     [available machine
  #     types](https://cloud.google.com/workstations/docs/available-machine-types).
  # @!attribute [rw] service_account
  #   @return [::String]
  #     Optional. The email address of the service account for Cloud
  #     Workstations VMs created with this configuration. When specified, be
  #     sure that the service account has `logginglogEntries.create` permission
  #     on the project so it can write logs out to Cloud Logging. If using a
  #     custom container image, the service account must have permissions to
  #     pull the specified image.
  #
  #     If you as the administrator want to be able to `ssh` into the
  #     underlying VM, you need to set this value to a service account
  #     for which you have the `iam.serviceAccounts.actAs` permission.
  #     Conversely, if you don't want anyone to be able to `ssh` into the
  #     underlying VM, use a service account where no one has that
  #     permission.
  #
  #     If not set, VMs run with a service account provided by the
  #     Cloud Workstations service, and the image must be publicly
  #     accessible.
  # @!attribute [rw] service_account_scopes
  #   @return [::Array<::String>]
  #     Optional. Scopes to grant to the
  #     {::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance#service_account service_account}.
  #     Various scopes are automatically added based on feature usage. When
  #     specified, users of workstations under this configuration must have
  #     `iam.serviceAccounts.actAs` on the service account.
  # @!attribute [rw] tags
  #   @return [::Array<::String>]
  #     Optional. Network tags to add to the Compute Engine VMs backing the
  #     workstations. This option applies
  #     [network
  #     tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs
  #     created with this configuration. These network tags enable the creation
  #     of [firewall
  #     rules](https://cloud.google.com/workstations/docs/configure-firewall-rules).
  # @!attribute [rw] pool_size
  #   @return [::Integer]
  #     Optional. The number of VMs that the system should keep idle so that
  #     new workstations can be started quickly for new users. Defaults to `0`
  #     in the API.
  # @!attribute [r] pooled_instances
  #   @return [::Integer]
  #     Output only. Number of instances currently available in the pool for
  #     faster workstation startup.
  # @!attribute [rw] disable_public_ip_addresses
  #   @return [::Boolean]
  #     Optional. When set to true, disables public IP addresses for VMs. If
  #     you disable public IP addresses, you must set up Private Google Access
  #     or Cloud NAT on your network. If you use Private Google Access and you
  #     use `private.googleapis.com` or `restricted.googleapis.com` for
  #     Container Registry and Artifact Registry, make sure that you set
  #     up DNS records for domains `*.gcr.io` and `*.pkg.dev`.
  #     Defaults to false (VMs have public IP addresses).
  # @!attribute [rw] enable_nested_virtualization
  #   @return [::Boolean]
  #     Optional. Whether to enable nested virtualization on Cloud Workstations
  #     VMs created under this workstation configuration.
  #
  #     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](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions):
  #
  #     * **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](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#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
  #     workstation configurations that specify a
  #     {::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance#machine_type machine_type}
  #     in the N1 or N2 machine series.
  #     * **GPUs**: nested virtualization may not be enabled on workstation
  #     configurations with accelerators.
  #     * **Operating System**: Because
  #     [Container-Optimized
  #     OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos)
  #     does not support nested virtualization, when nested virtualization is
  #     enabled, the underlying Compute Engine VM instances boot from an
  #     [Ubuntu
  #     LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts)
  #     image.
  # @!attribute [rw] shielded_instance_config
  #   @return [::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance::GceShieldedInstanceConfig]
  #     Optional. A set of Compute Engine Shielded instance options.
  # @!attribute [rw] confidential_instance_config
  #   @return [::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance::GceConfidentialInstanceConfig]
  #     Optional. A set of Compute Engine Confidential VM instance options.
  # @!attribute [rw] boot_disk_size_gb
  #   @return [::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.
  class GceInstance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A set of Compute Engine Shielded instance options.
    # @!attribute [rw] enable_secure_boot
    #   @return [::Boolean]
    #     Optional. Whether the instance has Secure Boot enabled.
    # @!attribute [rw] enable_vtpm
    #   @return [::Boolean]
    #     Optional. Whether the instance has the vTPM enabled.
    # @!attribute [rw] enable_integrity_monitoring
    #   @return [::Boolean]
    #     Optional. Whether the instance has integrity monitoring enabled.
    class GceShieldedInstanceConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # A set of Compute Engine Confidential VM instance options.
    # @!attribute [rw] enable_confidential_compute
    #   @return [::Boolean]
    #     Optional. Whether the instance has confidential compute enabled.
    class GceConfidentialInstanceConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end