Type object
File match cloud-run-v1.yml cloud-run-v1.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/cloud-run-spec-v1/latest.json
Source https://www.schemastore.org/cloud-run-v1.json

Validate with Lintel

npx @lintel/lintel check
Type: object

All of

1. variant
2. variant
3. variant
4. variant
5. variant
6. variant
7. variant
8. variant

Definitions

Revision object

Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision

apiVersion string

The API version for this call such as "serving.knative.dev/v1".

kind const: "Revision"

The kind of this resource, in this case "Revision".

Constant: "Revision"
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

RevisionSpec holds the desired state of the Revision (from the client).

7 nested properties
containers Container[] required

Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.

containerConcurrency integer

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.

timeoutSeconds integer

TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour).

max=3600
serviceAccountName string

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.

volumes Volume[]
runtimeClassName string

Runtime. Leave unset for default.

nodeSelector Record<string, string>

Optional. The Node Selector configuration. Map of selector key to a value which matches a node.

status object

RevisionStatus communicates the observed state of the Revision (from the controller).

4 nested properties
observedGeneration integer

ObservedGeneration is the 'Generation' of the Revision that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False.

Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. As a Revision is being prepared, it will incrementally update conditions. Revision-specific conditions include: * ResourcesAvailable: True when underlying resources have been provisioned. * ContainerHealthy: True when the Revision readiness check completes. * Active: True when the Revision may receive traffic.

logUrl string

Optional. Specifies the generated logging url for this particular revision based on the revision url template specified in the controller's config.

imageDigest string

ImageDigest holds the resolved digest for the image specified within .Spec.Container.Image. The digest is resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object.

ObjectMeta object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

RevisionSpec object

RevisionSpec holds the desired state of the Revision (from the client).

containers Container[] required

Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.

containerConcurrency integer

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.

timeoutSeconds integer

TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour).

max=3600
serviceAccountName string

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.

volumes Volume[]
runtimeClassName string

Runtime. Leave unset for default.

nodeSelector Record<string, string>

Optional. The Node Selector configuration. Map of selector key to a value which matches a node.

Container object

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.

image string required

Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.

name string

Name of the container specified as a DNS_LABEL (RFC 1123).

command string[]

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.

args string[]

Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.

env EnvVar[]

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.

resources object

ResourceRequirements describes the compute resource requirements.

2 nested properties
limits Record<string, string>

Limits describes the maximum amount of compute resources allowed. Only 'cpu' and 'memory' keys are supported. * For supported 'cpu' values, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits

requests Record<string, string>

Requests describes the minimum amount of compute resources required. Only cpu and memory are supported. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. * For supported 'cpu' values, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits

workingDir string

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

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.

volumeMounts VolumeMount[]

Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem.

livenessProbe object

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

8 nested properties
initialDelaySeconds integer

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.

min=0
timeoutSeconds integer

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.

min=1max=3600
periodSeconds integer

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.

min=1max=3600
successThreshold const: 1

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.

Constant: 1
failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

min=1
httpGet object

HTTPGetAction describes an action based on HTTP Get requests.

3 nested properties
path string

Path to access on the HTTP server.

httpHeaders string[]

Custom headers to set in the request. HTTP allows repeated headers.

port integer

Port number to access on the container. Number must be in the range 1 to 65535.

tcpSocket object

TCPSocketAction describes an action based on opening a socket

1 nested properties
port integer

Port number to access on the container. Number must be in the range 1 to 65535.

min=1max=65535
grpc object

GRPCAction describes an action involving a GRPC port.

2 nested properties
port integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

min=1max=65535
service string

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.

startupProbe object

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

8 nested properties
initialDelaySeconds integer

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.

min=0
timeoutSeconds integer

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.

min=1max=3600
periodSeconds integer

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.

min=1max=3600
successThreshold const: 1

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.

Constant: 1
failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

min=1
httpGet object

HTTPGetAction describes an action based on HTTP Get requests.

3 nested properties
path string

Path to access on the HTTP server.

httpHeaders string[]

Custom headers to set in the request. HTTP allows repeated headers.

port integer

Port number to access on the container. Number must be in the range 1 to 65535.

tcpSocket object

TCPSocketAction describes an action based on opening a socket

1 nested properties
port integer

Port number to access on the container. Number must be in the range 1 to 65535.

min=1max=65535
grpc object

GRPCAction describes an action involving a GRPC port.

2 nested properties
port integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

min=1max=65535
service string

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.

terminationMessagePath 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.

terminationMessagePolicy 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.

imagePullPolicy enum

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.

Values: "Always" "Never" "IfNotPresent"
EnvVar object

EnvVar represents an environment variable present in a Container.

name string

Required. Name of the environment variable.

value string

Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.

valueFrom object

EnvVarSource represents a source for the value of an EnvVar.

1 nested properties
secretKeyRef object

SecretKeySelector selects a key of a Secret.

3 nested properties
key string required

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.

name string required

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 boolean

Specify whether the Secret or its key must be defined.

EnvVarSource object

EnvVarSource represents a source for the value of an EnvVar.

secretKeyRef object

SecretKeySelector selects a key of a Secret.

3 nested properties
key string required

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.

name string required

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 boolean

Specify whether the Secret or its key must be defined.

SecretKeySelector object

SecretKeySelector selects a key of a Secret.

key string required

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.

name string required

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 boolean

Specify whether the Secret or its key must be defined.

ResourceRequirements object

ResourceRequirements describes the compute resource requirements.

limits Record<string, string>

Limits describes the maximum amount of compute resources allowed. Only 'cpu' and 'memory' keys are supported. * For supported 'cpu' values, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits

requests Record<string, string>

Requests describes the minimum amount of compute resources required. Only cpu and memory are supported. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. * For supported 'cpu' values, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits

ContainerPort object

ContainerPort represents a network port in a single container.

name string

If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".

containerPort integer

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

min=1max=65535
protocol const: "TCP"

Protocol for port. Must be "TCP". Defaults to "TCP".

Constant: "TCP"
VolumeMount object

VolumeMount describes a mounting of a Volume within a container.

name string required

Required. The name of the volume. There must be a corresponding Volume with the same name.

mountPath string required

Required. Path within the container at which the volume should be mounted. Must not contain ':'.

subPath string

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

Probe object

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

initialDelaySeconds integer

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.

min=0
timeoutSeconds integer

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.

min=1max=3600
periodSeconds integer

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.

min=1max=3600
successThreshold const: 1

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.

Constant: 1
failureThreshold integer

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

min=1
httpGet object

HTTPGetAction describes an action based on HTTP Get requests.

3 nested properties
path string

Path to access on the HTTP server.

httpHeaders string[]

Custom headers to set in the request. HTTP allows repeated headers.

port integer

Port number to access on the container. Number must be in the range 1 to 65535.

tcpSocket object

TCPSocketAction describes an action based on opening a socket

1 nested properties
port integer

Port number to access on the container. Number must be in the range 1 to 65535.

min=1max=65535
grpc object

GRPCAction describes an action involving a GRPC port.

2 nested properties
port integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

min=1max=65535
service string

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.

HTTPGetAction object

HTTPGetAction describes an action based on HTTP Get requests.

path string

Path to access on the HTTP server.

httpHeaders string[]

Custom headers to set in the request. HTTP allows repeated headers.

port integer

Port number to access on the container. Number must be in the range 1 to 65535.

TCPSocketAction object

TCPSocketAction describes an action based on opening a socket

port integer

Port number to access on the container. Number must be in the range 1 to 65535.

min=1max=65535
GRPCAction object

GRPCAction describes an action involving a GRPC port.

port integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

min=1max=65535
service string

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.

Volume object

Volume represents a named volume in a container.

name string

Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved.

secret object

A volume representing a secret stored in Google Secret Manager. 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 secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names.

3 nested properties
secretName string

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.

items KeyToPath[]

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.

defaultMode integer

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.

min=1max=511
emptyDir object

In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs).

2 nested properties
medium enum

The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Values: "" "Memory"
sizeLimit string

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. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

nfs object

Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down.

3 nested properties
server string

Hostname or IP address of the NFS server.

path string

Path that is exported by the NFS server.

readOnly boolean

If true, mount the NFS volume as read only. Defaults to false.

csi object

Storage volume source using the Container Storage Interface.

3 nested properties
driver const: "gcsfuse.run.googleapis.com"

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.

Constant: "gcsfuse.run.googleapis.com"
readOnly boolean

If true, mount the volume as read only. Defaults to false.

volumeAttributes Record<string, string>

stores driver specific attributes. For Google Cloud Storage volumes, the following attributes are supported: * bucketName: the name of the Cloud Storage bucket to mount. The Cloud Run Service identity must have access to this bucket.

SecretVolumeSource object

A volume representing a secret stored in Google Secret Manager. 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 secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names.

secretName string

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.

items KeyToPath[]

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.

defaultMode integer

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.

min=1max=511
KeyToPath object

Maps a string key to a path within a volume.

key string

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.

path string

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 '..'.

mode integer

(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.

EmptyDirVolumeSource object

In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs).

medium enum

The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Values: "" "Memory"
sizeLimit string

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. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

NFSVolumeSource object

Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down.

server string

Hostname or IP address of the NFS server.

path string

Path that is exported by the NFS server.

readOnly boolean

If true, mount the NFS volume as read only. Defaults to false.

CSIVolumeSource object

Storage volume source using the Container Storage Interface.

driver const: "gcsfuse.run.googleapis.com"

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.

Constant: "gcsfuse.run.googleapis.com"
readOnly boolean

If true, mount the volume as read only. Defaults to false.

volumeAttributes Record<string, string>

stores driver specific attributes. For Google Cloud Storage volumes, the following attributes are supported: * bucketName: the name of the Cloud Storage bucket to mount. The Cloud Run Service identity must have access to this bucket.

RevisionStatus object

RevisionStatus communicates the observed state of the Revision (from the controller).

observedGeneration integer

ObservedGeneration is the 'Generation' of the Revision that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False.

Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. As a Revision is being prepared, it will incrementally update conditions. Revision-specific conditions include: * ResourcesAvailable: True when underlying resources have been provisioned. * ContainerHealthy: True when the Revision readiness check completes. * Active: True when the Revision may receive traffic.

logUrl string

Optional. Specifies the generated logging url for this particular revision based on the revision url template specified in the controller's config.

imageDigest string

ImageDigest holds the resolved digest for the image specified within .Spec.Container.Image. The digest is resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object.

GoogleCloudRunV1Condition object

Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.

type string

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.

status enum

Status of the condition, one of True, False, Unknown.

Values: "True" "False" "Unknown"
reason string

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.

message string

Optional. Human readable message indicating details about the current status.

lastTransitionTime string

Optional. Last time the condition transitioned from one status to another.

format=date-time
severity enum

Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.

Values: "Error" "Warning" "Info"
Configuration object

Configuration represents the "floating HEAD" of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration's spec. The "latest created" revision's name is available under status, as is the "latest ready" revision's name.

apiVersion string

The API version for this call such as "serving.knative.dev/v1".

kind const: "Configuration"

The kind of resource, in this case always "Configuration".

Constant: "Configuration"
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

ConfigurationSpec holds the desired state of the Configuration (from the client).

1 nested properties
template object

RevisionTemplateSpec describes the data a revision should have when created from a template.

2 nested properties
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

spec object

RevisionSpec holds the desired state of the Revision (from the client).

status object

ConfigurationStatus communicates the observed state of the Configuration (from the controller).

4 nested properties
observedGeneration integer

ObservedGeneration is the 'Generation' of the Configuration that was last processed by the controller. The observed generation is updated even if the controller failed to process the spec and create the Revision. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False.

latestCreatedRevisionName string

LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, so for the latest ready revision, use LatestReadyRevisionName.

latestReadyRevisionName string

LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True".

Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.

ConfigurationSpec object

ConfigurationSpec holds the desired state of the Configuration (from the client).

template object

RevisionTemplateSpec describes the data a revision should have when created from a template.

2 nested properties
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

RevisionSpec holds the desired state of the Revision (from the client).

7 nested properties
containers Container[] required

Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.

containerConcurrency integer

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.

timeoutSeconds integer

TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour).

max=3600
serviceAccountName string

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.

volumes Volume[]
runtimeClassName string

Runtime. Leave unset for default.

nodeSelector Record<string, string>

Optional. The Node Selector configuration. Map of selector key to a value which matches a node.

RevisionTemplate object

RevisionTemplateSpec describes the data a revision should have when created from a template.

metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

RevisionSpec holds the desired state of the Revision (from the client).

7 nested properties
containers Container[] required

Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.

containerConcurrency integer

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.

timeoutSeconds integer

TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour).

max=3600
serviceAccountName string

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.

volumes Volume[]
runtimeClassName string

Runtime. Leave unset for default.

nodeSelector Record<string, string>

Optional. The Node Selector configuration. Map of selector key to a value which matches a node.

ConfigurationStatus object

ConfigurationStatus communicates the observed state of the Configuration (from the controller).

observedGeneration integer

ObservedGeneration is the 'Generation' of the Configuration that was last processed by the controller. The observed generation is updated even if the controller failed to process the spec and create the Revision. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False.

latestCreatedRevisionName string

LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, so for the latest ready revision, use LatestReadyRevisionName.

latestReadyRevisionName string

LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True".

Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.

DomainMapping object

Resource to hold the state and status of a user's domain mapping. NOTE: This resource is currently in Beta.

apiVersion string

The API version for this call such as "domains.cloudrun.com/v1".

kind const: "DomainMapping"

The kind of resource, in this case "DomainMapping".

Constant: "DomainMapping"
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

The desired state of the Domain Mapping.

3 nested properties
routeName string

The name of the Knative Route that this DomainMapping applies to. The route must exist.

certificateMode string

The mode of the certificate.

Any of: const: "CERTIFICATE_MODE_UNSPECIFIED", Do not provision an HTTPS certificate. const: "NONE", Automatically provisions an HTTPS certificate via GoogleCA. const: "AUTOMATIC"
forceOverride boolean

If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.

status object

The current state of the Domain Mapping.

4 nested properties

Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.

observedGeneration integer

ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.

resourceRecords ResourceRecord[]

The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.

mappedRouteName string

The name of the route that the mapping currently points to.

DomainMappingSpec object

The desired state of the Domain Mapping.

routeName string

The name of the Knative Route that this DomainMapping applies to. The route must exist.

certificateMode string

The mode of the certificate.

Any of: const: "CERTIFICATE_MODE_UNSPECIFIED", Do not provision an HTTPS certificate. const: "NONE", Automatically provisions an HTTPS certificate via GoogleCA. const: "AUTOMATIC"
forceOverride boolean

If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.

DomainMappingStatus object

The current state of the Domain Mapping.

Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.

observedGeneration integer

ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.

resourceRecords ResourceRecord[]

The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.

mappedRouteName string

The name of the route that the mapping currently points to.

ResourceRecord object

A DNS resource record.

name string

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

rrdata string

Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).

type string

Resource record type. Example: AAAA.

Any of: An unknown resource record. const: "RECORD_TYPE_UNSPECIFIED", An A resource record. Data is an IPv4 address. const: "A", An AAAA resource record. Data is an IPv6 address. const: "AAAA", A CNAME resource record. Data is a domain name to be aliased. const: "CNAME"
Task object

Task represents a single run of a container to completion.

apiVersion string

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.

kind const: "Task"

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.

Constant: "Task"
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

TaskSpec is a description of a task.

5 nested properties
volumes Volume[]

Optional. List of volumes that can be mounted by containers belonging to the task.

containers Container[]

Optional. List of containers belonging to the task. We disallow a number of fields on this Container.

maxRetries integer

Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3.

timeoutSeconds string

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.

serviceAccountName string

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.

TaskSpec object

TaskSpec is a description of a task.

volumes Volume[]

Optional. List of volumes that can be mounted by containers belonging to the task.

containers Container[]

Optional. List of containers belonging to the task. We disallow a number of fields on this Container.

maxRetries integer

Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3.

timeoutSeconds string

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.

serviceAccountName string

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.

Execution object

Execution represents the configuration of a single execution. An execution is an immutable resource that references a container image which is run to completion.

apiVersion string

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.

kind const: "Execution"

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.

Constant: "Execution"
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

ExecutionSpec describes how the execution will look.

3 nested properties
parallelism integer

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.

taskCount integer

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 object

TaskTemplateSpec describes the data a task should have when created from a template.

1 nested properties
spec object

TaskSpec is a description of a task.

ExecutionSpec object

ExecutionSpec describes how the execution will look.

parallelism integer

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.

taskCount integer

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 object

TaskTemplateSpec describes the data a task should have when created from a template.

1 nested properties
spec object

TaskSpec is a description of a task.

5 nested properties
volumes Volume[]

Optional. List of volumes that can be mounted by containers belonging to the task.

containers Container[]

Optional. List of containers belonging to the task. We disallow a number of fields on this Container.

maxRetries integer

Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3.

timeoutSeconds string

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.

serviceAccountName string

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.

TaskTemplateSpec object

TaskTemplateSpec describes the data a task should have when created from a template.

spec object

TaskSpec is a description of a task.

5 nested properties
volumes Volume[]

Optional. List of volumes that can be mounted by containers belonging to the task.

containers Container[]

Optional. List of containers belonging to the task. We disallow a number of fields on this Container.

maxRetries integer

Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3.

timeoutSeconds string

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.

serviceAccountName string

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.

Job object

Job represents the configuration of a single job, which references a container image which is run to completion.

apiVersion string

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.

kind const: "Job"

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.

Constant: "Job"
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

JobSpec describes how the job will look.

3 nested properties
template object

ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job.

2 nested properties
spec object required

ExecutionSpec describes how the execution will look.

metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

startExecutionToken string

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.

runExecutionToken string

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.

JobSpec object

JobSpec describes how the job will look.

template object

ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job.

2 nested properties
spec object required

ExecutionSpec describes how the execution will look.

3 nested properties
parallelism integer

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.

taskCount integer

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 object

TaskTemplateSpec describes the data a task should have when created from a template.

metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

startExecutionToken string

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.

runExecutionToken string

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.

ExecutionTemplateSpec object

ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job.

spec object required

ExecutionSpec describes how the execution will look.

3 nested properties
parallelism integer

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.

taskCount integer

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 object

TaskTemplateSpec describes the data a task should have when created from a template.

1 nested properties
spec object

TaskSpec is a description of a task.

metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

Route object

Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for "latest ready" revision changes, and smoothly rolling out latest revisions. Cloud Run currently supports referencing a single Configuration to automatically deploy the "latest ready" Revision from that Configuration.

apiVersion string

The API version for this call such as "serving.knative.dev/v1".

kind const: "Route"

The kind of this resource, in this case always "Route".

Constant: "Route"
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

RouteSpec holds the desired state of the Route (from the client).

1 nested properties
traffic TrafficTarget[]

Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. Cloud Run currently supports a single configurationName.

status object

RouteStatus communicates the observed state of the Route (from the controller).

5 nested properties
observedGeneration integer

ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. Note that providing a TrafficTarget that has latest_revision=True will result in a Route that does not increment either its metadata.generation or its observedGeneration, as new "latest ready" revisions from the Configuration are processed without an update to the Route's spec.

Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.

traffic TrafficTarget[]

Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that was last observed.

url string

URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form: <https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app>

address object

Information for connecting over HTTP(s).

1 nested properties
url string
RouteSpec object

RouteSpec holds the desired state of the Route (from the client).

traffic TrafficTarget[]

Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. Cloud Run currently supports a single configurationName.

TrafficTarget object

TrafficTarget holds a single entry of the routing table for a Route.

revisionName string

Points this traffic target to a specific Revision. This field is mutually exclusive with latest_revision.

percent integer

Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified.

tag string

Tag is used to expose a dedicated url for referencing this target exclusively.

latestRevision boolean

Uses the "status.latestReadyRevisionName" of the Service to determine the traffic target. When it changes, traffic will automatically migrate from the prior "latest ready" revision to the new one. This field must be false if RevisionName is set. This field defaults to true otherwise. If the field is set to true on Status, this means that the Revision was resolved from the Service's latest ready revision.

RouteStatus object

RouteStatus communicates the observed state of the Route (from the controller).

observedGeneration integer

ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. Note that providing a TrafficTarget that has latest_revision=True will result in a Route that does not increment either its metadata.generation or its observedGeneration, as new "latest ready" revisions from the Configuration are processed without an update to the Route's spec.

Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.

traffic TrafficTarget[]

Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that was last observed.

url string

URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form: <https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app>

address object

Information for connecting over HTTP(s).

1 nested properties
url string
Addressable object

Information for connecting over HTTP(s).

url string
Service object

Service acts as a top-level container that manages a set of Routes and Configurations which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership. Service acts only as an orchestrator of the underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets). The Service's controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own.

apiVersion const: "serving.knative.dev/v1"

The API version for this call. It must be "serving.knative.dev/v1".

Constant: "serving.knative.dev/v1"
kind const: "Service"

The kind of resource. It must be "Service".

Constant: "Service"
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s).

2 nested properties
template object

RevisionTemplateSpec describes the data a revision should have when created from a template.

2 nested properties
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

spec object

RevisionSpec holds the desired state of the Revision (from the client).

traffic TrafficTarget[]

Specifies how to distribute traffic over a collection of Knative Revisions and Configurations to the Service's main URL.

ServiceSpec object

ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s).

template object

RevisionTemplateSpec describes the data a revision should have when created from a template.

2 nested properties
metadata object

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

5 nested properties
name string

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 string

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.

selfLink string

URL representing this object.

labels Record<string, string>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.

annotations Record<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/base-images: Service, Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/build-base-image: Service. * run.googleapis.com/build-environment-variables: Service. * run.googleapis.com/build-id: Service. * run.googleapis.com/build-name: Service. * run.googleapis.com/build-service-account: Service. * run.googleapis.com/build-worker-pool: Service. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/enable-automatic-updates: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/function-target: Service. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/image-uri: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/source-location: Service. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.

spec object

RevisionSpec holds the desired state of the Revision (from the client).

7 nested properties
containers Container[] required

Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.

containerConcurrency integer

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.

timeoutSeconds integer

TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour).

max=3600
serviceAccountName string

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.

volumes Volume[]
runtimeClassName string

Runtime. Leave unset for default.

nodeSelector Record<string, string>

Optional. The Node Selector configuration. Map of selector key to a value which matches a node.

traffic TrafficTarget[]

Specifies how to distribute traffic over a collection of Knative Revisions and Configurations to the Service's main URL.