API Reference
Packages
control.cosmonic.io/v1alpha1
Package v1alpha1 contains API Schema definitions for Cosmonic Control v1alpha1 API group.
Resource Types
HTTPIngressPath
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
path string | Required: {} | ||
pathType PathType | Required: {} |
HTTPIngressSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
host string | Required: {} | ||
paths HTTPIngressPath array | MinItems: 1 Required: {} |
HTTPTrigger
HTTPTrigger is the Schema for the artifacts API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | control.cosmonic.io/v1alpha1 | ||
kind string | HTTPTrigger | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec HTTPTriggerSpec |
HTTPTriggerList
HTTPTriggerList contains a list of HttpTrigger.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | control.cosmonic.io/v1alpha1 | ||
kind string | HTTPTriggerList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items HTTPTrigger array |
HTTPTriggerSpec
HTTPTriggerSpec defines the desired state of HttpTrigger.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
replicas integer | 1 | Optional: {} | |
template WorkloadReplicaTemplate | Required: {} | ||
deployPolicy WorkloadDeployPolicy | RollingUpdate | Optional: {} | |
artifacts WorkloadDeploymentArtifact array | Optional: {} | ||
kubernetes KubernetesSpec | Kubernetes groups Kubernetes-specific configuration such as Service references and endpoint management. | Optional: {} | |
ingress HTTPIngressSpec | Required: {} | ||
timeout Duration | Timeout is the per-route upstream request timeout applied to the xDS route generated for this trigger. Bounds how long the cosmonic-control internal Envoy will wait for a response from the backing Wasm host before returning "upstream request timeout". Accepts Go duration strings (e.g. "300s", "5m"). When unset, Envoy's default (15s) applies. | Optional: {} | |
environment string | Environment pins the Host environment this trigger's workloads are scheduled onto. When unset, the workload is left unpinned and the scheduler treats every host as fair game (shared-host mode). Set this explicitly to schedule onto hosts reporting a specific environment — e.g. a shared hostgroup (e.g. "infra") or a tenant-scoped hostgroup. | Optional: {} |
ProjectEnvironment
ProjectEnvironment is the Schema for the artifacts API.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | control.cosmonic.io/v1alpha1 | ||
kind string | ProjectEnvironment | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ProjectEnvironmentSpec |
ProjectEnvironmentGroupSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | |||
role ProjectEnvironmentRole |
ProjectEnvironmentList
ProjectEnvironmentList contains a list of ProjectEnvironment.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | control.cosmonic.io/v1alpha1 | ||
kind string | ProjectEnvironmentList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items ProjectEnvironment array |
ProjectEnvironmentRole
Underlying type: string
Appears in:
| Field | Description |
|---|---|
owner | |
admin | |
member | |
viewer |
ProjectEnvironmentSpec
ProjectEnvironmentSpec defines the desired state of ProjectEnvironment.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
groups ProjectEnvironmentGroupSpec array | Optional: {} |