API Reference
Packages
run.evroclabs.net/v1alpha2
Package v1alpha2 contains the API Schema definitions for the evroc run v1alpha2 API group. This includes the generated DeepCopy methods, and ConditionSet to help manage the run resource conditions.
Resource Types
ContainerSpec
ContainerSpec defines the desired state of a single container. Most of these are inherited from corev1.Container (https://pkg.go.dev/k8s.io/api/core/v1#Container).
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
image string | Image is the Container image name. More info: https://kubernetes.io/docs/concepts/containers/images. | ||
ports ContainerPort array | Ports are the list of ports to expose from the container. | ||
env EnvVar array | Env is the list of environment variables to set in the container. | ||
envFromSecret EnvFromSource array | List of Secrets to populate environment variables in the container. The keys defined within a source must be a must adhere to the regex [A-Za-z_][A-Za-z0-9_]*. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple Secrets, the value associated with the last Secret will take precedence. Values defined by an Env with a duplicate key will take precedence. | ||
resources ResourceRequirements | Compute Resources required by this container. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/. | ||
args string array | Args are the arguments to the entrypoint. The container image's CMD is used if this is not provided. |
LatencyAutoscalingSpec
LatencyAutoscalingSpec defines a desired autoscaling behaviour. This is done by defining the intended outcomes e.g. this is the desired request latency.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
maxLatency integer | MaxLatency is the request latency goal in milliseconds. The autoscaler will try to keep the median request latency at or below this value. |
Service
Service defines the schema for an evroc Service API object that will take a set of one or more images and serve them on evroc infrastructure at a defined latency goal.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | run.evroclabs.net/v1alpha2 | ||
kind string | Service | ||
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 ServiceSpec |
ServiceSpec
ServiceSpec defines the desired state of Service.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
containers ContainerSpec array | Containers describes the list of application containers than you want to run within a Service. Exactly one of these containers must have a container port specified to expose. | ||
autoscaling LatencyAutoscalingSpec | Autoscaling defines the desired autoscaling behaviour for the service. This is done by defining the intended outcomes of the service e.g. this is the desired request latency needed. | ||
imagePullSecrets LocalObjectReference array | ImagePullSecrets is a list of references to secrets to use for pulling any of the images used by this ServiceSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |