Calyptia Core API
Support PortalCalyptia CoreContact Us

Pipelines

Pipelines (deprecated)

Pipelines from a core instance (deprecated).

GEThttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines
Authorization
Path parameters
aggregatorID*string (uuid)
Query parameters
Response

OK

Headers
Body
id*string (uuid)
name*string

DNS label format as of defined on RFC1123

Example: "my-pipeline"
kind*PipelineKind (enum)
deploymentdaemonSet
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.

deploymentStrategy*DeploymentStrategy (enum)

The deployment strategy to use when creating or updating changes to this pipeline.

recreatehotReload
tracingEnabled*boolean
waitForChecksBeforeDeploying*boolean
image*nullable string
Example: "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2"
replicasCount*integer
replicasCountPrev*integer

the previous replica set counter

checksTotal*integer

total number of checks associated with the pipeline.

checksOK*integer

total number of checks with ok status.

checksRunning*integer

total number of checks with running status.

tags*nullable array of string
metadata*nullable object
secretsnullable array of PipelineSecret (object)
filesnullable array of PipelineFile (object)
portsnullable array of PipelinePort (object)
minReplicas*integer

minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.

maxReplicas*integer

maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.

scaleUpType*ScalePolicy (enum)
UnknownPodsPercent
scaleUpValue*integer

value contains the amount of change which is permitted by the policy.

scaleUpPeriodSeconds*integer

ScaleUpPeriodSeconds specifies the window of time for which the policy should hold true.

scaleDownType*ScalePolicy (enum)
UnknownPodsPercent
scaleDownValue*integer

value contains the amount of change which is permitted by the policy.

scaleDownPeriodSeconds*integer

ScaleUpPeriodSeconds specifies the window of time for which the policy should hold true.

utilizationCPUAverage*integer

UtilizationCPUAverage defines the target value for average CPU utilization

utilizationMemoryAverage*integer

UtilizationMemoryAverage defines the target value for average CPU utilization

portKind*PipelinePortKind (enum)

The kind/type of the service associated to this port.

LoadBalancerClusterIPNodePort
createdAt*string (date-time)
updatedAt*string (date-time)
Request
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": "deployment",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "configFormat": "ini",
      "createdAt": "2024-11-21T12:58:27.362Z"
    },
    "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-11-21T12:58:27.362Z",
        "updatedAt": "2024-11-21T12:58:27.362Z"
      }
    ],
    "status": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "config": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "rawConfig": "text",
        "createdAt": "2024-11-21T12:58:27.362Z"
      },
      "status": "NEW",
      "events": [
        {
          "source": "k8s:deployment",
          "reason": "text",
          "message": "text",
          "loggedAt": "2024-11-21T12:58:27.362Z"
        }
      ],
      "createdAt": "2024-11-21T12:58:27.362Z"
    },
    "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-11-21T12:58:27.362Z",
      "updatedAt": "2024-11-21T12:58:27.362Z"
    },
    "deploymentStrategy": "recreate",
    "tracingEnabled": false,
    "waitForChecksBeforeDeploying": false,
    "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
    "tags": [
      "text"
    ],
    "secrets": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "key": "mysecret",
        "value": "Ynl0ZXM=",
        "createdAt": "2024-11-21T12:58:27.362Z",
        "updatedAt": "2024-11-21T12:58:27.362Z"
      }
    ],
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
        "name": "myfile",
        "contents": "Ynl0ZXM=",
        "encrypted": false,
        "createdAt": "2024-11-21T12:58:27.362Z",
        "updatedAt": "2024-11-21T12:58:27.362Z"
      }
    ],
    "ports": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "protocol": "tcp",
        "kind": "LoadBalancer",
        "endpoint": "text",
        "pluginID": "forward.0",
        "pluginName": "forward",
        "pluginAlias": "myforwardinput",
        "createdAt": "2024-11-21T12:58:27.362Z",
        "updatedAt": "2024-11-21T12:58:27.362Z"
      }
    ],
    "scaleUpType": "Unknown",
    "scaleDownType": "Unknown",
    "portKind": "LoadBalancer",
    "createdAt": "2024-11-21T12:58:27.362Z",
    "updatedAt": "2024-11-21T12:58:27.362Z"
  }
]

Create pipeline

Create pipeline within a core instance. The pipeline name must be unique within the core instance. 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 core instance.

POSThttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines
Authorization
Path parameters
aggregatorID*string (uuid)
Body
name*string

DNS label format as of defined on RFC1123

Example: "new-pipeline"
kindenum

Kind of deployment used when deploying this pipeline

daemonSetdeployment
replicasCount*integer
rawConfig*string
configFormatenum
inijsonyaml
image*nullable string
Example: "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2"
secrets*nullable array of CreatePipelineSecret (object)
files*nullable array of CreatePipelineFile (object)
resourceProfile*string
Example: "my-resource-profile"
noAutoCreateChecksFromConfigboolean

If true, no Pipeline checks will be auto-generated from the configuration.

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.

noAutoCreateEndpointsFromConfigboolean

if true, no ports will be automatically generated from the configuration.

skipConfigValidation*boolean
metadatanullable object
portKind*PipelinePortKind (enum)

The kind/type of the service associated to this port.

LoadBalancerClusterIPNodePort
minReplicas*integer
maxReplicas*integer
scaleUpType*ScalePolicy (enum)
UnknownPodsPercent
scaleUpValue*integer
scaleUpPeriodSeconds*integer
scaleDownType*ScalePolicy (enum)
UnknownPodsPercent
scaleDownValue*integer
scaleDownPeriodSeconds*integer
utilizationCPUAverage*integer
utilizationMemoryAverage*integer
Response

Created

Body
idstring (uuid)
namestring
Example: "my-pipeline"
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
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",
      "image": "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2",
      "secrets": [
        {
          "key": "newsecret",
          "value": "Ynl0ZXM="
        }
      ],
      "files": [
        {
          "name": "newfile",
          "contents": "Ynl0ZXM=",
          "encrypted": false
        }
      ],
      "resourceProfile": "my-resource-profile",
      "skipConfigValidation": false,
      "portKind": "LoadBalancer",
      "scaleUpType": "Unknown",
      "scaleDownType": "Unknown"
    }),
});
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-11-21T12:58:27.362Z"
  },
  "secrets": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "mysecret",
      "value": "Ynl0ZXM=",
      "createdAt": "2024-11-21T12:58:27.362Z",
      "updatedAt": "2024-11-21T12:58:27.362Z"
    }
  ],
  "files": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "myfile",
      "contents": "Ynl0ZXM=",
      "encrypted": false,
      "createdAt": "2024-11-21T12:58:27.362Z",
      "updatedAt": "2024-11-21T12:58:27.362Z"
    }
  ],
  "status": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "createdAt": "2024-11-21T12:58:27.362Z"
    },
    "status": "NEW",
    "events": [
      {
        "source": "k8s:deployment",
        "reason": "text",
        "message": "text",
        "loggedAt": "2024-11-21T12:58:27.362Z"
      }
    ],
    "createdAt": "2024-11-21T12:58:27.362Z"
  },
  "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-11-21T12:58:27.362Z",
    "updatedAt": "2024-11-21T12:58:27.362Z"
  },
  "checks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 0,
      "host": "localhost",
      "createdAt": "2024-11-21T12:58:27.362Z",
      "updatedAt": "2024-11-21T12:58:27.362Z"
    }
  ],
  "createdAt": "2024-11-21T12:58:27.362Z"
}

Delete Pipelines

Delete pipelines from a core instance.

DELETEhttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/pipelines
Authorization
Path parameters
aggregatorID*string (uuid)
Query parameters
Response

Deleted

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