Class: Google::Cloud::Batch::V1::Runnable::Container

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

Overview

Container runnable.

Instance Attribute Summary collapse

Instance Attribute Details

#block_external_network ⇒ ::Boolean

Returns If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options field.

Returns:

  • (::Boolean) —

    If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options field.



259
260
261
262
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 259

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

#commands ⇒ ::Array<::String>

Returns Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.

Returns:

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

    Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.



259
260
261
262
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 259

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

#enable_image_streaming ⇒ ::Boolean

Returns Optional. If set to true, this container runnable uses Image streaming.

Use Image streaming to allow the runnable to initialize without waiting for the entire container image to download, which can significantly reduce startup time for large container images.

When enableImageStreaming is set to true, the container runtime is containerd instead of Docker. Additionally, this container runnable only supports the following container subfields: imageUri, commands[], entrypoint, and volumes[]; any other container subfields are ignored.

For more information about the requirements and limitations for using Image streaming with Batch, see the image-streaming sample on GitHub.

Returns:

  • (::Boolean) —

    Optional. If set to true, this container runnable uses Image streaming.

    Use Image streaming to allow the runnable to initialize without waiting for the entire container image to download, which can significantly reduce startup time for large container images.

    When enableImageStreaming is set to true, the container runtime is containerd instead of Docker. Additionally, this container runnable only supports the following container subfields: imageUri, commands[], entrypoint, and volumes[]; any other container subfields are ignored.

    For more information about the requirements and limitations for using Image streaming with Batch, see the image-streaming sample on GitHub.



259
260
261
262
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 259

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

#entrypoint ⇒ ::String

Returns Overrides the ENTRYPOINT specified in the container.

Returns:

  • (::String) —

    Overrides the ENTRYPOINT specified in the container.



259
260
261
262
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 259

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

#image_uri ⇒ ::String

Returns The URI to pull the container image from.

Returns:

  • (::String) —

    The URI to pull the container image from.



259
260
261
262
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 259

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

#options ⇒ ::String

Returns Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".

Returns:

  • (::String) —

    Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".



259
260
261
262
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 259

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

#password ⇒ ::String

Returns Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;.

Returns:

  • (::String) —

    Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;



259
260
261
262
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 259

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

#username ⇒ ::String

Returns Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.

Returns:

  • (::String) —

    Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.



259
260
261
262
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 259

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

#volumes ⇒ ::Array<::String>

Returns Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro

If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.

Returns:

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

    Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro

    If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.



259
260
261
262
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 259

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