RunJob
Property | Value |
---|---|
Google Cloud Service Name | Run |
Google Cloud Service Documentation | /run/docs/ |
Google Cloud REST Resource Name | v2.projects.locations.jobs |
Google Cloud REST Resource Documentation | /run/docs/reference/rest/v2/projects.locations.jobs |
Config Connector Resource Short Names | gcprunjob gcprunjobs runjob |
Config Connector Service Name | run.googleapis.com |
Config Connector Resource Fully Qualified Name | runjobs.run.cnrm.cloud.google.com |
Can Be Referenced by IAMPolicy/IAMPolicyMember | Yes |
Supports IAM Conditions | No |
Supports IAM Audit Configs | No |
IAM External Reference Format |
projects/{{project}}/locations/{{location}}/jobs/{{name}} |
Config Connector Default Average Reconcile Interval In Seconds | 600 |
Custom Resource Definition Properties
Spec
Schema
annotations:
string: string
binaryAuthorization:
breakglassJustification: string
useDefault: boolean
client: string
clientVersion: string
launchStage: string
location: string
projectRef:
external: string
name: string
namespace: string
resourceID: string
template:
annotations:
string: string
parallelism: integer
taskCount: integer
template:
containers:
- args:
- string
command:
- string
env:
- name: string
value: string
valueSource:
secretKeyRef:
secretRef:
external: string
name: string
namespace: string
versionRef:
external: string
name: string
namespace: string
image: string
livenessProbe:
failureThreshold: integer
httpGet:
httpHeaders:
- name: string
value: string
path: string
initialDelaySeconds: integer
periodSeconds: integer
tcpSocket:
port: integer
timeoutSeconds: integer
name: string
ports:
- containerPort: integer
name: string
resources:
limits:
string: string
startupProbe:
failureThreshold: integer
httpGet:
httpHeaders:
- name: string
value: string
path: string
initialDelaySeconds: integer
periodSeconds: integer
tcpSocket:
port: integer
timeoutSeconds: integer
volumeMounts:
- mountPath: string
name: string
workingDir: string
encryptionKeyRef:
external: string
name: string
namespace: string
executionEnvironment: string
maxRetries: integer
serviceAccountRef:
external: string
name: string
namespace: string
timeout: string
volumes:
- cloudSqlInstance:
instanceRefs:
- external: string
name: string
namespace: string
emptyDir:
medium: string
sizeLimit: string
name: string
secret:
defaultMode: integer
items:
- mode: integer
path: string
versionRef:
external: string
name: string
namespace: string
secretRef:
external: string
name: string
namespace: string
vpcAccess:
connectorRef:
external: string
name: string
namespace: string
egress: string
networkInterfaces:
- networkRef:
external: string
name: string
namespace: string
subnetworkRef:
external: string
name: string
namespace: string
tags:
- string
Fields | |
---|---|
Optional |
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules. |
Optional |
Settings for the Binary Authorization feature. |
Optional |
If present, indicates to use Breakglass using this justification. If useDefault is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass. |
Optional |
If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled. |
Optional |
Arbitrary identifier for the API client. |
Optional |
Arbitrary version identifier for the API client. |
Optional |
The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"]. |
Required |
Immutable. The location of the cloud run job. |
Required |
The project that this resource belongs to. |
Optional |
Allowed value: The `name` field of a `Project` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. |
Required |
The template used to create executions for this Job. |
Optional |
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. |
Optional |
Specifies the maximum desired number of tasks the execution should run at given time. Must be <= taskCount. 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 remaining, i.e. when the work left to do is less than max parallelism. |
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. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/. |
Required |
Describes the task(s) that will be created when executing an execution. |
Optional |
Holds the single container that defines the unit of execution for this task. |
Optional |
|
Optional |
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. |
Optional |
|
Optional |
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. |
Optional |
|
Optional |
List of environment variables to set in the container. |
Optional |
|
Required* |
Name of the environment variable. Must be a C_IDENTIFIER, and mnay not exceed 32768 characters. |
Optional |
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. 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. Defaults to "", and the maximum length is 32768 bytes. |
Optional |
Source for the environment variable's value. |
Optional |
Selects a secret and a specific version from Cloud Secret Manager. |
Required* |
The name of the secret in Cloud Secret Manager. Format: {secretName} if the secret is in the same project. projects/{project}/secrets/{secretName} if the secret is in a different project. |
Optional |
Allowed value: The `name` field of a `SecretManagerSecret` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Required* |
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. |
Optional |
Allowed value: The `version` field of a `SecretManagerSecretVersion` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Required* |
URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images. |
Optional |
DEPRECATED. `liveness_probe` is deprecated. This field is not supported by the Cloud Run API. Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. |
Optional |
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
Optional |
HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. |
Optional |
Custom headers to set in the request. HTTP allows repeated headers. |
Optional |
|
Required* |
The header field name. |
Optional |
The header field value. |
Optional |
Path to access on the HTTP server. Defaults to '/'. |
Optional |
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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
Optional |
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 timeoutSeconds. |
Optional |
TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. |
Optional |
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080. |
Optional |
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 periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
Optional |
Name of the container specified as a DNS_LABEL. |
Optional |
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. |
Optional |
|
Optional |
Port number the container listens on. This must be a valid TCP port number, 0 < containerPort < 65536. |
Optional |
If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c". |
Optional |
Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources. |
Optional |
Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go. |
Optional |
DEPRECATED. `startup_probe` is deprecated. This field is not supported by the Cloud Run API. Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. |
Optional |
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
Optional |
HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. |
Optional |
Custom headers to set in the request. HTTP allows repeated headers. |
Optional |
|
Required* |
The header field name. |
Optional |
The header field value. |
Optional |
Path to access on the HTTP server. Defaults to '/'. |
Optional |
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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
Optional |
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 timeoutSeconds. |
Optional |
TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. |
Optional |
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080. |
Optional |
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 periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes. |
Optional |
Volume to mount into the container's filesystem. |
Optional |
|
Required* |
Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run. |
Required* |
This must match the Name of a Volume. |
Optional |
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. |
Optional |
A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek |
Optional |
Allowed value: The `selfLink` field of a `KMSCryptoKey` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
The execution environment being used to host this Task. Possible values: ["EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2"]. |
Optional |
Number of retries allowed per Task, before marking this Task failed. |
Optional |
Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. |
Optional |
Allowed value: The `email` field of an `IAMServiceAccount` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Max allowed time duration 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. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". |
Optional |
A list of Volumes to make available to containers. |
Optional |
|
Optional |
For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. |
Optional |
|
Optional |
The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance} |
Optional |
Allowed value: The `connectionName` field of a `SQLInstance` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Ephemeral storage used as a shared volume. |
Optional |
The different types of medium supported for EmptyDir. Default value: "MEMORY" Possible values: ["MEMORY"]. |
Optional |
Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. This field's values are of the 'Quantity' k8s type: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir. |
Required* |
Volume's name. |
Optional |
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret. |
Optional |
Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. |
Optional |
If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If 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 a path and a version. |
Optional |
|
Optional |
Integer octal 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. |
Required* |
The relative path of the secret in the container. |
Required* |
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version |
Optional |
Allowed value: The `version` field of a `SecretManagerSecretVersion` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Required* |
The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project. |
Optional |
Allowed value: The `name` field of a `SecretManagerSecret` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. |
Optional |
VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. |
Optional |
Allowed value: The `selfLink` field of a `VPCAccessConnector` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"]. |
Optional |
Direct VPC egress settings. Currently only single network interface is supported. |
Optional |
|
Optional |
The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork. |
Optional |
Allowed value: The `selfLink` field of a `ComputeNetwork` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. |
Optional |
Allowed value: The `selfLink` field of a `ComputeSubnetwork` resource. |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Network tags applied to this Cloud Run job. |
Optional |
|
* Field is required when parent field is specified
Status
Schema
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createTime: string
creator: string
deleteTime: string
etag: string
executionCount: integer
expireTime: string
lastModifier: string
latestCreatedExecution:
- completionTime: string
createTime: string
name: string
observedGeneration: integer
reconciling: boolean
terminalCondition:
- executionReason: string
lastTransitionTime: string
message: string
reason: string
revisionReason: string
severity: string
state: string
type: string
uid: string
updateTime: string
Fields | |
---|---|
conditions |
Conditions represent the latest available observation of the resource's current state. |
conditions[] |
|
conditions[].lastTransitionTime |
Last time the condition transitioned from one status to another. |
conditions[].message |
Human-readable message indicating details about last transition. |
conditions[].reason |
Unique, one-word, CamelCase reason for the condition's last transition. |
conditions[].status |
Status is the status of the condition. Can be True, False, Unknown. |
conditions[].type |
Type is the type of the condition. |
createTime |
The creation time. |
creator |
Email address of the authenticated creator. |
deleteTime |
The deletion time. |
etag |
A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. |
executionCount |
Number of executions created for this job. |
expireTime |
For a deleted resource, the time after which it will be permamently deleted. |
lastModifier |
Email address of the last authenticated modifier. |
latestCreatedExecution |
Name of the last created execution. |
latestCreatedExecution[] |
|
latestCreatedExecution[].completionTime |
Completion timestamp of the execution. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
latestCreatedExecution[].createTime |
Creation timestamp of the execution. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
latestCreatedExecution[].name |
Name of the execution. |
observedGeneration |
ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. |
reconciling |
Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, observedGeneration and latest_succeeded_execution, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in terminalCondition.state. If reconciliation succeeded, the following fields will match: observedGeneration and generation, latest_succeeded_execution and latestCreatedExecution. If reconciliation failed, observedGeneration and latest_succeeded_execution will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in terminalCondition and conditions. |
terminalCondition |
The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state. |
terminalCondition[] |
|
terminalCondition[].executionReason |
A reason for the execution condition. |
terminalCondition[].lastTransitionTime |
Last time the condition transitioned from one status to another. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
terminalCondition[].message |
Human readable message indicating details about the current status. |
terminalCondition[].reason |
A common (service-level) reason for this condition. |
terminalCondition[].revisionReason |
A reason for the revision condition. |
terminalCondition[].severity |
How to interpret failures of this condition, one of Error, Warning, Info. |
terminalCondition[].state |
State of the condition. |
terminalCondition[].type |
type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. |
uid |
Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. |
updateTime |
The last-modified time. |
Sample YAML(s)
Basic Job
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: run.cnrm.cloud.google.com/v1beta1
kind: RunJob
metadata:
name: runjob-sample
spec:
launchStage: "GA"
location: "us-central1"
projectRef:
external: ${PROJECT_ID?}
template:
template:
containers:
- image: "us-docker.pkg.dev/cloudrun/container/hello"
lifecycle:
ignore_changes:
- launch_stage
Job With Iamserviceaccount
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: run.cnrm.cloud.google.com/v1beta1
kind: RunJob
metadata:
name: runjob-sample-iamserviceaccount
spec:
launchStage: "GA"
location: "us-central1"
projectRef:
external: ${PROJECT_ID?}
template:
template:
containers:
- image: "us-docker.pkg.dev/cloudrun/container/hello"
serviceAccountRef:
name: runjob-dep-iamserviceaccount
---
apiVersion: iam.cnrm.cloud.google.com/v1beta1
kind: IAMServiceAccount
metadata:
name: runjob-dep-iamserviceaccount
spec:
displayName: runjob-dep-iamserviceaccount
Job With Kmscryptokey
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: run.cnrm.cloud.google.com/v1beta1
kind: RunJob
metadata:
name: runjob-sample-kmscryptokey
spec:
launchStage: "GA"
location: "us-central1"
projectRef:
external: ${PROJECT_ID?}
template:
template:
containers:
- image: "us-docker.pkg.dev/cloudrun/container/hello"
encryptionKeyRef:
name: runjob-dep-kmscryptokey
---
apiVersion: iam.cnrm.cloud.google.com/v1beta1
kind: IAMPolicyMember
metadata:
name: runjob-dep-kmscryptokey
spec:
member: serviceAccount:service-${PROJECT_NUMBER?}@serverless-robot-prod.iam.gserviceaccount.com
role: roles/cloudkms.cryptoKeyEncrypterDecrypter # required by cloud run service agent to access KMS keys
resourceRef:
apiVersion: resourcemanager.cnrm.cloud.google.com/v1beta1
kind: Project
external: projects/${PROJECT_ID?}
---
apiVersion: kms.cnrm.cloud.google.com/v1beta1
kind: KMSCryptoKey
metadata:
name: runjob-dep-kmscryptokey
spec:
keyRingRef:
name: runjob-dep-kmscryptokey
purpose: ENCRYPT_DECRYPT
---
apiVersion: kms.cnrm.cloud.google.com/v1beta1
kind: KMSKeyRing
metadata:
name: runjob-dep-kmscryptokey
spec:
location: us-central1
Job With SQL
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: run.cnrm.cloud.google.com/v1beta1
kind: RunJob
metadata:
name: runjob-sample-sql
spec:
launchStage: "GA"
location: "us-central1"
projectRef:
external: ${PROJECT_ID?}
template:
template:
containers:
- image: "us-docker.pkg.dev/cloudrun/container/hello"
volumeMounts:
- name: "cloudsql"
mountPath: "/cloudsql"
volumes:
- name: "cloudsql"
cloudSqlInstance:
instanceRefs:
- name: runjob-dep-sql
lifecycle:
ignore_changes:
- launch_stage
---
apiVersion: sql.cnrm.cloud.google.com/v1beta1
kind: SQLInstance
metadata:
name: runjob-dep-sql
spec:
region: us-central1
databaseVersion: MYSQL_5_7
settings:
tier: db-n1-standard-1
Job With Secretmanagersecret
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: run.cnrm.cloud.google.com/v1beta1
kind: RunJob
metadata:
name: runjob-sample-secretmanagersecret
spec:
launchStage: "GA"
location: "us-central1"
projectRef:
external: ${PROJECT_ID?}
template:
template:
containers:
- image: "us-docker.pkg.dev/cloudrun/container/hello"
env:
- name: "FOO"
value: "bar"
- name: "SECRET_ENV_VAR"
valueSource:
secretKeyRef:
secretRef:
name: runjob-dep-secretmanagersecret
versionRef:
name: runjob-dep-secretmanagersecret
---
apiVersion: iam.cnrm.cloud.google.com/v1beta1
kind: IAMPolicyMember
metadata:
name: runjob-dep-secretmanagersecret
spec:
member: serviceAccount:${PROJECT_NUMBER?}-compute@developer.gserviceaccount.com
role: roles/secretmanager.secretAccessor # required by default service account to access secrets
resourceRef:
apiVersion: resourcemanager.cnrm.cloud.google.com/v1beta1
kind: Project
external: projects/${PROJECT_ID?}
---
apiVersion: v1
kind: Secret
metadata:
name: runjob-dep-secretmanagersecret
data:
secretData: SSBhbHdheXMgbG92ZWQgc3BhcnJpbmcgd2l0aCBnaWFudCBjYW5keSBzd29yZHMsIGJ1dCBJIGhhZCBubyBpZGVhIHRoYXQgd2FzIG15IHN1cGVyIHNlY3JldCBpbmZvcm1hdGlvbiE=
---
apiVersion: secretmanager.cnrm.cloud.google.com/v1beta1
kind: SecretManagerSecret
metadata:
annotations:
cnrm.cloud.google.com/project-id: ${PROJECT_ID?}
name: runjob-dep-secretmanagersecret
spec:
replication:
automatic: true
---
apiVersion: secretmanager.cnrm.cloud.google.com/v1beta1
kind: SecretManagerSecretVersion
metadata:
annotations:
cnrm.cloud.google.com/project-id: ${PROJECT_ID?}
name: runjob-dep-secretmanagersecret
spec:
enabled: true
secretData:
valueFrom:
secretKeyRef:
key: secretData
name: runjob-dep-secretmanagersecret
secretRef:
name: runjob-dep-secretmanagersecret