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

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

Overview

A runtime using a Compute Engine instance.

Defined Under Namespace

Classes: GceConfidentialInstanceConfig, GceShieldedInstanceConfig

Instance Attribute Summary collapse

Instance Attribute Details

#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.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#confidential_instance_config ⇒ ::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance::GceConfidentialInstanceConfig

Returns Optional. A set of Compute Engine Confidential VM instance options.

Returns:



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#disable_public_ip_addresses ⇒ ::Boolean

Returns 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).

Returns:

  • (::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).



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#enable_nested_virtualization ⇒ ::Boolean

Returns 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:

  • 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 workstation configurations that specify a 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 does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.

Returns:

  • (::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:

    • 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 workstation configurations that specify a 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 does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.


398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#machine_type ⇒ ::String

Returns 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.

Returns:

  • (::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.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#pool_size ⇒ ::Integer

Returns 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.

Returns:

  • (::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.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#pooled_instances ⇒ ::Integer (readonly)

Returns Output only. Number of instances currently available in the pool for faster workstation startup.

Returns:

  • (::Integer) —

    Output only. Number of instances currently available in the pool for faster workstation startup.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#service_account ⇒ ::String

Returns 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.

Returns:

  • (::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.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#service_account_scopes ⇒ ::Array<::String>

Returns Optional. Scopes to grant to the 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.

Returns:

  • (::Array<::String>) —

    Optional. Scopes to grant to the 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.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#shielded_instance_config ⇒ ::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance::GceShieldedInstanceConfig

Returns Optional. A set of Compute Engine Shielded instance options.

Returns:



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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

#tags ⇒ ::Array<::String>

Returns Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.

Returns:

  • (::Array<::String>) —

    Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 398

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