gcp_cloudrun_job

ancestors

Type: UNORDERED_LIST_STRING

api_version

Type: STRING
Provider name: apiVersion
Description: Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.

gcp_status

Type: STRUCT
Provider name: status
Description: Output only. Current status of a job.

  • conditions
    Type: UNORDERED_LIST_STRUCT
    Provider name: conditions
    Description: Conditions communicate information about ongoing/complete reconciliation processes that bring the “spec” inline with the observed state of the world. Job-specific conditions include: * Ready: True when the job is ready to be executed.
    • gcp_status
      Type: STRING
      Provider name: status
      Description: Status of the condition, one of True, False, Unknown.
    • last_transition_time
      Type: TIMESTAMP
      Provider name: lastTransitionTime
      Description: Optional. Last time the condition transitioned from one status to another.
    • message
      Type: STRING
      Provider name: message
      Description: Optional. Human readable message indicating details about the current status.
    • reason
      Type: STRING
      Provider name: reason
      Description: Optional. One-word CamelCase reason for the condition’s last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.
    • severity
      Type: STRING
      Provider name: severity
      Description: Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.
    • type
      Type: STRING
      Provider name: type
      Description: type is used to communicate the status of the reconciliation process. Types common to all resources include: * “Ready” or “Completed”: True when the Resource is ready.
  • execution_count
    Type: INT32
    Provider name: executionCount
    Description: Number of executions created for this job.
  • latest_created_execution
    Type: STRUCT
    Provider name: latestCreatedExecution
    Description: A pointer to the most recently created execution for this job. This is set regardless of the eventual state of the execution.
    • completion_status
      Type: STRING
      Provider name: completionStatus
      Description: Optional. Status for the execution completion.
      Possible values:
      • COMPLETION_STATUS_UNSPECIFIED - The default value. This value is used if the state is omitted.
      • EXECUTION_SUCCEEDED - Job execution has succeeded.
      • EXECUTION_FAILED - Job execution has failed.
      • EXECUTION_RUNNING - Job execution is running normally.
      • EXECUTION_PENDING - Waiting for backing resources to be provisioned.
      • EXECUTION_CANCELLED - Job execution has been cancelled by the user.
    • completion_timestamp
      Type: TIMESTAMP
      Provider name: completionTimestamp
      Description: Optional. Completion timestamp of the execution.
    • creation_timestamp
      Type: TIMESTAMP
      Provider name: creationTimestamp
      Description: Optional. Creation timestamp of the execution.
    • deletion_timestamp
      Type: TIMESTAMP
      Provider name: deletionTimestamp
      Description: Optional. The read-only soft deletion timestamp of the execution.
    • name
      Type: STRING
      Provider name: name
      Description: Optional. Name of the execution.
  • observed_generation
    Type: INT32
    Provider name: observedGeneration
    Description: The ‘generation’ of the job that was last processed by the controller.

kind

Type: STRING
Provider name: kind
Description: Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.

labels

Type: UNORDERED_LIST_STRING

metadata

Type: STRUCT
Provider name: metadata
Description: Optional. Standard object’s metadata.

  • cluster_name
    Type: STRING
    Provider name: clusterName
    Description: Not supported by Cloud Run
  • creation_timestamp
    Type: TIMESTAMP
    Provider name: creationTimestamp
    Description: UTC timestamp representing the server time when this object was created.
  • deletion_grace_period_seconds
    Type: INT32
    Provider name: deletionGracePeriodSeconds
    Description: Not supported by Cloud Run
  • deletion_timestamp
    Type: TIMESTAMP
    Provider name: deletionTimestamp
    Description: The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
  • finalizers
    Type: UNORDERED_LIST_STRING
    Provider name: finalizers
    Description: Not supported by Cloud Run
  • generate_name
    Type: STRING
    Provider name: generateName
    Description: Not supported by Cloud Run
  • generation
    Type: INT32
    Provider name: generation
    Description: A system-provided sequence number representing a specific generation of the desired state.
  • name
    Type: STRING
    Provider name: name
    Description: Required. The name of the resource. Name is required when creating top-level resources (Service, Job), must be unique within a Cloud Run project/region, and cannot be changed once created.
  • namespace
    Type: STRING
    Provider name: namespace
    Description: Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
  • owner_references
    Type: UNORDERED_LIST_STRUCT
    Provider name: ownerReferences
    Description: Not supported by Cloud Run
    • api_version
      Type: STRING
      Provider name: apiVersion
      Description: This is not supported or used by Cloud Run.
    • block_owner_deletion
      Type: BOOLEAN
      Provider name: blockOwnerDeletion
      Description: This is not supported or used by Cloud Run.
    • controller
      Type: BOOLEAN
      Provider name: controller
      Description: This is not supported or used by Cloud Run.
    • kind
      Type: STRING
      Provider name: kind
      Description: This is not supported or used by Cloud Run.
    • name
      Type: STRING
      Provider name: name
      Description: This is not supported or used by Cloud Run.
    • uid
      Type: STRING
      Provider name: uid
      Description: This is not supported or used by Cloud Run.
  • resource_version
    Type: STRING
    Provider name: resourceVersion
    Description: Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
  • self_link
    Type: STRING
    Provider name: selfLink
    Description: URL representing this object.
  • uid
    Type: STRING
    Provider name: uid
    Description: Unique, system-generated identifier for this resource.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

spec

Type: STRUCT
Provider name: spec
Description: Optional. Specification of the desired behavior of a job.

  • run_execution_token
    Type: STRING
    Provider name: runExecutionToken
    Description: A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters.
  • start_execution_token
    Type: STRING
    Provider name: startExecutionToken
    Description: A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters.
  • template
    Type: STRUCT
    Provider name: template
    Description: Optional. Describes the execution that will be created when running a job.
    • metadata
      Type: STRUCT
      Provider name: metadata
      Description: Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * run.googleapis.com/cloudsql-instances sets Cloud SQL connections. Multiple values should be comma separated. * run.googleapis.com/vpc-access-connector sets a Serverless VPC Access connector. * run.googleapis.com/vpc-access-egress sets VPC egress. Supported values are all-traffic, all (deprecated), and private-ranges-only. all-traffic and all provide the same functionality. all is deprecated but will continue to be supported. Prefer all-traffic.
      • cluster_name
        Type: STRING
        Provider name: clusterName
        Description: Not supported by Cloud Run
      • creation_timestamp
        Type: TIMESTAMP
        Provider name: creationTimestamp
        Description: UTC timestamp representing the server time when this object was created.
      • deletion_grace_period_seconds
        Type: INT32
        Provider name: deletionGracePeriodSeconds
        Description: Not supported by Cloud Run
      • deletion_timestamp
        Type: TIMESTAMP
        Provider name: deletionTimestamp
        Description: The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
      • finalizers
        Type: UNORDERED_LIST_STRING
        Provider name: finalizers
        Description: Not supported by Cloud Run
      • generate_name
        Type: STRING
        Provider name: generateName
        Description: Not supported by Cloud Run
      • generation
        Type: INT32
        Provider name: generation
        Description: A system-provided sequence number representing a specific generation of the desired state.
      • name
        Type: STRING
        Provider name: name
        Description: Required. The name of the resource. Name is required when creating top-level resources (Service, Job), must be unique within a Cloud Run project/region, and cannot be changed once created.
      • namespace
        Type: STRING
        Provider name: namespace
        Description: Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
      • owner_references
        Type: UNORDERED_LIST_STRUCT
        Provider name: ownerReferences
        Description: Not supported by Cloud Run
        • api_version
          Type: STRING
          Provider name: apiVersion
          Description: This is not supported or used by Cloud Run.
        • block_owner_deletion
          Type: BOOLEAN
          Provider name: blockOwnerDeletion
          Description: This is not supported or used by Cloud Run.
        • controller
          Type: BOOLEAN
          Provider name: controller
          Description: This is not supported or used by Cloud Run.
        • kind
          Type: STRING
          Provider name: kind
          Description: This is not supported or used by Cloud Run.
        • name
          Type: STRING
          Provider name: name
          Description: This is not supported or used by Cloud Run.
        • uid
          Type: STRING
          Provider name: uid
          Description: This is not supported or used by Cloud Run.
      • resource_version
        Type: STRING
        Provider name: resourceVersion
        Description: Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
      • self_link
        Type: STRING
        Provider name: selfLink
        Description: URL representing this object.
      • uid
        Type: STRING
        Provider name: uid
        Description: Unique, system-generated identifier for this resource.
    • spec
      Type: STRUCT
      Provider name: spec
      Description: Required. ExecutionSpec holds the desired configuration for executions of this job.
      • parallelism
        Type: INT32
        Provider name: parallelism
        Description: Optional. Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed, i.e. when the work left to do is less than max parallelism.
      • task_count
        Type: INT32
        Provider name: taskCount
        Description: Optional. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. Defaults to 1.
      • template
        Type: STRUCT
        Provider name: template
        Description: Optional. The template used to create tasks for this execution.
        • spec
          Type: STRUCT
          Provider name: spec
          Description: Optional. Specification of the desired behavior of the task.
          • containers
            Type: UNORDERED_LIST_STRUCT
            Provider name: containers
            Description: Optional. List of containers belonging to the task. We disallow a number of fields on this Container.
            • args
              Type: UNORDERED_LIST_STRING
              Provider name: args
              Description: Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references are not supported in Cloud Run.

            • command
              Type: UNORDERED_LIST_STRING
              Provider name: command
              Description: Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.

            • env
              Type: UNORDERED_LIST_STRUCT
              Provider name: env
              Description: List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.

              • name
                Type: STRING
                Provider name: name
                Description: Required. Name of the environment variable.
              • value
                Type: STRING
                Provider name: value
                Description: Value of the environment variable. Defaults to “”. Variable references are not supported in Cloud Run.
              • value_from
                Type: STRUCT
                Provider name: valueFrom
                Description: Source for the environment variable’s value. Only supports secret_key_ref. Cannot be used if value is not empty.
                • config_map_key_ref
                  Type: STRUCT
                  Provider name: configMapKeyRef
                  Description: Not supported by Cloud Run. Not supported in Cloud Run.
                  • key
                    Type: STRING
                    Provider name: key
                    Description: Required. Not supported by Cloud Run.
                  • local_object_reference
                    Type: STRUCT
                    Provider name: localObjectReference
                    Description: Not supported by Cloud Run.
                    • name
                      Type: STRING
                      Provider name: name
                      Description: Name of the referent.
                  • name
                    Type: STRING
                    Provider name: name
                    Description: Required. Not supported by Cloud Run.
                  • optional
                    Type: BOOLEAN
                    Provider name: optional
                    Description: Not supported by Cloud Run.
                • secret_key_ref
                  Type: STRUCT
                  Provider name: secretKeyRef
                  Description: Selects a key (version) of a secret in Secret Manager.
                  • key
                    Type: STRING
                    Provider name: key
                    Description: Required. A Cloud Secret Manager secret version. Must be ’latest’ for the latest version, an integer for a specific version, or a version alias. The key of the secret to select from. Must be a valid secret key.
                  • local_object_reference
                    Type: STRUCT
                    Provider name: localObjectReference
                    Description: This field should not be used directly as it is meant to be inlined directly into the message. Use the “name” field instead.
                    • name
                      Type: STRING
                      Provider name: name
                      Description: Name of the referent.
                  • name
                    Type: STRING
                    Provider name: name
                    Description: The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. The name of the secret in the pod’s namespace to select from.
                  • optional
                    Type: BOOLEAN
                    Provider name: optional
                    Description: Specify whether the Secret or its key must be defined.
            • env_from
              Type: UNORDERED_LIST_STRUCT
              Provider name: envFrom
              Description: Not supported by Cloud Run.

              • config_map_ref
                Type: STRUCT
                Provider name: configMapRef
                Description: The ConfigMap to select from
                • local_object_reference
                  Type: STRUCT
                  Provider name: localObjectReference
                  Description: This field should not be used directly as it is meant to be inlined directly into the message. Use the “name” field instead.
                  • name
                    Type: STRING
                    Provider name: name
                    Description: Name of the referent.
                • name
                  Type: STRING
                  Provider name: name
                  Description: The ConfigMap to select from.
                • optional
                  Type: BOOLEAN
                  Provider name: optional
                  Description: Specify whether the ConfigMap must be defined.
              • prefix
                Type: STRING
                Provider name: prefix
                Description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
              • secret_ref
                Type: STRUCT
                Provider name: secretRef
                Description: The Secret to select from
                • local_object_reference
                  Type: STRUCT
                  Provider name: localObjectReference
                  Description: This field should not be used directly as it is meant to be inlined directly into the message. Use the “name” field instead.
                  • name
                    Type: STRING
                    Provider name: name
                    Description: Name of the referent.
                • name
                  Type: STRING
                  Provider name: name
                  Description: The Secret to select from.
                • optional
                  Type: BOOLEAN
                  Provider name: optional
                  Description: Specify whether the Secret must be defined
            • image
              Type: STRING
              Provider name: image
              Description: Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.

            • image_pull_policy
              Type: STRING
              Provider name: imagePullPolicy
              Description: Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.

            • liveness_probe
              Type: STRUCT
              Provider name: livenessProbe
              Description: Periodic probe of container liveness. Container will be restarted if the probe fails.

              • exec
                Type: STRUCT
                Provider name: exec
                Description: Not supported by Cloud Run.
                • command
                  Type: UNORDERED_LIST_STRING
                  Provider name: command
                  Description: Command is the command line to execute inside the container, the working directory for the command is root (’/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (’|’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
              • failure_threshold
                Type: INT32
                Provider name: failureThreshold
                Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
              • grpc
                Type: STRUCT
                Provider name: grpc
                Description: GRPCAction specifies an action involving a GRPC port.
                • port
                  Type: INT32
                  Provider name: port
                  Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
                • service
                  Type: STRING
                  Provider name: service
                  Description: Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.
              • http_get
                Type: STRUCT
                Provider name: httpGet
                Description: HTTPGet specifies the http request to perform.
                • host
                  Type: STRING
                  Provider name: host
                  Description: Not supported by Cloud Run.
                • http_headers
                  Type: UNORDERED_LIST_STRUCT
                  Provider name: httpHeaders
                  Description: Custom headers to set in the request. HTTP allows repeated headers.
                  • name
                    Type: STRING
                    Provider name: name
                    Description: Required. The header field name
                  • value
                    Type: STRING
                    Provider name: value
                    Description: The header field value
                • path
                  Type: STRING
                  Provider name: path
                  Description: Path to access on the HTTP server.
                • port
                  Type: INT32
                  Provider name: port
                  Description: Port number to access on the container. Number must be in the range 1 to 65535.
                • scheme
                  Type: STRING
                  Provider name: scheme
                  Description: Not supported by Cloud Run.
              • initial_delay_seconds
                Type: INT32
                Provider name: initialDelaySeconds
                Description: Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
              • period_seconds
                Type: INT32
                Provider name: periodSeconds
                Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
              • success_threshold
                Type: INT32
                Provider name: successThreshold
                Description: Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
              • tcp_socket
                Type: STRUCT
                Provider name: tcpSocket
                Description: TCPSocket specifies an action involving a TCP port.
                • host
                  Type: STRING
                  Provider name: host
                  Description: Not supported by Cloud Run.
                • port
                  Type: INT32
                  Provider name: port
                  Description: Port number to access on the container. Number must be in the range 1 to 65535.
              • timeout_seconds
                Type: INT32
                Provider name: timeoutSeconds
                Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.
            • name
              Type: STRING
              Provider name: name
              Description: Name of the container specified as a DNS_LABEL (RFC 1123).

            • ports
              Type: UNORDERED_LIST_STRUCT
              Provider name: ports
              Description: 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.

              • container_port
                Type: INT32
                Provider name: containerPort
                Description: Port number the container listens on. If present, this must be a valid port number, 0 < x < 65536. If not present, it will default to port 8080. For more information, see https://cloud.google.com/run/docs/container-contract#port
              • name
                Type: STRING
                Provider name: name
                Description: If specified, used to specify which protocol to use. Allowed values are “http1” and “h2c”.
              • protocol
                Type: STRING
                Provider name: protocol
                Description: Protocol for port. Must be “TCP”. Defaults to “TCP”.
            • readiness_probe
              Type: STRUCT
              Provider name: readinessProbe
              Description: Not supported by Cloud Run.

              • exec
                Type: STRUCT
                Provider name: exec
                Description: Not supported by Cloud Run.
                • command
                  Type: UNORDERED_LIST_STRING
                  Provider name: command
                  Description: Command is the command line to execute inside the container, the working directory for the command is root (’/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (’|’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
              • failure_threshold
                Type: INT32
                Provider name: failureThreshold
                Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
              • grpc
                Type: STRUCT
                Provider name: grpc
                Description: GRPCAction specifies an action involving a GRPC port.
                • port
                  Type: INT32
                  Provider name: port
                  Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
                • service
                  Type: STRING
                  Provider name: service
                  Description: Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.
              • http_get
                Type: STRUCT
                Provider name: httpGet
                Description: HTTPGet specifies the http request to perform.
                • host
                  Type: STRING
                  Provider name: host
                  Description: Not supported by Cloud Run.
                • http_headers
                  Type: UNORDERED_LIST_STRUCT
                  Provider name: httpHeaders
                  Description: Custom headers to set in the request. HTTP allows repeated headers.
                  • name
                    Type: STRING
                    Provider name: name
                    Description: Required. The header field name
                  • value
                    Type: STRING
                    Provider name: value
                    Description: The header field value
                • path
                  Type: STRING
                  Provider name: path
                  Description: Path to access on the HTTP server.
                • port
                  Type: INT32
                  Provider name: port
                  Description: Port number to access on the container. Number must be in the range 1 to 65535.
                • scheme
                  Type: STRING
                  Provider name: scheme
                  Description: Not supported by Cloud Run.
              • initial_delay_seconds
                Type: INT32
                Provider name: initialDelaySeconds
                Description: Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
              • period_seconds
                Type: INT32
                Provider name: periodSeconds
                Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
              • success_threshold
                Type: INT32
                Provider name: successThreshold
                Description: Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
              • tcp_socket
                Type: STRUCT
                Provider name: tcpSocket
                Description: TCPSocket specifies an action involving a TCP port.
                • host
                  Type: STRING
                  Provider name: host
                  Description: Not supported by Cloud Run.
                • port
                  Type: INT32
                  Provider name: port
                  Description: Port number to access on the container. Number must be in the range 1 to 65535.
              • timeout_seconds
                Type: INT32
                Provider name: timeoutSeconds
                Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.
            • resources
              Type: STRUCT
              Provider name: resources
              Description: Compute Resources required by this container.

            • security_context
              Type: STRUCT
              Provider name: securityContext
              Description: Not supported by Cloud Run.

              • run_as_user
                Type: INT32
                Provider name: runAsUser
                Description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
            • startup_probe
              Type: STRUCT
              Provider name: startupProbe
              Description: Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not receive traffic if the probe fails. If not provided, a default startup probe with TCP socket action is used.

              • exec
                Type: STRUCT
                Provider name: exec
                Description: Not supported by Cloud Run.
                • command
                  Type: UNORDERED_LIST_STRING
                  Provider name: command
                  Description: Command is the command line to execute inside the container, the working directory for the command is root (’/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (’|’, etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
              • failure_threshold
                Type: INT32
                Provider name: failureThreshold
                Description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
              • grpc
                Type: STRUCT
                Provider name: grpc
                Description: GRPCAction specifies an action involving a GRPC port.
                • port
                  Type: INT32
                  Provider name: port
                  Description: Port number of the gRPC service. Number must be in the range 1 to 65535.
                • service
                  Type: STRING
                  Provider name: service
                  Description: Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.
              • http_get
                Type: STRUCT
                Provider name: httpGet
                Description: HTTPGet specifies the http request to perform.
                • host
                  Type: STRING
                  Provider name: host
                  Description: Not supported by Cloud Run.
                • http_headers
                  Type: UNORDERED_LIST_STRUCT
                  Provider name: httpHeaders
                  Description: Custom headers to set in the request. HTTP allows repeated headers.
                  • name
                    Type: STRING
                    Provider name: name
                    Description: Required. The header field name
                  • value
                    Type: STRING
                    Provider name: value
                    Description: The header field value
                • path
                  Type: STRING
                  Provider name: path
                  Description: Path to access on the HTTP server.
                • port
                  Type: INT32
                  Provider name: port
                  Description: Port number to access on the container. Number must be in the range 1 to 65535.
                • scheme
                  Type: STRING
                  Provider name: scheme
                  Description: Not supported by Cloud Run.
              • initial_delay_seconds
                Type: INT32
                Provider name: initialDelaySeconds
                Description: Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
              • period_seconds
                Type: INT32
                Provider name: periodSeconds
                Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
              • success_threshold
                Type: INT32
                Provider name: successThreshold
                Description: Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
              • tcp_socket
                Type: STRUCT
                Provider name: tcpSocket
                Description: TCPSocket specifies an action involving a TCP port.
                • host
                  Type: STRING
                  Provider name: host
                  Description: Not supported by Cloud Run.
                • port
                  Type: INT32
                  Provider name: port
                  Description: Port number to access on the container. Number must be in the range 1 to 65535.
              • timeout_seconds
                Type: INT32
                Provider name: timeoutSeconds
                Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.
            • termination_message_path
              Type: STRING
              Provider name: terminationMessagePath
              Description: 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.

            • termination_message_policy
              Type: STRING
              Provider name: terminationMessagePolicy
              Description: 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.

            • volume_mounts
              Type: UNORDERED_LIST_STRUCT
              Provider name: volumeMounts
              Description: Volume to mount into the container’s filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container’s filesystem.

              • mount_path
                Type: STRING
                Provider name: mountPath
                Description: Required. Path within the container at which the volume should be mounted. Must not contain ‘:’.
              • name
                Type: STRING
                Provider name: name
                Description: Required. The name of the volume. There must be a corresponding Volume with the same name.
              • read_only
                Type: BOOLEAN
                Provider name: readOnly
                Description: Sets the mount to be read-only or read-write. Not used by Cloud Run.
              • sub_path
                Type: STRING
                Provider name: subPath
                Description: Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).
            • working_dir
              Type: STRING
              Provider name: workingDir
              Description: Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image.

          • max_retries
            Type: INT32
            Provider name: maxRetries
            Description: Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3.
          • service_account_name
            Type: STRING
            Provider name: serviceAccountName
            Description: Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project’s default service account.
          • timeout_seconds
            Type: STRING
            Provider name: timeoutSeconds
            Description: Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds.
          • volumes
            Type: UNORDERED_LIST_STRUCT
            Provider name: volumes
            Description: Optional. List of volumes that can be mounted by containers belonging to the task.
            • config_map
              Type: STRUCT
              Provider name: configMap
              Description: Not supported in Cloud Run.
              • default_mode
                Type: INT32
                Provider name: defaultMode
                Description: (Optional) Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
              • items
                Type: UNORDERED_LIST_STRUCT
                Provider name: items
                Description: (Optional) If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional.
                • key
                  Type: STRING
                  Provider name: key
                  Description: The Cloud Secret Manager secret version. Can be ’latest’ for the latest value, or an integer or a secret alias for a specific version. The key to project.
                • mode
                  Type: INT32
                  Provider name: mode
                  Description: (Optional) Mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume’s default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
                • path
                  Type: STRING
                  Provider name: path
                  Description: The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’.
              • name
                Type: STRING
                Provider name: name
                Description: Name of the config.
              • optional
                Type: BOOLEAN
                Provider name: optional
                Description: (Optional) Specify whether the Secret or its keys must be defined.
            • csi
              Type: STRUCT
              Provider name: csi
              Description: Volume specified by the Container Storage Interface driver
              • driver
                Type: STRING
                Provider name: driver
                Description: name of the CSI driver for the requested storage system. Cloud Run supports the following drivers: * gcsfuse.run.googleapis.com : Mount a Cloud Storage Bucket as a volume.
              • read_only
                Type: BOOLEAN
                Provider name: readOnly
                Description: If true, mount the volume as read only. Defaults to false.
            • empty_dir
              Type: STRUCT
              Provider name: emptyDir
              Description: Ephemeral storage used as a shared volume.
            • name
              Type: STRING
              Provider name: name
              Description: Volume’s name. In Cloud Run Fully Managed, the name ‘cloudsql’ is reserved.
            • nfs
              Type: STRUCT
              Provider name: nfs
              • path
                Type: STRING
                Provider name: path
                Description: Path that is exported by the NFS server.
              • read_only
                Type: BOOLEAN
                Provider name: readOnly
                Description: If true, mount the NFS volume as read only. Defaults to false.
              • server
                Type: STRING
                Provider name: server
                Description: Hostname or IP address of the NFS server.
            • secret
              Type: STRUCT
              Provider name: secret
              Description: The secret’s value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secretName.
              • default_mode
                Type: INT32
                Provider name: defaultMode
                Description: Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
              • items
                Type: UNORDERED_LIST_STRUCT
                Provider name: items
                Description: A list of secret versions to mount in the volume. If no items are specified, the volume will expose a file with the same name as the secret name. The contents of the file will be the data in the latest version of the secret. If items are specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify both a key and a path.
                • key
                  Type: STRING
                  Provider name: key
                  Description: The Cloud Secret Manager secret version. Can be ’latest’ for the latest value, or an integer or a secret alias for a specific version. The key to project.
                • mode
                  Type: INT32
                  Provider name: mode
                  Description: (Optional) Mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume’s default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
                • path
                  Type: STRING
                  Provider name: path
                  Description: The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ‘..’. May not start with the string ‘..’.
              • optional
                Type: BOOLEAN
                Provider name: optional
                Description: Not supported by Cloud Run.
              • secret_name
                Type: STRING
                Provider name: secretName
                Description: The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container’s namespace to use.

tags

Type: UNORDERED_LIST_STRING