Batch V1 API - Class Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicyOrTemplate (v0.19.1)

Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicyOrTemplate.

InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#block_project_ssh_keys

def block_project_ssh_keys() -> ::Boolean
Returns
  • (::Boolean) — Optional. Set this field to true if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job.

    Batch allows project-level SSH keys for a job's VMs only if all the following are true:

    • This field is undefined or set to false.
    • The job's VM instance template (if any) doesn't block project-level SSH keys.

    Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys

#block_project_ssh_keys=

def block_project_ssh_keys=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Set this field to true if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job.

    Batch allows project-level SSH keys for a job's VMs only if all the following are true:

    • This field is undefined or set to false.
    • The job's VM instance template (if any) doesn't block project-level SSH keys.

    Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys

Returns
  • (::Boolean) — Optional. Set this field to true if you want Batch to block project-level SSH keys from accessing this job's VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job.

    Batch allows project-level SSH keys for a job's VMs only if all the following are true:

    • This field is undefined or set to false.
    • The job's VM instance template (if any) doesn't block project-level SSH keys.

    Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys

#install_gpu_drivers

def install_gpu_drivers() -> ::Boolean
Returns
  • (::Boolean) — Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on your behalf. Default is false.

    For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.

#install_gpu_drivers=

def install_gpu_drivers=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on your behalf. Default is false.

    For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.

Returns
  • (::Boolean) — Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on your behalf. Default is false.

    For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.

#install_ops_agent

def install_ops_agent() -> ::Boolean
Returns
  • (::Boolean) — Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.

#install_ops_agent=

def install_ops_agent=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.
Returns
  • (::Boolean) — Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.

#instance_template

def instance_template() -> ::String
Returns
  • (::String) — Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid C++ keyword conflict.

    Batch only supports global instance templates. You can specify the global instance template as a full or partial URL.

#instance_template=

def instance_template=(value) -> ::String
Parameter
  • value (::String) — Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid C++ keyword conflict.

    Batch only supports global instance templates. You can specify the global instance template as a full or partial URL.

Returns
  • (::String) — Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid C++ keyword conflict.

    Batch only supports global instance templates. You can specify the global instance template as a full or partial URL.

#policy

def policy() -> ::Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicy
Returns

#policy=

def policy=(value) -> ::Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicy
Parameter
Returns