Index
AuthorizedDomains(interface)Configurations(interface)DomainMappings(interface)Revisions(interface)Routes(interface)Services(interface)Addressable(message)AuthorizedDomain(message)Capabilities(message)CertificateMode(enum)ConfigMapEnvSource(message)ConfigMapKeySelector(message)ConfigMapVolumeSource(message)Configuration(message)ConfigurationCondition(message)ConfigurationSpec(message)ConfigurationStatus(message)Container(message)ContainerPort(message)CreateDomainMappingRequest(message)CreateServiceRequest(message)DeleteDomainMappingRequest(message)DeleteRevisionRequest(message)DeleteServiceRequest(message)DomainMapping(message)DomainMappingCondition(message)DomainMappingSpec(message)DomainMappingStatus(message)EnvFromSource(message)EnvVar(message)EnvVarSource(message)ExecAction(message)GetConfigurationRequest(message)GetDomainMappingRequest(message)GetRevisionRequest(message)GetRouteRequest(message)GetServiceRequest(message)HTTPGetAction(message)HTTPHeader(message)Handler(message)IntOrString(message)KeyToPath(message)Lifecycle(message)ListAuthorizedDomainsRequest(message)ListAuthorizedDomainsResponse(message)ListConfigurationsRequest(message)ListConfigurationsResponse(message)ListDomainMappingsRequest(message)ListDomainMappingsResponse(message)ListMeta(message)ListRevisionsRequest(message)ListRevisionsResponse(message)ListRoutesRequest(message)ListRoutesResponse(message)ListServicesRequest(message)ListServicesResponse(message)LocalObjectReference(message)ObjectMeta(message)OwnerReference(message)Probe(message)Quantity(message) (deprecated)ReplaceServiceRequest(message)ResourceRecord(message)ResourceRecord.RecordType(enum)ResourceRequirements(message)Revision(message)RevisionCondition(message)RevisionServingState(enum)RevisionSpec(message)RevisionStatus(message)RevisionTemplate(message)Route(message)RouteCondition(message)RouteSpec(message)RouteStatus(message)SELinuxOptions(message)SecretEnvSource(message)SecretKeySelector(message)SecretVolumeSource(message)SecurityContext(message)Service(message)ServiceCondition(message)ServiceSpec(message)ServiceSpecManualType(message)ServiceSpecPinnedType(message) (deprecated)ServiceSpecReleaseType(message)ServiceSpecRunLatest(message)ServiceStatus(message)TCPSocketAction(message)TrafficTarget(message)Volume(message)VolumeDevice(message)VolumeMount(message)
AuthorizedDomains
The AuthorizedDomains API allows you to list Authorized Domain resources within a Google Cloud Platform project.
| ListAuthorizedDomains | |
|---|---|
|
RPC to list authorized domains. |
|
Configurations
The Configurations API allows you to manage serverless Configurations within a Google Cloud Platform project.
| GetConfiguration | |
|---|---|
|
Rpc to get information about a configuration. |
|
| ListConfigurations | |
|---|---|
|
Rpc to list configurations. |
|
DomainMappings
| CreateDomainMapping | |
|---|---|
|
Creates a new domain mapping. |
|
| DeleteDomainMapping | |
|---|---|
|
Rpc to delete a domain mapping. |
|
| GetDomainMapping | |
|---|---|
|
Rpc to get information about a domain mapping. |
|
| ListDomainMappings | |
|---|---|
|
Rpc to list domain mappings. |
|
Revisions
The Revisions API allows you to manage serverless Revisions within a Google Cloud Platform project.
| DeleteRevision | |
|---|---|
|
Rpc to delete a revision. |
|
| GetRevision | |
|---|---|
|
Rpc to get information about a revision. |
|
| ListRevisions | |
|---|---|
|
Rpc to list revisions. |
|
Routes
The Routes API allows you to manage Route resources within a Google Cloud Platform project.
| GetRoute | |
|---|---|
|
Rpc to get information about a route. |
|
| ListRoutes | |
|---|---|
|
Rpc to list routes. |
|
Services
The Services API allows you to manage serverless services within a Google Cloud Platform project.
| CreateService | |
|---|---|
|
Rpc to create a service. |
|
| DeleteService | |
|---|---|
|
Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. |
|
| GetIamPolicy | |
|---|---|
|
Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies. |
|
| GetService | |
|---|---|
|
Rpc to get information about a service. |
|
| ListServices | |
|---|---|
|
Rpc to list services. |
|
| ReplaceService | |
|---|---|
|
Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. |
|
| SetIamPolicy | |
|---|---|
|
Sets the IAM Access control policy for the specified Service. Overwrites any existing policy. |
|
| TestIamPermissions | |
|---|---|
|
Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. |
|
Addressable
Information for connecting over HTTP(s).
| Fields | |
|---|---|
hostname |
Deprecated - use url instead. |
url |
|
AuthorizedDomain
A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
| Fields | |
|---|---|
name |
Read only. Full path to the |
id |
Relative name of the domain authorized for use. Example: |
Capabilities
Adds and removes POSIX capabilities from running containers.
| Fields | |
|---|---|
add[] |
Added capabilities +optional |
drop[] |
Removed capabilities +optional |
CertificateMode
SSL management type. If AUTOMATIC or a type is omitted, a managed certificate is automatically provisioned. If None, the system will not provision a certificate.
| Enums | |
|---|---|
CERTIFICATE_MODE_UNSPECIFIED |
|
NONE |
Do not provision an HTTPS certificate. |
AUTOMATIC |
Automatically provisions an HTTPS certificate via GoogleCA or LetsEncrypt. |
ConfigMapEnvSource
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
| Fields | |
|---|---|
local_object_reference |
This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
optional |
Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the ConfigMap must be defined +optional |
name |
Cloud Run fully managed: not supported Cloud Run for Anthos: supported The ConfigMap to select from. |
ConfigMapKeySelector
Cloud Run fully managed: not supported
Cloud Run on GKE: supported
Selects a key from a ConfigMap.
| Fields | |
|---|---|
local_object_reference |
This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
key |
Cloud Run fully managed: not supported Cloud Run on GKE: supported The key to select. |
optional |
Cloud Run fully managed: not supported Cloud Run on GKE: supported Specify whether the ConfigMap or its key must be defined +optional |
name |
Cloud Run fully managed: not supported Cloud Run on GKE: supported The ConfigMap to select from. |
ConfigMapVolumeSource
Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths.
| Fields | |
|---|---|
name |
Name of the config. |
items[] |
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. |
default_mode |
Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
optional |
Specify whether the Secret or its keys must be defined. |
Configuration
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. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1alpha1". |
kind |
The kind of resource, in this case always "Configuration". |
metadata |
Metadata associated with this Configuration, including name, namespace, labels, and annotations. |
spec |
Spec holds the desired state of the Configuration (from the client). |
status |
Status communicates the observed state of the Configuration (from the controller). |
ConfigurationCondition
ConfigurationCondition defines a readiness condition for a Configuration.
| Fields | |
|---|---|
type |
ConfigurationConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include:"Ready" |
status |
Status of the condition, one of True, False, Unknown. |
reason |
One-word CamelCase reason for the condition's last transition. +optional |
message |
Human-readable message indicating details about last transition. +optional |
last_transition_time |
Last time the condition transitioned from one status to another. +optional |
severity |
How to interpret failures of this condition, one of Error, Warning, Info +optional |
ConfigurationSpec
ConfigurationSpec holds the desired state of the Configuration (from the client).
| Fields | |
|---|---|
revision_template |
RevisionTemplate holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn't otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. |
generation |
Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. |
template |
Template holds the latest specification for the Revision to be stamped out. |
ConfigurationStatus
ConfigurationStatus communicates the observed state of the Configuration (from the controller).
| Fields | |
|---|---|
latest_created_revision_name |
LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, for that use LatestReadyRevisionName. |
latest_ready_revision_name |
LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True". |
observed_generation |
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. |
conditions[] |
Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. |
Container
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.
| Fields | |
|---|---|
name |
Name of the container specified as a DNS_LABEL. Each container must have a unique name (DNS_LABEL). Cannot be updated. |
image |
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images |
command[] |
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional |
args[] |
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional |
env[] |
List of environment variables to set in the container. Cannot be updated. +optional |
resources |
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources +optional |
working_dir |
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional |
ports[] |
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +optional |
env_from[] |
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +optional |
volume_mounts[] |
Pod volumes to mount into the container's filesystem. Cannot be updated. +optional |
volume_devices[] |
volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future. +optional |
liveness_probe |
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional |
readiness_probe |
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional |
lifecycle |
Actions that the management system should take in response to container lifecycle events. Cannot be updated. +optional |
termination_message_path |
Optional: 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. Cannot be updated. +optional |
termination_message_policy |
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. +optional |
image_pull_policy |
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images +optional |
security_context |
Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ +optional |
stdin |
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional |
stdin_once |
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional |
tty |
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional |
ContainerPort
ContainerPort represents a network port in a single container.
| Fields | |
|---|---|
name |
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional |
host_port |
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional |
container_port |
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. |
protocol |
Protocol for port. Must be UDP or TCP. Defaults to "TCP". +optional |
host_i_p |
What host IP to bind the external port to. +optional |
CreateDomainMappingRequest
| Fields | |
|---|---|
parent |
The project ID or project number in which this domain mapping should be created. Authorization requires the following IAM permission on the specified resource
|
domain_mapping |
The domain mapping instance to create. |
CreateServiceRequest
Request message for creating a service.
| Fields | |
|---|---|
parent |
The project ID or project number in which this service should be created. Authorization requires the following IAM permission on the specified resource
|
service |
The service instance to create. |
DeleteDomainMappingRequest
Request message for deleting a domain mapping.
| Fields | |
|---|---|
name |
The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. Authorization requires the following IAM permission on the specified resource
|
orphan_dependents |
Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. |
propagation_policy |
Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. |
kind |
Cloud Run currently ignores this parameter. |
api_version |
Cloud Run currently ignores this parameter. |
DeleteRevisionRequest
Request message for deleting a revision.
| Fields | |
|---|---|
name |
The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. Authorization requires the following IAM permission on the specified resource
|
orphan_dependents |
Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. |
propagation_policy |
Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. |
kind |
Cloud Run currently ignores this parameter. |
api_version |
Cloud Run currently ignores this parameter. |
DeleteServiceRequest
Request message for deleting a service.
| Fields | |
|---|---|
name |
The name of the service being deleted. If needed, replace {namespace_id} with the project ID. Authorization requires the following IAM permission on the specified resource
|
orphan_dependents |
Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. |
propagation_policy |
Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. |
kind |
Cloud Run currently ignores this parameter. |
api_version |
Cloud Run currently ignores this parameter. |
DomainMapping
Resource to hold the state and status of a user's domain mapping.
| Fields | |
|---|---|
api_version |
The API version for this call such as "domains.cloudrun.com/v1alpha1". |
kind |
The kind of resource, in this case "DomainMapping". |
metadata |
Metadata associated with this BuildTemplate. |
spec |
The spec for this DomainMapping. |
status |
The current status of the DomainMapping. |
DomainMappingCondition
DomainMappingCondition contains state information for a DomainMapping.
| Fields | |
|---|---|
type |
Type of domain mapping condition. |
status |
Status of the condition, one of True, False, Unknown. |
reason |
One-word CamelCase reason for the condition's current status. +optional |
message |
Human readable message indicating details about the current status. +optional |
last_transition_time |
Last time the condition transitioned from one status to another. +optional |
severity |
How to interpret failures of this condition, one of Error, Warning, Info +optional |
DomainMappingSpec
The desired state of the Domain Mapping.
| Fields | |
|---|---|
route_name |
The name of the Knative Route that this DomainMapping applies to. The route must exist. |
certificate_mode |
The mode of the certificate. |
force_override |
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
The current state of the Domain Mapping.
| Fields | |
|---|---|
conditions[] |
Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. |
observed_generation |
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. |
resource_records[] |
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. |
mapped_route_name |
The name of the route that the mapping currently points to. |
url |
Cloud Run fully managed: not supported Cloud Run on GKE: supported Holds the URL that will serve the traffic of the DomainMapping. +optional |
EnvFromSource
EnvFromSource represents the source of a set of ConfigMaps
| Fields | |
|---|---|
prefix |
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. +optional |
config_map_ref |
The ConfigMap to select from +optional |
secret_ref |
The Secret to select from +optional |
EnvVar
EnvVar represents an environment variable present in a Container.
| Fields | |
|---|---|
name |
Name of the environment variable. Must be a C_IDENTIFIER. |
value |
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional |
value_from |
Cloud Run fully managed: not supported Cloud Run on GKE: supported Source for the environment variable's value. Cannot be used if value is not empty. +optional |
EnvVarSource
Cloud Run fully managed: not supported
Cloud Run on GKE: supported
EnvVarSource represents a source for the value of an EnvVar.
| Fields | |
|---|---|
config_map_key_ref |
Cloud Run fully managed: not supported Cloud Run on GKE: supported Selects a key of a ConfigMap. +optional |
secret_key_ref |
Cloud Run fully managed: not supported Cloud Run on GKE: supported Selects a key of a secret in the pod's namespace +optional |
ExecAction
ExecAction describes a "run in container" action.
| Fields | |
|---|---|
command |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional |
GetConfigurationRequest
Response message for retrieving a configuration.
| Fields | |
|---|---|
name |
The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. Authorization requires the following IAM permission on the specified resource
|
GetDomainMappingRequest
Response message for retrieving a domain mapping.
| Fields | |
|---|---|
name |
The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. Authorization requires the following IAM permission on the specified resource
|
GetRevisionRequest
Request message for retrieving a revision
| Fields | |
|---|---|
name |
The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. Authorization requires the following IAM permission on the specified resource
|
GetRouteRequest
Request message for retrieving a route.
| Fields | |
|---|---|
name |
The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. Authorization requires the following IAM permission on the specified resource
|
GetServiceRequest
Request message for retrieving a service.
| Fields | |
|---|---|
name |
The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. Authorization requires the following IAM permission on the specified resource
|
HTTPGetAction
HTTPGetAction describes an action based on HTTP Get requests.
| Fields | |
|---|---|
path |
Path to access on the HTTP server. +optional |
port |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
host |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional |
scheme |
Scheme to use for connecting to the host. Defaults to HTTP. +optional |
http_headers[] |
Custom headers to set in the request. HTTP allows repeated headers. +optional |
HTTPHeader
HTTPHeader describes a custom header to be used in HTTP probes
| Fields | |
|---|---|
name |
The header field name |
value |
The header field value |
Handler
Handler defines a specific action that should be taken
| Fields | |
|---|---|
exec |
One and only one of the following should be specified. Exec specifies the action to take. +optional |
http_get |
HTTPGet specifies the http request to perform. +optional |
tcp_socket |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
IntOrString
IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.
| Fields | |
|---|---|
type |
The type of the value. |
int_val |
The int value. |
str_val |
The string value. |
KeyToPath
Maps a string key to a path within a volume.
| Fields | |
|---|---|
key |
The key to project. |
path |
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 |
Mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional |
Lifecycle
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
| Fields | |
|---|---|
post_start |
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks +optional |
pre_stop |
PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks +optional |
ListAuthorizedDomainsRequest
Request message for listing authorized domains.
| Fields | |
|---|---|
parent |
Name of the parent Application resource. Example: |
page_size |
Maximum results to return per page. |
page_token |
Continuation token for fetching the next page of results. |
ListAuthorizedDomainsResponse
A list of Authorized Domains.
| Fields | |
|---|---|
domains[] |
The authorized domains belonging to the user. |
next_page_token |
Continuation token for fetching the next page of results. |
ListConfigurationsRequest
Request message for listing configurations.
| Fields | |
|---|---|
parent |
The project ID or project number from which the configurations should be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of records that should be returned. |
include_uninitialized |
Not currently used by Cloud Run. |
field_selector |
Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. |
watch |
Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. |
page_token |
Optional encoded string to continue paging. |
ListConfigurationsResponse
ListConfigurationsResponse is a list of Configuration resources.
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1alpha1". |
kind |
The kind of this resource, in this case "ConfigurationList". |
metadata |
Metadata associated with this Configuration list. |
items[] |
List of Configurations. |
unreachable[] |
Locations that could not be reached. |
ListDomainMappingsRequest
Request message for listing domain mappings.
| Fields | |
|---|---|
parent |
The project ID or project number from which the domain mappings should be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of records that should be returned. |
include_uninitialized |
Not currently used by Cloud Run. |
field_selector |
Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. |
watch |
Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. |
page_token |
Optional encoded string to continue paging. |
ListDomainMappingsResponse
ListDomainMappingsResponse is a list of DomainMapping resources.
| Fields | |
|---|---|
api_version |
The API version for this call such as "domains.cloudrun.com/v1alpha1". |
kind |
The kind of this resource, in this case "DomainMappingList". |
metadata |
Metadata associated with this DomainMapping list. |
items[] |
List of DomainMappings. |
unreachable[] |
Locations that could not be reached. |
ListMeta
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
| Fields | |
|---|---|
self_link |
SelfLink is a URL representing this object. Populated by the system. Read-only. +optional |
resource_version |
String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional |
continue |
continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. |
ListRevisionsRequest
Request message for listing revisions.
| Fields | |
|---|---|
parent |
The project ID or project number from which the revisions should be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of records that should be returned. |
include_uninitialized |
Not currently used by Cloud Run. |
field_selector |
Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. |
watch |
Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. |
page_token |
Optional encoded string to continue paging. |
ListRevisionsResponse
ListRevisionsResponse is a list of Revision resources.
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1alpha1". |
kind |
The kind of this resource, in this case "RevisionList". |
metadata |
Metadata associated with this revision list. |
items[] |
List of Revisions. |
unreachable[] |
Locations that could not be reached. |
ListRoutesRequest
Request message for listing routes.
| Fields | |
|---|---|
parent |
The project ID or project number from which the routes should be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of records that should be returned. |
include_uninitialized |
Not currently used by Cloud Run. |
field_selector |
Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. |
watch |
Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. |
page_token |
Optional encoded string to continue paging. |
ListRoutesResponse
ListRoutesResponse is a list of Route resources.
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1alpha1". |
kind |
The kind of this resource, in this case always "RouteList". |
metadata |
Metadata associated with this Route list. |
items[] |
List of Routes. |
unreachable[] |
Locations that could not be reached. |
ListServicesRequest
Request message for listing services.
| Fields | |
|---|---|
parent |
The project ID or project number from which the services should be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of records that should be returned. |
include_uninitialized |
Not currently used by Cloud Run. |
field_selector |
Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. |
watch |
Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. |
page_token |
Optional encoded string to continue paging. |
ListServicesResponse
A list of Service resources.
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1alpha1". |
kind |
The kind of this resource, in this case "ServiceList". |
metadata |
Metadata associated with this Service list. |
items[] |
List of Services. |
unreachable[] |
Locations that could not be reached. |
LocalObjectReference
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
| Fields | |
|---|---|
name |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
ObjectMeta
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
| Fields | |
|---|---|
name |
Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional |
generate_name |
Not currently supported by Cloud Run. GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency +optional string generateName = 2; |
namespace |
Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number. |
self_link |
SelfLink is a URL representing this object. Populated by the system. Read-only. +optional string selfLink = 4; |
uid |
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional |
resource_version |
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional |
generation |
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional |
create_time |
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional |
labels |
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. More info: http://kubernetes.io/docs/user-guide/labels +optional |
annotations |
Annotations is an 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. More info: http://kubernetes.io/docs/user-guide/annotations +optional |
owner_references[] |
List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. +optional |
delete_time |
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional |
deletion_grace_period_seconds |
Not currently supported by Cloud Run. Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional |
finalizers[] |
Not currently supported by Cloud Run. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +optional +patchStrategy=merge |
cluster_name |
Not currently supported by Cloud Run. The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional |
OwnerReference
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
| Fields | |
|---|---|
api_version |
API version of the referent. |
kind |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
uid |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
controller |
If true, this reference points to the managing controller. +optional |
block_owner_deletion |
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional |
Probe
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
| Fields | |
|---|---|
handler |
The action taken to determine the health of a container |
initial_delay_seconds |
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional |
timeout_seconds |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional |
period_seconds |
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional |
success_threshold |
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. +optional |
failure_threshold |
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional |
Quantity
The view model of a single quantity, e.g. "800 MiB". Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto
| Fields | |
|---|---|
string |
Stringified version of the quantity, e.g., "800 MiB". |
ReplaceServiceRequest
Request message for replacing a service.
| Fields | |
|---|---|
name |
The name of the service being replaced. If needed, replace {namespace_id} with the project ID. Authorization requires the following IAM permission on the specified resource
|
service |
The service object being replaced. |
ResourceRecord
A DNS resource record.
| Fields | |
|---|---|
name |
Relative name of the object affected by this record. Only applicable for |
rrdata |
Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). |
type |
Resource record type. Example: |
RecordType
A resource record type.
| Enums | |
|---|---|
RECORD_TYPE_UNSPECIFIED |
An unknown resource record. |
A |
An A resource record. Data is an IPv4 address. |
AAAA |
An AAAA resource record. Data is an IPv6 address. |
CNAME |
A CNAME resource record. Data is a domain name to be aliased. |
ResourceRequirements
ResourceRequirements describes the compute resource requirements.
| Fields | |
|---|---|
limits |
Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
requests |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go |
limits_in_map |
Limits describes the maximum amount of compute resources allowed. This is a temporary field created to migrate away from the map<string, Quantity> limits field. This is done to become compliant with k8s style API. This field is deprecated in favor of limits field. |
requests_in_map |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. This is a temporary field created to migrate away from the map<string, Quantity> requests field. This is done to become compliant with k8s style API. This field is deprecated in favor of requests field. |
Revision
Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration.
Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source.
See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1alpha1". |
kind |
The kind of this resource, in this case "Revision". |
metadata |
Metadata associated with this Revision, including name, namespace, labels, and annotations. |
spec |
Spec holds the desired state of the Revision (from the client). |
status |
Status communicates the observed state of the Revision (from the controller). |
RevisionCondition
RevisionCondition defines a readiness condition for a Revision.
| Fields | |
|---|---|
type |
RevisionConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include:
|
status |
Status of the condition, one of True, False, Unknown. |
reason |
One-word CamelCase reason for the condition's last transition. +optional |
message |
Human readable message indicating details about the current status. +optional |
last_transition_time |
Last time the condition transitioned from one status to another. +optional |
severity |
How to interpret failures of this condition, one of Error, Warning, Info +optional |
RevisionServingState
RevisionServingStateType is an enumeration of the levels of serving readiness of the Revision. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting
| Enums | |
|---|---|
REVISION_SERVING_STATE_UNSPECIFIED |
The revision serving state hasn't been specified. |
ACTIVE |
The revision is ready to serve traffic. |
RESERVE |
The revision is not currently serving traffic, but could be made to serve traffic quickly. Not currently used by Cloud Run. |
RETIRED |
The revision has been decommissioned and is not needed to serve traffic anymore. A Revision may be brought out of retirement, but it may take longer than it would from a "Reserve" state. |
RevisionSpec
RevisionSpec holds the desired state of the Revision (from the client).
| Fields | |
|---|---|
container |
Container defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of the fields of this Container, including: name, ports, and volumeMounts. The runtime contract is documented here: https://github.com/knative/serving/blob/master/docs/runtime-contract.md |
concurrency_model |
ConcurrencyModel specifies the desired concurrency model (Single or Multi) for the Revision. Defaults to Multi. Deprecated in favor of ContainerConcurrency. +optional |
container_concurrency |
(Optional) ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. Cloud Run fully managed: supported, defaults to 80 Cloud Run on GKE: supported, defaults to 0, which means concurrency to the application is not limited, and the system decides the target concurrency for the autoscaler. |
timeout_seconds |
TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Not currently used by Cloud Run. |
serving_state |
ServingState holds a value describing the state the resources are in for this Revision. Users must not specify this when creating a revision. It is expected that the system will manipulate this based on routability and load. Populated by the system. Read-only. |
generation |
Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. |
service_account_name |
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. |
containers[] |
Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided. |
volumes[] |
|
RevisionStatus
RevisionStatus communicates the observed state of the Revision (from the controller).
| Fields | |
|---|---|
log_url |
Specifies the generated logging url for this particular revision based on the revision url template specified in the controller's config. +optional |
conditions[] |
Conditions communicates 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 "ResourcesAvailable", "ContainerHealthy", and "Active", which contribute to the overall "Ready" condition. |
service_name |
Not currently used by Cloud Run. |
observed_generation |
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. |
image_digest |
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. |
RevisionTemplate
RevisionTemplateSpec describes the data a revision should have when created from a template. Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190
| Fields | |
|---|---|
metadata |
Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. To set minimum instances for this revision, use the "autoscaling.knative.dev/minScale" annotation key. (Cloud Run on GKE only). To set maximum instances for this revision, use the "autoscaling.knative.dev/maxScale" annotation key. To set Cloud SQL connections for the revision, use the "run.googleapis.com/cloudsql-instances" annotation key. Values should be comma separated. |
spec |
RevisionSpec holds the desired state of the Revision (from the client). |
Route
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. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route
Cloud Run currently supports referencing a single Configuration to automatically deploy the "latest ready" Revision from that Configuration.
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1alpha1". |
kind |
The kind of this resource, in this case always "Route". |
metadata |
Metadata associated with this Route, including name, namespace, labels, and annotations. |
spec |
Spec holds the desired state of the Route (from the client). |
status |
Status communicates the observed state of the Route (from the controller). |
RouteCondition
RouteCondition defines a readiness condition for a Route.
| Fields | |
|---|---|
type |
RouteConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: "Ready". |
status |
Status of the condition, one of "True", "False", "Unknown". |
reason |
One-word CamelCase reason for the condition's last transition. +optional |
message |
Human-readable message indicating details about last transition. +optional |
last_transition_time |
Last time the condition transitioned from one status to another. +optional |
severity |
How to interpret failures of this condition, one of Error, Warning, Info +optional |
RouteSpec
RouteSpec holds the desired state of the Route (from the client).
| Fields | |
|---|---|
traffic[] |
Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. Cloud Run currently supports a single configurationName. |
generation |
Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. |
RouteStatus
RouteStatus communicates the observed state of the Route (from the controller).
| Fields | |
|---|---|
domain |
Deprecated - use url instead. Domain holds the top-level domain that will distribute traffic over the provided targets. |
traffic[] |
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 we last observed. |
observed_generation |
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 only has a configurationName 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[] |
Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. |
domain_internal |
Deprecated - use address instead. For Cloud Run, identifical to domain. |
address |
Similar to url, information on where the service is available on HTTP. |
url |
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 |
SELinuxOptions
SELinuxOptions are the labels to be applied to the container
| Fields | |
|---|---|
user |
User is a SELinux user label that applies to the container. +optional |
role |
Role is a SELinux role label that applies to the container. +optional |
type |
Type is a SELinux type label that applies to the container. +optional |
level |
Level is SELinux level label that applies to the container. +optional |
SecretEnvSource
SecretEnvSource selects a Secret to populate the environment variables with.
The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
| Fields | |
|---|---|
local_object_reference |
This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
optional |
Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the Secret must be defined +optional |
name |
Cloud Run fully managed: not supported Cloud Run for Anthos: supported The Secret to select from. |
SecretKeySelector
Cloud Run fully managed: not supported
Cloud Run on GKE: supported
SecretKeySelector selects a key of a Secret.
| Fields | |
|---|---|
local_object_reference |
This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
key |
Cloud Run fully managed: not supported Cloud Run on GKE: supported The key of the secret to select from. Must be a valid secret key. |
optional |
Cloud Run fully managed: not supported Cloud Run on GKE: supported Specify whether the Secret or its key must be defined +optional |
name |
Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod's namespace to select from. |
SecretVolumeSource
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.
| Fields | |
|---|---|
secret_name |
Name of the secret in the container's namespace to use. |
items[] |
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. |
default_mode |
Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
optional |
Specify whether the Secret or its keys must be defined. |
SecurityContext
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
| Fields | |
|---|---|
capabilities |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. +optional |
privileged |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. +optional |
se_linux_options |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional |
run_as_user |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional |
run_as_group |
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional |
run_as_non_root |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional |
read_only_root_filesystem |
Whether this container has a read-only root filesystem. Default is false. +optional |
allow_privilege_escalation |
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN +optional |
Service
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.
See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1alpha1". |
kind |
The kind of resource, in this case "Service". |
metadata |
Metadata associated with this Service, including name, namespace, labels, and annotations. |
spec |
Spec holds the desired state of the Service (from the client). |
status |
Status communicates the observed state of the Service (from the controller). |
ServiceCondition
ServiceCondition defines a readiness condition for a Service.
| Fields | |
|---|---|
type |
ServiceConditionType is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types include: "Ready", "ConfigurationsReady", and "RoutesReady". "Ready" will be true when the underlying Route and Configuration are ready. |
status |
Status of the condition, one of True, False, Unknown. |
reason |
One-word CamelCase reason for the condition's last transition. +optional |
message |
Human-readable message indicating details about last transition. +optional |
last_transition_time |
Last time the condition transitioned from one status to another. +optional |
severity |
How to interpret failures of this condition, one of Error, Warning, Info +optional |
ServiceSpec
ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s).
| Fields | ||
|---|---|---|
generation |
Deprecated and not currently populated by Cloud Run. See metadata.generation instead, which is the sequence number containing the latest generation of the desired state. Read-only. |
|
traffic[] |
Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. |
|
template |
Template holds the latest specification for the Revision to be stamped out. |
|
Union field spec_type. Reference to one ServiceSpec type. spec_type can be only one of the following: |
||
run_latest |
RunLatest defines a simple Service. It will automatically configure a route that keeps the latest ready revision from the supplied configuration running. +optional |
|
pinned |
Pins this service to a specific revision name. The revision must be owned by the configuration provided. Deprecated and not supported by Cloud Run. +optional |
|
release |
Release enables gradual promotion of new revisions by allowing traffic to be split between two revisions. This type replaces the deprecated Pinned type. Not currently supported by Cloud Run. |
|
manual |
Manual contains the options for configuring a manual service. See ServiceSpec for more details. Not currently supported by Cloud Run. |
|
ServiceSpecManualType
ServiceSpecManualType contains the options for configuring a manual service. See ServiceSpec for more details.
Not currently supported by Cloud Run.
ServiceSpecPinnedType
ServiceSpecPinnedType Pins this service to a specific revision name. The revision must be owned by the configuration provided.
Deprecated and not supported by Cloud Run.
| Fields | |
|---|---|
revision_name |
The revision name to pin this service to until changed to a different service type. |
configuration |
The configuration for this service. |
ServiceSpecReleaseType
ServiceSpecReleaseType contains the options for slowly releasing revisions. See ServiceSpec for more details.
Not currently supported by Cloud Run.
| Fields | |
|---|---|
revisions[] |
Revisions is an ordered list of 1 or 2 revisions. The first is the current revision, and the second is the candidate revision. If a single revision is provided, traffic will be pinned at that revision. "@latest" is a shortcut for usage that refers to the latest created revision by the configuration. |
rollout_percent |
RolloutPercent is the percent of traffic that should be sent to the candidate revision, i.e. the 2nd revision in the revisions list. Valid values are between 0 and 99 inclusive. |
configuration |
The configuration for this service. All revisions from this service must come from a single configuration. |
ServiceSpecRunLatest
ServiceSpecRunLatest contains the options for always having a route to the latest configuration. See ServiceSpec for more details.
| Fields | |
|---|---|
configuration |
The configuration for this service. |
ServiceStatus
The current state of the Service. Output only.
| Fields | |
|---|---|
conditions[] |
Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. |
domain |
From RouteStatus. Domain holds the top-level domain that will distribute traffic over the provided targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app |
address |
From RouteStatus. Similar to url, information on where the service is available on HTTP. |
url |
From RouteStatus. 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 |
observed_generation |
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. |
traffic[] |
From RouteStatus. 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 we last observed. |
latest_ready_revision_name |
From ConfigurationStatus. LatestReadyRevisionName holds the name of the latest Revision stamped out from this Service's Configuration that has had its "Ready" condition become "True". |
latest_created_revision_name |
From ConfigurationStatus. LatestCreatedRevisionName is the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName. |
TCPSocketAction
TCPSocketAction describes an action based on opening a socket
| Fields | |
|---|---|
port |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
host |
Optional: Host name to connect to, defaults to the pod IP. +optional |
TrafficTarget
TrafficTarget holds a single entry of the routing table for a Route.
| Fields | |
|---|---|
configuration_name |
ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, we will automatically migrate traffic from the prior "latest ready" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName. |
revision_name |
RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName. Providing RevisionName in spec is not currently supported by Cloud Run. |
name |
Name is optionally used to expose a dedicated hostname for referencing this target exclusively. Not currently supported by Cloud Run. +optional |
percent |
Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified. Cloud Run currently requires 100 percent for a single ConfigurationName TrafficTarget entry. |
tag |
Tag is optionally used to expose a dedicated url for referencing this target exclusively. Not currently supported in Cloud Run. +optional |
latest_revision |
LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty. +optional |
url |
Output only. URL displays the URL for accessing named traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc. Not currently supported in Cloud Run. |
Volume
Volume represents a named volume in a container.
| Fields | |
|---|---|
name |
Volume's name. |
secret |
|
config_map |
|
VolumeDevice
volumeDevice describes a mapping of a raw block device within a container.
| Fields | |
|---|---|
name |
name must match the name of a persistentVolumeClaim in the pod |
device_path |
devicePath is the path inside of the container that the device will be mapped to. |
VolumeMount
VolumeMount describes a mounting of a Volume within a container.
| Fields | |
|---|---|
name |
This must match the Name of a Volume. |
read_only |
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional |
mount_path |
Path within the container at which the volume should be mounted. Must not contain ':'. |
sub_path |
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional |
mount_propagation |
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationHostToContainer is used. This field is beta in 1.10. +optional |