API Reference¶
Packages¶
llamastack.io/v1alpha1¶
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group
Resource Types¶
ContainerSpec¶
ContainerSpec defines the llama-stack server container configuration.
Appears in: - ServerSpec
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
llama-stack | ||
port integer |
|||
resources ResourceRequirements |
|||
env EnvVar array |
|||
command string array |
|||
args string array |
DistributionConfig¶
DistributionConfig represents the configuration information from the providers endpoint.
Appears in: - LlamaStackDistributionStatus
| Field | Description | Default | Validation |
|---|---|---|---|
activeDistribution string |
ActiveDistribution shows which distribution is currently being used | ||
providers ProviderInfo array |
|||
availableDistributions object (keys:string, values:string) |
AvailableDistributions lists all available distributions and their images |
DistributionPhase¶
Underlying type: string
LlamaStackDistributionPhase represents the current phase of the LlamaStackDistribution
Validation: - Enum: [Pending Initializing Ready Failed Terminating]
Appears in: - LlamaStackDistributionStatus
| Field | Description |
|---|---|
Pending |
LlamaStackDistributionPhasePending indicates that the distribution is pending initialization |
Initializing |
LlamaStackDistributionPhaseInitializing indicates that the distribution is being initialized |
Ready |
LlamaStackDistributionPhaseReady indicates that the distribution is ready to use |
Failed |
LlamaStackDistributionPhaseFailed indicates that the distribution has failed |
Terminating |
LlamaStackDistributionPhaseTerminating indicates that the distribution is being terminated |
DistributionType¶
DistributionType defines the distribution configuration for llama-stack.
Appears in: - ServerSpec
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name is the distribution name that maps to supported distributions. | ||
image string |
Image is the direct container image reference to use |
LlamaStackDistribution¶
Appears in: - LlamaStackDistributionList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
llamastack.io/v1alpha1 |
||
kind string |
LlamaStackDistribution |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec LlamaStackDistributionSpec |
|||
status LlamaStackDistributionStatus |
LlamaStackDistributionList¶
LlamaStackDistributionList contains a list of LlamaStackDistribution.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
llamastack.io/v1alpha1 |
||
kind string |
LlamaStackDistributionList |
||
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
||
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items LlamaStackDistribution array |
LlamaStackDistributionSpec¶
LlamaStackDistributionSpec defines the desired state of LlamaStackDistribution.
Appears in: - LlamaStackDistribution
| Field | Description | Default | Validation |
|---|---|---|---|
replicas integer |
1 | ||
server ServerSpec |
LlamaStackDistributionStatus¶
LlamaStackDistributionStatus defines the observed state of LlamaStackDistribution.
Appears in: - LlamaStackDistribution
| Field | Description | Default | Validation |
|---|---|---|---|
phase DistributionPhase |
Phase represents the current phase of the distribution | Enum: [Pending Initializing Ready Failed Terminating] |
|
version VersionInfo |
Version contains version information for both operator and deployment | ||
distributionConfig DistributionConfig |
DistributionConfig contains the configuration information from the providers endpoint | ||
conditions Condition array |
Conditions represent the latest available observations of the distribution's current state | ||
availableReplicas integer |
AvailableReplicas is the number of available replicas |
PodOverrides¶
PodOverrides allows advanced pod-level customization.
Appears in: - ServerSpec
| Field | Description | Default | Validation |
|---|---|---|---|
serviceAccountName string |
ServiceAccountName allows users to specify their own ServiceAccount If not specified, the operator will use the default ServiceAccount |
||
volumes Volume array |
|||
volumeMounts VolumeMount array |
ProviderHealthStatus¶
HealthStatus represents the health status of a provider
Appears in: - ProviderInfo
| Field | Description | Default | Validation |
|---|---|---|---|
status string |
|||
message string |
ProviderInfo¶
ProviderInfo represents a single provider from the providers endpoint.
Appears in: - DistributionConfig
| Field | Description | Default | Validation |
|---|---|---|---|
api string |
|||
provider_id string |
|||
provider_type string |
|||
config JSON |
|||
health ProviderHealthStatus |
ServerSpec¶
ServerSpec defines the desired state of llama server.
Appears in: - LlamaStackDistributionSpec
| Field | Description | Default | Validation |
|---|---|---|---|
distribution DistributionType |
|||
containerSpec ContainerSpec |
|||
podOverrides PodOverrides |
|||
storage StorageSpec |
Storage defines the persistent storage configuration | ||
userConfig UserConfigSpec |
UserConfig defines the user configuration for the llama-stack server |
StorageSpec¶
StorageSpec defines the persistent storage configuration
Appears in: - ServerSpec
| Field | Description | Default | Validation |
|---|---|---|---|
size Quantity |
Size is the size of the persistent volume claim created for holding persistent data of the llama-stack server | ||
mountPath string |
MountPath is the path where the storage will be mounted in the container |
UserConfigSpec¶
Appears in: - ServerSpec
| Field | Description | Default | Validation |
|---|---|---|---|
configMapName string |
ConfigMapName is the name of the ConfigMap containing user configuration | ||
configMapNamespace string |
ConfigMapNamespace is the namespace of the ConfigMap (defaults to the same namespace as the CR) |
VersionInfo¶
VersionInfo contains version-related information
Appears in: - LlamaStackDistributionStatus
| Field | Description | Default | Validation |
|---|---|---|---|
operatorVersion string |
OperatorVersion is the version of the operator managing this distribution | ||
llamaStackServerVersion string |
DeploymentVersion is the version of the LlamaStack deployment | ||
lastUpdated Time |
LastUpdated represents when the version information was last updated |