Aggregator pipelines

Pipeline

Pipeline by ID.

GEThttps://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Query parameters

Response

200

OK

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/aggregator_pipelines/{pipelineID}', {
    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-24T05:53:06.063Z"
  },
  "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-24T05:53:06.063Z",
      "updatedAt": "2024-04-24T05:53:06.063Z"
    }
  ],
  "status": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "createdAt": "2024-04-24T05:53:06.063Z"
    },
    "status": "NEW",
    "events": [
      {
        "source": "k8s:deployment",
        "reason": "text",
        "message": "text",
        "loggedAt": "2024-04-24T05:53:06.063Z"
      }
    ],
    "createdAt": "2024-04-24T05:53:06.063Z"
  },
  "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-24T05:53:06.063Z",
    "updatedAt": "2024-04-24T05:53:06.063Z"
  },
  "tags": [
    "text"
  ],
  "metadata": {},
  "createdAt": "2024-04-24T05:53:06.063Z",
  "updatedAt": "2024-04-24T05:53:06.063Z"
}

Delete pipeline

Delete pipeline by its ID.

DELETEhttps://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Response

204

No Content

Request

JavaScriptCurl

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

Update pipeline

Update pipeline by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Body

application/json

namenullable string

DNS label format as of defined on RFC1123

kindenum

Kind of deployment used when deploying this pipeline

daemonSetdeployment

replicasCountnullable integer

rawConfignullable string

configFormatnullable enum

inijsonyaml

secretsnullable array of UpdatePipelineSecret (object)

filesnullable array of UpdatePipelineFile (object)

resourceProfilenullable string

autoCreatePortsFromConfignullable boolean

autoCreateChecksFromConfignullable boolean

skipConfigValidationboolean

checksBeforeDeployingnullable boolean

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

statusnullable enum

NEWFAILEDSTARTINGSTARTEDSCALINGCHECKS_OKCHECKS_FAILED

eventsnullable array of PipelineEvent (object)

metadatanullable object

Response

200

OK

Body

application/json

addedPortsarray of PipelinePort (object)

removedPortsarray of PipelinePort (object)

addedChecksarray of PipelineCheck (object)

removedChecksarray of PipelineCheck (object)

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "addedPorts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "endpoint": "text",
      "pluginID": "forward.0",
      "pluginName": "forward",
      "pluginAlias": "myforwardinput",
      "createdAt": "2024-04-24T05:53:06.063Z",
      "updatedAt": "2024-04-24T05:53:06.063Z"
    }
  ],
  "removedPorts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "endpoint": "text",
      "pluginID": "forward.0",
      "pluginName": "forward",
      "pluginAlias": "myforwardinput",
      "createdAt": "2024-04-24T05:53:06.063Z",
      "updatedAt": "2024-04-24T05:53:06.063Z"
    }
  ],
  "addedChecks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 0,
      "host": "localhost",
      "createdAt": "2024-04-24T05:53:06.063Z",
      "updatedAt": "2024-04-24T05:53:06.063Z"
    }
  ],
  "removedChecks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 0,
      "host": "localhost",
      "createdAt": "2024-04-24T05:53:06.063Z",
      "updatedAt": "2024-04-24T05:53:06.063Z"
    }
  ]
}