Configs

Config Payload
The config payload is made up of a name, kind, metadata, and spec.
Node
Necessity
Description
name
required
Used for referencing purposes.
kind
required
Used to define which resource the config will be used for, either a DEPLOYMENT or STREAM.
metadata
required
Contains an extra node, labels, which is used for matching the given config resource to streams or deployments.
spec
required
The spec of a config can vary depending on which resource is defined in the kind node. For these definitions, see the correlating documentations for the deployments payload and stream payload specifications.
{
  "name": "stream-config",
  "kind": "STREAM",
  "metadata" : {
    "labels" : {
      "app.datacater.io/name": "stream-config"
    }
  },
  "spec": {
    "kafka": {
      "bootstrap.servers": "localhost:9092",
      "topic": {
        "num.partitions": "4",
        "replication.factor": "1"
      }
    }
  }
}
List configs
Get all configs.
get
/api/v1/configs
Get a specific config
Get a specific config identified by its uuid.
get
/api/v1/configs/{uuid}
Create new config
Create a new config
post
/api/v1/configs
Update a config
Update a specific config identified by its uuid.
put
/api/v1/configs/{uuid}
Delete config
Delete a specific config identified by its uuid.
delete
/api/v1/config/{uuid}

Node	Necessity	Description
name	required	Used for referencing purposes.
kind	required	Used to define which resource the config will be used for, either a `DEPLOYMENT` or `STREAM`.
metadata	required	Contains an extra node, `labels`, which is used for matching the given config resource to `streams` or `deployments`.
spec	required	The spec of a config can vary depending on which resource is defined in the `kind` node. For these definitions, see the correlating documentations for the deployments payload and stream payload specifications.

Last modified 3mo ago