Class: Google::Apis::RunV1::Container

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/run_v1/classes.rb,
lib/google/apis/run_v1/representations.rb,
lib/google/apis/run_v1/representations.rb

Overview

A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Container

Returns a new instance of Container.



612
613
614
 
# File 'lib/google/apis/run_v1/classes.rb', line 612

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#args ⇒ Array<String>

Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $ $, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/ tasks/inject-data-application/define-command-argument-container/#running-a- command-in-a-shell Corresponds to the JSON property args

Returns:

  • (Array<String>) 


495
496
497
 
# File 'lib/google/apis/run_v1/classes.rb', line 495

def args
  @args
end

#command ⇒ Array<String>

Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https:// kubernetes.io/docs/tasks/inject-data-application/define-command-argument- container/#running-a-command-in-a-shell Corresponds to the JSON property command

Returns:

  • (Array<String>) 


507
508
509
 
# File 'lib/google/apis/run_v1/classes.rb', line 507

def command
  @command
end

#env ⇒ Array<Google::Apis::RunV1::EnvVar>

List of environment variables to set in the container. Corresponds to the JSON property env

Returns:



512
513
514
 
# File 'lib/google/apis/run_v1/classes.rb', line 512

def env
  @env
end

#env_from ⇒ Array<Google::Apis::RunV1::EnvFromSource>

Not supported by Cloud Run. Corresponds to the JSON property envFrom

Returns:



517
518
519
 
# File 'lib/google/apis/run_v1/classes.rb', line 517

def env_from
  @env_from
end

#image ⇒ String

Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/ images Corresponds to the JSON property image

Returns:

  • (String) 


524
525
526
 
# File 'lib/google/apis/run_v1/classes.rb', line 524

def image
  @image
end

#image_pull_policy ⇒ String

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if : latest tag is specified, or IfNotPresent otherwise. More info: https:// kubernetes.io/docs/concepts/containers/images#updating-images Corresponds to the JSON property imagePullPolicy

Returns:

  • (String) 


531
532
533
 
# File 'lib/google/apis/run_v1/classes.rb', line 531

def image_pull_policy
  @image_pull_policy
end

#liveness_probe ⇒ Google::Apis::RunV1::Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. Corresponds to the JSON property livenessProbe

Returns:



537
538
539
 
# File 'lib/google/apis/run_v1/classes.rb', line 537

def liveness_probe
  @liveness_probe
end

#name ⇒ String

Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/ names/#dns-label-names Corresponds to the JSON property name

Returns:

  • (String) 


544
545
546
 
# File 'lib/google/apis/run_v1/classes.rb', line 544

def name
  @name
end

#ports ⇒ Array<Google::Apis::RunV1::ContainerPort>

List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on. Corresponds to the JSON property ports

Returns:



553
554
555
 
# File 'lib/google/apis/run_v1/classes.rb', line 553

def ports
  @ports
end

#readiness_probe ⇒ Google::Apis::RunV1::Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. Corresponds to the JSON property readinessProbe

Returns:



559
560
561
 
# File 'lib/google/apis/run_v1/classes.rb', line 559

def readiness_probe
  @readiness_probe
end

#resources ⇒ Google::Apis::RunV1::ResourceRequirements

ResourceRequirements describes the compute resource requirements. Corresponds to the JSON property resources

Returns:



564
565
566
 
# File 'lib/google/apis/run_v1/classes.rb', line 564

def resources
  @resources
end

#security_context ⇒ Google::Apis::RunV1::SecurityContext

Not supported by Cloud Run. SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. Corresponds to the JSON property securityContext

Returns:



572
573
574
 
# File 'lib/google/apis/run_v1/classes.rb', line 572

def security_context
  @security_context
end

#startup_probe ⇒ Google::Apis::RunV1::Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. Corresponds to the JSON property startupProbe

Returns:



578
579
580
 
# File 'lib/google/apis/run_v1/classes.rb', line 578

def startup_probe
  @startup_probe
end

#termination_message_path ⇒ String

Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination- log. Corresponds to the JSON property terminationMessagePath

Returns:

  • (String) 


588
589
590
 
# File 'lib/google/apis/run_v1/classes.rb', line 588

def termination_message_path
  @termination_message_path
end

#termination_message_policy ⇒ String

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. Corresponds to the JSON property terminationMessagePolicy

Returns:

  • (String) 


598
599
600
 
# File 'lib/google/apis/run_v1/classes.rb', line 598

def termination_message_policy
  @termination_message_policy
end

#volume_mounts ⇒ Array<Google::Apis::RunV1::VolumeMount>

Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem. Corresponds to the JSON property volumeMounts

Returns:



604
605
606
 
# File 'lib/google/apis/run_v1/classes.rb', line 604

def volume_mounts
  @volume_mounts
end

#working_dir ⇒ String

Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Corresponds to the JSON property workingDir

Returns:

  • (String) 


610
611
612
 
# File 'lib/google/apis/run_v1/classes.rb', line 610

def working_dir
  @working_dir
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/google/apis/run_v1/classes.rb', line 617

def update!(**args)
  @args = args[:args] if args.key?(:args)
  @command = args[:command] if args.key?(:command)
  @env = args[:env] if args.key?(:env)
  @env_from = args[:env_from] if args.key?(:env_from)
  @image = args[:image] if args.key?(:image)
  @image_pull_policy = args[:image_pull_policy] if args.key?(:image_pull_policy)
  @liveness_probe = args[:liveness_probe] if args.key?(:liveness_probe)
  @name = args[:name] if args.key?(:name)
  @ports = args[:ports] if args.key?(:ports)
  @readiness_probe = args[:readiness_probe] if args.key?(:readiness_probe)
  @resources = args[:resources] if args.key?(:resources)
  @security_context = args[:security_context] if args.key?(:security_context)
  @startup_probe = args[:startup_probe] if args.key?(:startup_probe)
  @termination_message_path = args[:termination_message_path] if args.key?(:termination_message_path)
  @termination_message_policy = args[:termination_message_policy] if args.key?(:termination_message_policy)
  @volume_mounts = args[:volume_mounts] if args.key?(:volume_mounts)
  @working_dir = args[:working_dir] if args.key?(:working_dir)
end