Pipelines

Pipelines

Pipelines from an aggregator.

GEThttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines

Authorization

userproject

Path parameters

aggregatorID*string (uuid)

Query parameters

Response

200

OK

Headers

Body

application/json

id*string (uuid)

name*string

DNS label format as of defined on RFC1123

kindenum

Kind of deployment used when deploying this pipeline

daemonSetdeployment

config*PipelineConfig (object)

Pipeline configuration history entry.

configSections*array of ConfigSection (object)

status*PipelineStatus (object)

Pipeline status history entry.

resourceProfile*ResourceProfile (object)

Resource profile model.

replicasCount*integer

checksTotalinteger

total number of checks associated with the pipeline.

checksOKinteger

total number of checks with ok status.

checksRunninginteger

total number of checks with running status.

tagsnullable array of string

metadata*nullable object

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-pipeline",
    "kind": "daemonSet",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "configFormat": "ini",
      "createdAt": "2024-04-19T14:47:13.978Z"
    },
    "configSections": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "projectID": "123e4567-e89b-12d3-a456-426614174000",
        "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
        "kind": "input",
        "properties": [
          {
            "key": "name",
            "value": "dummy"
          }
        ],
        "createdAt": "2024-04-19T14:47:13.978Z",
        "updatedAt": "2024-04-19T14:47:13.978Z"
      }
    ],
    "status": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "config": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "rawConfig": "text",
        "createdAt": "2024-04-19T14:47:13.978Z"
      },
      "status": "NEW",
      "events": [
        {
          "source": "k8s:deployment",
          "reason": "text",
          "message": "text",
          "loggedAt": "2024-04-19T14:47:13.978Z"
        }
      ],
      "createdAt": "2024-04-19T14:47:13.978Z"
    },
    "resourceProfile": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "my-resource-profile",
      "storageSyncFull": false,
      "storageBacklogMemLimit": "1Mi",
      "storageVolumeSize": "2Mi",
      "storageMaxChunksPause": false,
      "cpuLimit": "3Mi",
      "cpuRequest": "4Mi",
      "memoryLimit": "5Mi",
      "memoryRequest": "6Mi",
      "createdAt": "2024-04-19T14:47:13.978Z",
      "updatedAt": "2024-04-19T14:47:13.978Z"
    },
    "tags": [
      "text"
    ],
    "metadata": {},
    "createdAt": "2024-04-19T14:47:13.978Z",
    "updatedAt": "2024-04-19T14:47:13.978Z"
  }
]

Create pipeline

Create pipeline within an aggregator. The pipeline name must be unique within the aggregator. The resource profile must exist already. If you don't provide one, it will default to "best-effort-low-resource". Use them to easily deploy configured agents to the aggregator.

POSThttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines

Authorization

userproject

Path parameters

aggregatorID*string (uuid)

Body

application/json

name*string

DNS label format as of defined on RFC1123

kindenum

Kind of deployment used when deploying this pipeline

daemonSetdeployment

replicasCount*integer

rawConfig*string

configFormatenum

inijsonyaml

secrets*nullable array of CreatePipelineSecret (object)

files*nullable array of CreatePipelineFile (object)

resourceProfile*string

autoCreateChecksFromConfig*boolean

If true, this will automatically create a set of Pipeline checks to validate that the configured output services are reachable.

waitForChecksBeforeDeployingboolean

If set to true:

If all checks associated with the pipeline run successfully, the status of the pipeline will be switched to CHECKS_OK and the deployment will be executed.

If any of the checks associated with the pipeline fails, the status of the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline will be blocked.

If set to false (default):

If all checks associated with the pipeline run successfully, the status of the pipeline will be switched to CHECKS_OK and the deployment will be executed.

If any of the checks associated with the pipeline fails, the status of the pipeline will be switched to CHECKS_FAILED and the deployment of the pipeline will be executed.

autoCreatePortsFromConfig*boolean

skipConfigValidation*boolean

metadatanullable object

Response

201

Created

Body

application/json

idstring (uuid)

namestring

kindenum

Kind of deployment used when deploying this pipeline

daemonSetdeployment

configPipelineConfig (object)

Pipeline configuration history entry.

secretsarray of PipelineSecret (object)

filesarray of PipelineFile (object)

statusPipelineStatus (object)

Pipeline status history entry.

resourceProfileResourceProfile (object)

Resource profile model.

checksarray of PipelineCheck (object)

replicasCountinteger

createdAtstring (date-time)

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "new-pipeline",
      "rawConfig": "text",
      "secrets": [
        {
          "key": "newsecret",
          "value": "Ynl0ZXM="
        }
      ],
      "files": [
        {
          "name": "newfile",
          "contents": "Ynl0ZXM=",
          "encrypted": false
        }
      ],
      "resourceProfile": "my-resource-profile",
      "autoCreatePortsFromConfig": false,
      "autoCreateChecksFromConfig": false,
      "skipConfigValidation": false
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-pipeline",
  "kind": "daemonSet",
  "config": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "rawConfig": "text",
    "configFormat": "ini",
    "createdAt": "2024-04-19T14:47:13.978Z"
  },
  "secrets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "mysecret",
      "value": "Ynl0ZXM=",
      "createdAt": "2024-04-19T14:47:13.978Z",
      "updatedAt": "2024-04-19T14:47:13.978Z"
    }
  ],
  "files": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "myfile",
      "contents": "Ynl0ZXM=",
      "encrypted": false,
      "createdAt": "2024-04-19T14:47:13.978Z",
      "updatedAt": "2024-04-19T14:47:13.978Z"
    }
  ],
  "status": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "createdAt": "2024-04-19T14:47:13.978Z"
    },
    "status": "NEW",
    "events": [
      {
        "source": "k8s:deployment",
        "reason": "text",
        "message": "text",
        "loggedAt": "2024-04-19T14:47:13.978Z"
      }
    ],
    "createdAt": "2024-04-19T14:47:13.978Z"
  },
  "resourceProfile": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-resource-profile",
    "storageSyncFull": false,
    "storageBacklogMemLimit": "1Mi",
    "storageVolumeSize": "2Mi",
    "storageMaxChunksPause": false,
    "cpuLimit": "3Mi",
    "cpuRequest": "4Mi",
    "memoryLimit": "5Mi",
    "memoryRequest": "6Mi",
    "createdAt": "2024-04-19T14:47:13.978Z",
    "updatedAt": "2024-04-19T14:47:13.978Z"
  },
  "checks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 0,
      "host": "localhost",
      "createdAt": "2024-04-19T14:47:13.978Z",
      "updatedAt": "2024-04-19T14:47:13.978Z"
    }
  ],
  "createdAt": "2024-04-19T14:47:13.978Z"
}

Delete Pipelines

Delete pipelines from an aggregator.

DELETEhttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines

Authorization

userproject

Path parameters

aggregatorID*string (uuid)

Query parameters

Response

204

Deleted

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();