Specification of a container for serving predictions. Some fields in this message correspond to fields in the Kubernetes Container v1 core specification.
JSON representation |
---|
{ "imageUri": string, "command": [ string ], "args": [ string ], "env": [ { object ( |
Fields | |
---|---|
imageUri |
Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the container publishing requirements, including permissions requirements for the Vertex AI service Agent. The container image is ingested upon To learn about the requirements for the Docker image itself, see Custom container requirements. You can use the URI to one of Vertex AI's pre-built container images for prediction in this field. |
command[] |
Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a Docker If you do not specify this field, then the container's If you specify this field, then you can also specify the In this field, you can reference environment variables set by Vertex AI and environment variables set in the
Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with
This field corresponds to the |
args[] |
Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's If you don't specify this field but do specify the If you don't specify this field and don't specify the In this field, you can reference environment variables set by Vertex AI and environment variables set in the
Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with
This field corresponds to the |
env[] |
Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the
If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the |
ports[] |
Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, it defaults to following value:
Vertex AI does not use ports other than the first one listed. This field corresponds to the |
predictRoute |
Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using For example, if you set this field to If you don't specify this field, it defaults to the following value when you
The placeholders in this value are replaced as follows:
|
healthRoute |
Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about health checks. For example, if you set this field to If you don't specify this field, it defaults to the following value when you
The placeholders in this value are replaced as follows:
|
grpcPorts[] |
Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the |
deploymentTimeout |
Immutable. Deployment timeout. Limit for deployment timeout is 2 hours. A duration in seconds with up to nine fractional digits, ending with ' |
sharedMemorySizeMb |
Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes. |
startupProbe |
Immutable. Specification for Kubernetes startup probe. |
healthProbe |
Immutable. Specification for Kubernetes readiness probe. |
Port
Represents a network port in a container.
JSON representation |
---|
{ "containerPort": integer } |
Fields | |
---|---|
containerPort |
The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive. |
Probe
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
JSON representation |
---|
{ "periodSeconds": integer, "timeoutSeconds": integer, // Union field |
Fields | |
---|---|
periodSeconds |
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeoutSeconds. Maps to Kubernetes probe argument 'periodSeconds'. |
timeoutSeconds |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to periodSeconds. Maps to Kubernetes probe argument 'timeoutSeconds'. |
Union field
|
|
exec |
ExecAction probes the health of a container by executing a command. |
ExecAction
ExecAction specifies a command to execute.
JSON representation |
---|
{ "command": [ string ] } |
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. |