API Reference
Packages
authorization.beamlit.com/v1alpha1
Package v1alpha1 contains API Schema definitions for the model v1alpha1 API group
Resource Types
Policy
Policy is the Schema for the policies API
Appears in: - PolicyList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
authorization.beamlit.com/v1alpha1 |
||
kind string |
Policy |
||
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 PolicySpec |
|||
status PolicyStatus |
PolicyFlavor
Appears in: - PolicySpec
| Field | Description | Default | Validation |
|---|---|---|---|
type string |
Type is the type of the flavor | Required: {} |
|
name string |
Name is the name of the flavor | Required: {} |
PolicyList
PolicyList contains a list of Policy
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
authorization.beamlit.com/v1alpha1 |
||
kind string |
PolicyList |
||
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 Policy array |
PolicyLocation
Appears in: - PolicySpec
| Field | Description | Default | Validation |
|---|---|---|---|
type PolicySubTypeLocation |
Type is the type of the location | Required: {} |
|
name string |
Name is the name of the location | Required: {} |
PolicySpec
PolicySpec defines the desired state of Policy on Beamlit
Appears in: - Policy
| Field | Description | Default | Validation |
|---|---|---|---|
displayName string |
DisplayName is the display name of the policy | Optional: {} |
|
type PolicyType |
Type is the type of the policy | Enum: [location flavor] Required: {} |
|
locations PolicyLocation array |
|||
flavors PolicyFlavor array |
Flavors is the list of flavors allowed by the policy If not set, all flavors are allowed |
Optional: {} |
PolicyStatus
PolicyStatus defines the observed state of Policy
Appears in: - Policy
| Field | Description | Default | Validation |
|---|---|---|---|
createdAtOnBeamlit Time |
CreatedAtOnBeamlit is the time when the policy was created on Beamlit | ||
updatedAtOnBeamlit Time |
UpdatedAtOnBeamlit is the time when the policy was updated on Beamlit | ||
workspace string |
Workspace is the workspace of the policy |
PolicySubTypeLocation
Underlying type: string
Appears in: - PolicyLocation
| Field | Description |
|---|---|
location |
|
country |
|
continent |
PolicyType
Underlying type: string
Appears in: - PolicySpec
| Field | Description |
|---|---|
location |
|
flavor |
deployment.beamlit.com/v1alpha1
Package v1alpha1 contains API Schema definitions for the model v1alpha1 API group
Resource Types
AuthConfig
Appears in: - RemoteBackend
| Field | Description | Default | Validation |
|---|---|---|---|
type AuthType |
Type is the type of the authentication | Enum: [oauth] Required: {} |
|
oauthConfig OAuthConfig |
OAuthConfig is the OAuth configuration for the remote backend | Optional: {} |
AuthType
Underlying type: string
Appears in: - AuthConfig
| Field | Description |
|---|---|
oauth |
ModelDeployment
ModelDeployment is the Schema for the modeldeployments API
Appears in: - ModelDeploymentList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
deployment.beamlit.com/v1alpha1 |
||
kind string |
ModelDeployment |
||
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 ModelDeploymentSpec |
|||
status ModelDeploymentStatus |
ModelDeploymentList
ModelDeploymentList contains a list of ModelDeployment
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
deployment.beamlit.com/v1alpha1 |
||
kind string |
ModelDeploymentList |
||
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 ModelDeployment array |
ModelDeploymentSpec
ModelDeploymentSpec defines the desired state of ModelDeployment
Appears in: - ModelDeployment
| Field | Description | Default | Validation |
|---|---|---|---|
model string |
Model is the name of the base model | Required: {} |
|
enabled boolean |
Enabled is the flag to enable the model deployment on Beamlit | true | Optional: {} |
modelSourceRef ObjectReference |
ModelSourceRef is the reference to the model source This is either a Deployment, StatefulSet... (anything that is a template for a pod) |
Required: {} |
|
serviceRef ServiceReference |
ServiceRef is the reference to the service exposing the model inside the cluster If not specified, a local service will be created |
Optional: {} |
|
metricServiceRef ServiceReference |
MetricServiceRef is the reference to the service exposing the metrics inside the cluster If not specified, the model deployment will not be offloaded |
Optional: {} |
|
environment string |
Environment is the environment attached to the model deployment If not specified, the model deployment will be deployed in the "prod" environment |
production | Optional: {} |
policies PolicyRef array |
Policies is the list of policies to apply to the model deployment | { } | Optional: {} |
serverlessConfig ServerlessConfig |
ServerlessConfig is the serverless configuration for the model deployment If not specified, the model deployment will be deployed with a default serverless configuration |
Optional: {} |
|
offloadingConfig OffloadingConfig |
OffloadingConfig is the offloading configuration for the model deployment If not specified, the model deployment will not be offloaded |
Optional: {} |
ModelDeploymentStatus
ModelDeploymentStatus defines the observed state of ModelDeployment
Appears in: - ModelDeployment
| Field | Description | Default | Validation |
|---|---|---|---|
offloadingStatus boolean |
OffloadingStatus is the status of the offloading True if the model deployment is offloaded |
||
servingPort integer |
ServingPort is the port inside the pod that the model is served on | ||
metricPort integer |
MetricPort is the port inside the pod that the metrics are exposed on | ||
workspace string |
Workspace is the workspace of the model deployment | ||
createdAtOnBeamlit Time |
CreatedAtOnBeamlit is the time when the model deployment was created on Beamlit | ||
updatedAtOnBeamlit Time |
UpdatedAtOnBeamlit is the time when the model deployment was updated on Beamlit |
OAuthConfig
Appears in: - AuthConfig
| Field | Description | Default | Validation |
|---|---|---|---|
clientId string |
ClientID is the client ID for the OAuth configuration | Required: {} |
|
clientSecret string |
ClientSecret is the client secret for the OAuth configuration | Required: {} |
|
tokenUrl string |
TokenURL is the token URL for the OAuth configuration | Required: {} |
OffloadingBehavior
Appears in: - OffloadingConfig
| Field | Description | Default | Validation |
|---|---|---|---|
percentage integer |
Percentage is the percentage of the requests that will be offloaded | 100 | Maximum: 100 Minimum: 0 Optional: {} |
OffloadingConfig
Appears in: - ModelDeploymentSpec
| Field | Description | Default | Validation |
|---|---|---|---|
remoteBackend RemoteBackend |
RemoteBackend is the reference to the remote backend By default, the model deployment will be offloaded to the default backend |
Optional: {} |
|
metrics MetricSpec array |
Metrics is the list of metrics used for offloading | { } | Optional: {} |
behavior OffloadingBehavior |
Behavior is the behavior of the offloading | { } | Optional: {} |
PolicyRef
PolicyRef is the reference to a policy
Appears in: - ModelDeploymentSpec
| Field | Description | Default | Validation |
|---|---|---|---|
refType PolicyRefType |
RefType is the type of the policy reference | remotePolicy | Enum: [remotePolicy localPolicy] Required: {} |
name string |
Name is the name of the policy | Optional: {} |
PolicyRefType
Underlying type: string
Appears in: - PolicyRef
| Field | Description |
|---|---|
remotePolicy |
|
localPolicy |
RemoteBackend
Appears in: - OffloadingConfig
| Field | Description | Default | Validation |
|---|---|---|---|
host string |
Host is the host of the remote backend | Required: {} |
|
authConfig AuthConfig |
AuthConfig is the authentication configuration for the remote backend | Optional: {} |
|
pathPrefix string |
PathPrefix is the path prefix for the remote backend | ||
headersToAdd object (keys:string, values:string) |
HeadersToAdd is the list of headers to add to the requests | Optional: {} |
|
scheme SupportedScheme |
Scheme is the scheme for the remote backend | http | Enum: [http https] Optional: {} |
ServerlessConfig
Appears in: - ModelDeploymentSpec
| Field | Description | Default | Validation |
|---|---|---|---|
minNumReplicas integer |
MinNumReplicas is the minimum number of replicas | 0 | Minimum: 0 Optional: {} |
maxNumReplicas integer |
MaxNumReplicas is the maximum number of replicas | 10 | Minimum: 0 Optional: {} |
metric string |
Metric is the metric used for scaling | Optional: {} |
|
target string |
Target is the target value for the metric | Optional: {} |
|
scaleUpMinimum integer |
ScaleUpMinimum is the minimum number of replicas to scale up | Minimum: 2 Optional: {} |
|
scaleDownDelay string |
ScaleDownDelay is the delay between scaling down | Optional: {} |
|
stableWindow string |
StableWindow is the window of time to consider the number of replicas stable | Optional: {} |
|
lastPodRetentionPeriod string |
LastPodRetentionPeriod is the retention period for the last pod | Optional: {} |
ServiceReference
Appears in: - ModelDeploymentSpec
| Field | Description | Default | Validation |
|---|---|---|---|
targetPort integer |
SupportedScheme
Underlying type: string
Appears in: - RemoteBackend
| Field | Description |
|---|---|
http |
|
https |
ToolDeployment
ToolDeployment is the Schema for the tooldeployments API
Appears in: - ToolDeploymentList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
deployment.beamlit.com/v1alpha1 |
||
kind string |
ToolDeployment |
||
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 ToolDeploymentSpec |
|||
status ToolDeploymentStatus |
ToolDeploymentList
ToolDeploymentList contains a list of ToolDeployment
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
deployment.beamlit.com/v1alpha1 |
||
kind string |
ToolDeploymentList |
||
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 ToolDeployment array |
ToolDeploymentSpec
ToolDeploymentSpec defines the desired state of ToolDeployment
Appears in: - ToolDeployment
| Field | Description | Default | Validation |
|---|---|---|---|
foo string |
Foo is an example field of ToolDeployment. Edit tooldeployment_types.go to remove/update |
ToolDeploymentStatus
ToolDeploymentStatus defines the observed state of ToolDeployment
Appears in: - ToolDeployment