Skip to content

API Reference

Packages

inference.networking.x-k8s.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the inference.networking.x-k8s.io API group.

Resource Types

ClusterName

Underlying type: string

ClusterName is the name of a cluster that exported the InferencePool.

Validation: - MaxLength: 253 - MinLength: 1

Appears in: - ExportingCluster

ControllerName

Underlying type: string

ControllerName is the name of a controller that manages a resource. It must be a domain prefixed path.

Valid values include:

  • "example.com/bar"

Invalid values include:

  • "example.com" - must include path
  • "foo.example.com" - must include path

Validation: - MaxLength: 253 - MinLength: 1 - Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$

Appears in: - ImportController

ExportingCluster

ExportingCluster defines a cluster that exported the InferencePool that backs this InferencePoolImport.

Appears in: - ImportController

Field Description Default Validation
name ClusterName Name of the exporting cluster (must be unique within the list). MaxLength: 253
MinLength: 1
Required: {}

ImportController

ImportController defines a controller that is responsible for managing the InferencePoolImport.

Appears in: - InferencePoolImportStatus

Field Description Default Validation
name ControllerName Name is a domain/path string that indicates the name of the controller that manages the
InferencePoolImport. Name corresponds to the GatewayClass controllerName field when the
controller will manage parents of type "Gateway". Otherwise, the name is implementation-specific.
Example: "example.net/import-controller".
The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes
names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
A controller MUST populate this field when writing status and ensure that entries to status
populated with their controller name are removed when they are no longer necessary.
MaxLength: 253
MinLength: 1
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$
exportingClusters ExportingCluster array ExportingClusters is a list of clusters that exported the InferencePool(s) that back the
InferencePoolImport. Required when the controller is responsible for CRUD'ing the InferencePoolImport
from the exported InferencePool(s).
parents ParentStatus array Parents is a list of parent resources, typically Gateways, that are associated with the
InferencePoolImport, and the status of the InferencePoolImport with respect to each parent.
Ancestor would be a more accurate name, but Parent is consistent with InferencePool terminology.
Required when the controller manages the InferencePoolImport as an HTTPRoute backendRef. The controller
must add an entry for each parent it manages and remove the parent entry when the controller no longer
considers the InferencePoolImport to be associated with that parent.
conditions Condition array Conditions track the state of the InferencePoolImport.
Known condition types are:
* "Accepted"
MaxItems: 8

InferencePoolImport

InferencePoolImport is the Schema for the InferencePoolImports API.

Field Description Default Validation
apiVersion string inference.networking.x-k8s.io/v1alpha1
kind string InferencePoolImport
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
status InferencePoolImportStatus Status defines the observed state of the InferencePoolImport.

InferencePoolImportStatus

InferencePoolImportStatus defines the observed state of the InferencePoolImport.

Appears in: - InferencePoolImport

Field Description Default Validation
controllers ImportController array Controllers is a list of controllers that are responsible for managing the InferencePoolImport. MaxItems: 8
Required: {}