API Reference¶
Packages¶
litellm.litellm.ai/v1alpha1¶
Package v1alpha1 contains API Schema definitions for the litellm v1alpha1 API group.
Resource Types¶
DatabaseSecretKeys¶
Appears in: - DatabaseSecretRef
| Field | Description | Default | Validation |
|---|---|---|---|
hostSecret string |
|||
passwordSecret string |
|||
usernameSecret string |
|||
dbnameSecret string |
DatabaseSecretRef¶
Appears in: - LiteLLMInstanceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
nameRef string |
|||
keys DatabaseSecretKeys |
Gateway¶
Appears in: - LiteLLMInstanceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
host string |
Ingress¶
Appears in: - LiteLLMInstanceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean |
|||
host string |
LiteLLMInstance¶
LiteLLMInstance is the Schema for the litellminstances API.
Appears in: - LiteLLMInstanceList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
litellm.litellm.ai/v1alpha1 |
||
kind string |
LiteLLMInstance |
||
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 LiteLLMInstanceSpec |
|||
status LiteLLMInstanceStatus |
LiteLLMInstanceList¶
LiteLLMInstanceList contains a list of LiteLLMInstance.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
litellm.litellm.ai/v1alpha1 |
||
kind string |
LiteLLMInstanceList |
||
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 LiteLLMInstance array |
LiteLLMInstanceSpec¶
LiteLLMInstanceSpec defines the desired state of LiteLLMInstance.
Appears in: - LiteLLMInstance
| Field | Description | Default | Validation |
|---|---|---|---|
image string |
ghcr.io/berriai/litellm-database:main-v1.74.9.rc.1 | ||
masterKey string |
|||
databaseSecretRef DatabaseSecretRef |
|||
redisSecretRef RedisSecretRef |
|||
ingress Ingress |
|||
gateway Gateway |
|||
replicas integer |
Number of replicas for the LiteLLM deployment | 1 |
LiteLLMInstanceStatus¶
LiteLLMInstanceStatus defines the observed state of LiteLLMInstance.
Appears in: - LiteLLMInstance
| Field | Description | Default | Validation |
|---|---|---|---|
observedGeneration integer |
ObservedGeneration represents the .metadata.generation that the condition was set based upon | ||
lastUpdated Time |
LastUpdated represents the last time the status was updated | ||
configMapCreated boolean |
Resource creation status | ||
secretCreated boolean |
|||
deploymentCreated boolean |
|||
serviceCreated boolean |
|||
ingressCreated boolean |
|||
conditions Condition array |
Conditions represent the latest available observations of a LiteLLM instance's state |
RedisSecretKeys¶
Appears in: - RedisSecretRef
| Field | Description | Default | Validation |
|---|---|---|---|
hostSecret string |
|||
portSecret string |
|||
passwordSecret string |
RedisSecretRef¶
Appears in: - LiteLLMInstanceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
nameRef string |
|||
keys RedisSecretKeys |