Comment on page

Deployments

Deployment Payload
A deployment object is made up of a name, a specification, and an optional config selector. 
Node
Necessity
Description
name
required
Used for referencing purposes and doesn't make up the actual name of the deployment created in Kubernetes
spec.pipeline
required
The UUID of the pipeline resource to be used when creating a deployment.
spec.stream-in-config
optional
Can be used to overwrite the stream in configuration of the pipeline.
spec.stream-out-config
optional
Can be used to overwrite the stream out configuration of the pipeline.
spec.replicas
optional
An integer value representing the number of deployment instances (or Kubernetes Pods) that shall be created.
configSelector
optional
For referencing config objects.
{
  "name": "deployment-name",
  "spec": {
    "pipeline": "dc161a69-fa49-4b1a-b1b1-6d8246d50d71",
    "stream-in-config": {
      "uuid": "dc161a69-fa49-4b1a-b1b1-6d8246d50d72"
    },
    "stream-out-config": {
      "uuid": "dc161a69-fa49-4b1a-b1b1-6d8246d50d73"
    },
    "replicas": 1
  },
  "configSelector": {
    "configKey": "configValue"
  }
}
Get deployments
Get all deployments.
get
/api/v1/deployments
Get deployment
Get a specific deployment identified by its uuid.
get
/api/v1/deployments/{uuid}
Get logs of deployment
Get the logs of a specific deployment identified by its uuid.
get
/api/v1/deployments/{uuid}/logs
Get logs of deployment and follow
Get and follow the incoming logs of a specific deployment identified by its uuid. The logs are provided via server-sent events.
get
/api/v1/deployments/{uuid}/watch-logs
Get health of deployment
Get the health status of the deployments underlying pipeline identified by the deployments uuid.
get
/api/v1/deployments/{uuid}/health
Get metrics of deployment
Get the metrics of the deployments underlying pipeline identified by the deployments uuid.
get
/api/v1/deployments/{uuid}/metrics
Create deployment
Create a new deployment.
post
/api/v1/deployments
Update deployment
Update a specific deployment identified by its uuid.
put
/api/v1/deployments/{uuid}
Delete deployment
Delete a specific deployment identified by its uuid.
delete
/api/v1/deployments/{uuid}
​
​

Node	Necessity	Description
name	required	Used for referencing purposes and doesn't make up the actual name of the deployment created in Kubernetes
spec.pipeline	required	The UUID of the pipeline resource to be used when creating a deployment.
spec.stream-in-config	optional	Can be used to overwrite the `stream in` configuration of the pipeline.
spec.stream-out-config	optional	Can be used to overwrite the `stream out` configuration of the pipeline.
spec.replicas	optional	An integer value representing the number of deployment instances (or Kubernetes Pods) that shall be created.
configSelector	optional	For referencing config objects.

Transforms

Configs

Last modified 8mo ago