Struct ModelContainerSpec

#[non_exhaustive]
pub struct ModelContainerSpec {

    pub image_uri: String,
    pub command: Vec<String>,
    pub args: Vec<String>,
    pub env: Vec<EnvVar>,
    pub ports: Vec<Port>,
    pub predict_route: String,
    pub health_route: String,
    pub grpc_ports: Vec<Port>,
    pub deployment_timeout: Option<Duration>,
    pub shared_memory_size_mb: i64,
    pub startup_probe: Option<Probe>,
    pub health_probe: Option<Probe>,
    pub liveness_probe: Option<Probe>,
    /* private fields */
}

Specification of a container for serving predictions. Some fields in this message correspond to fields in the Kubernetes Container v1 core specification.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

image_uri: String

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 ModelService.UploadModel, stored internally, and this original path is afterwards not used.

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: Vec<String>

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 ENTRYPOINT’s “exec” form, not its “shell” form.

If you do not specify this field, then the container’s ENTRYPOINT runs, in conjunction with the args field or the container’s CMD, if either exists. If this field is not specified and the container does not have an ENTRYPOINT, then refer to the Docker documentation about how CMD and ENTRYPOINT interact.

If you specify this field, then you can also specify the args field to provide additional arguments for this command. However, if you specify this field, then the container’s CMD is ignored. See the Kubernetes documentation about how the command and args fields interact with a container’s ENTRYPOINT and CMD.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> 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 $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the command field of the Kubernetes Containers v1 core API.

args: Vec<String>

Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container’s CMD. Specify this field as an array of executable and arguments, similar to a Docker CMD’s “default parameters” form.

If you don’t specify this field but do specify the command field, then the command from the command field runs without any additional arguments. See the Kubernetes documentation about how the command and args fields interact with a container’s ENTRYPOINT and CMD.

If you don’t specify this field and don’t specify the command field, then the container’s ENTRYPOINT and CMD determine what runs based on their default behavior. See the Docker documentation about how CMD and ENTRYPOINT interact.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> 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 $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the args field of the Kubernetes Containers v1 core API.

env: Vec<EnvVar>

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 command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2 to have the value foo bar:

[
  {
    "name": "VAR_1",
    "value": "foo"
  },
  {
    "name": "VAR_2",
    "value": "$(VAR_1) bar"
  }
]

If you switch the order of the variables in the example, then the expansion does not occur.

This field corresponds to the env field of the Kubernetes Containers v1 core API.

ports: Vec<Port>

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:

[
  {
    "containerPort": 8080
  }
]

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports field of the Kubernetes Containers v1 core API.

predict_route: String

Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container’s IP address and port. Vertex AI then returns the container’s response in the API response.

For example, if you set this field to /foo, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the /foo path on the port of your container specified by the first value of this ModelContainerSpec’s ports field.

If you don’t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code> The placeholders in this value are replaced as follows:

• <var>ENDPOINT</var>: The last segment (following endpoints/)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the AIP_ENDPOINT_ID environment variable.)

• <var>DEPLOYED_MODEL</var>: DeployedModel.id of the DeployedModel. (Vertex AI makes this value available to your container code as the AIP_DEPLOYED_MODEL_ID environment variable.)

health_route: String

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 /bar, then Vertex AI intermittently sends a GET request to the /bar path on the port of your container specified by the first value of this ModelContainerSpec’s ports field.

If you don’t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code> The placeholders in this value are replaced as follows:

• <var>ENDPOINT</var>: The last segment (following endpoints/)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the AIP_ENDPOINT_ID environment variable.)

• <var>DEPLOYED_MODEL</var>: DeployedModel.id of the DeployedModel. (Vertex AI makes this value available to your container code as the AIP_DEPLOYED_MODEL_ID environment variable.)

grpc_ports: Vec<Port>

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 ports field of the Kubernetes Containers v1 core API.

deployment_timeout: Option<Duration>

Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.

shared_memory_size_mb: i64

Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.

startup_probe: Option<Probe>

Immutable. Specification for Kubernetes startup probe.

health_probe: Option<Probe>

Immutable. Specification for Kubernetes readiness probe.

liveness_probe: Option<Probe>

Immutable. Specification for Kubernetes liveness probe.

Implementations

impl ModelContainerSpec

pub fn new() -> Self

pub fn set_image_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of image_uri.

pub fn set_command<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of command.

pub fn set_args<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of args.

pub fn set_env<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<EnvVar>,

Sets the value of env.

pub fn set_ports<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Port>,

Sets the value of ports.

pub fn set_predict_route<T: Into<String>>(self, v: T) -> Self

Sets the value of predict_route.

pub fn set_health_route<T: Into<String>>(self, v: T) -> Self

Sets the value of health_route.

pub fn set_grpc_ports<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Port>,

Sets the value of grpc_ports.

pub fn set_deployment_timeout<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of deployment_timeout.

pub fn set_shared_memory_size_mb<T: Into<i64>>(self, v: T) -> Self

Sets the value of shared_memory_size_mb.

pub fn set_startup_probe<T: Into<Option<Probe>>>(self, v: T) -> Self

Sets the value of startup_probe.

pub fn set_health_probe<T: Into<Option<Probe>>>(self, v: T) -> Self

Sets the value of health_probe.

pub fn set_liveness_probe<T: Into<Option<Probe>>>(self, v: T) -> Self

Sets the value of liveness_probe.

Trait Implementations

impl Clone for ModelContainerSpec

fn clone(&self) -> ModelContainerSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelContainerSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ModelContainerSpec

fn default() -> ModelContainerSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelContainerSpec

where ModelContainerSpec: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ModelContainerSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ModelContainerSpec

fn eq(&self, other: &ModelContainerSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ModelContainerSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelContainerSpec