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

Example: "my-pipeline"

kindenum

Kind of deployment used when deploying this pipeline

daemonSetdeployment

deploymentStrategyenum

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

recreatehotReload

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.

image*nullable string

Example: "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2"

replicasCount*integer

replicasCountPrevinteger

the previous replica set counter

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

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.

scaleUpType*enum

HPAScalingPolicyType is the type of the policy which could be used while making scaling decisions. It can be "Pods" or "Percent"

PodsPercent

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*enum

HPAScalingPolicyType is the type of the policy which could be used while making scaling decisions. It can be "Pods" or "Percent"

PodsPercent

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

portKindPipelinePortKind (enum)

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

LoadBalancerClusterIPNodePort

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",
  "deploymentStrategy": "recreate",
  "config": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "rawConfig": "text",
    "configFormat": "ini",
    "createdAt": "2024-07-27T06:56:18.986Z"
  },
  "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-07-27T06:56:18.986Z",
      "updatedAt": "2024-07-27T06:56:18.986Z"
    }
  ],
  "status": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "config": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rawConfig": "text",
      "createdAt": "2024-07-27T06:56:18.986Z"
    },
    "status": "NEW",
    "events": [
      {
        "source": "k8s:deployment",
        "reason": "text",
        "message": "text",
        "loggedAt": "2024-07-27T06:56:18.986Z"
      }
    ],
    "createdAt": "2024-07-27T06:56:18.986Z"
  },
  "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-07-27T06:56:18.986Z",
    "updatedAt": "2024-07-27T06:56:18.986Z"
  },
  "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-07-27T06:56:18.986Z",
      "updatedAt": "2024-07-27T06:56:18.986Z"
    }
  ],
  "files": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "myfile",
      "contents": "Ynl0ZXM=",
      "encrypted": false,
      "createdAt": "2024-07-27T06:56:18.986Z",
      "updatedAt": "2024-07-27T06:56:18.986Z"
    }
  ],
  "ports": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "kind": "LoadBalancer",
      "endpoint": "text",
      "pluginID": "forward.0",
      "pluginName": "forward",
      "pluginAlias": "myforwardinput",
      "createdAt": "2024-07-27T06:56:18.986Z",
      "updatedAt": "2024-07-27T06:56:18.986Z"
    }
  ],
  "scaleUpType": "Pods",
  "scaleDownType": "Pods",
  "portKind": "LoadBalancer",
  "createdAt": "2024-07-27T06:56:18.986Z",
  "updatedAt": "2024-07-27T06:56:18.986Z"
}

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

Example: "new-pipeline"

kindenum

Kind of deployment used when deploying this pipeline

daemonSetdeployment

deploymentStrategyenum

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

recreatehotReload

replicasCountnullable integer

rawConfignullable string

configFormatnullable enum

inijsonyaml

imagenullable string

Example: "ghcr.io/calyptia/core/calyptia-fluent-bit:23.1.2"

secretsnullable array of UpdatePipelineSecret (object)

filesnullable array of UpdatePipelineFile (object)

resourceProfilenullable string

Example: "my-resource-profile"

noAutoCreateEndpointsFromConfignullable boolean

noAutoCreateChecksFromConfignullable 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 -

portKindPipelinePortKind (enum)

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

LoadBalancerClusterIPNodePort

eventsnullable array of PipelineEvent (object)

metadatanullable object

minReplicasnullable integer

scaleUpTypeScalePolicy (enum)

UnknownPodsPercent

scaleUpValuenullable integer

scaleUpPeriodSecondsnullable integer

scaleDownTypeScalePolicy (enum)

UnknownPodsPercent

scaleDownValuenullable integer

scaleDownPeriodSecondsnullable integer

utilizationCPUAveragenullable integer

utilizationMemoryAveragenullable integer

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",
      "kind": "LoadBalancer",
      "endpoint": "text",
      "pluginID": "forward.0",
      "pluginName": "forward",
      "pluginAlias": "myforwardinput",
      "createdAt": "2024-07-27T06:56:18.986Z",
      "updatedAt": "2024-07-27T06:56:18.986Z"
    }
  ],
  "removedPorts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "kind": "LoadBalancer",
      "endpoint": "text",
      "pluginID": "forward.0",
      "pluginName": "forward",
      "pluginAlias": "myforwardinput",
      "createdAt": "2024-07-27T06:56:18.986Z",
      "updatedAt": "2024-07-27T06:56:18.986Z"
    }
  ],
  "addedChecks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 0,
      "host": "localhost",
      "createdAt": "2024-07-27T06:56:18.986Z",
      "updatedAt": "2024-07-27T06:56:18.986Z"
    }
  ],
  "removedChecks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "protocol": "tcp",
      "status": "new",
      "retries": 3,
      "port": 0,
      "host": "localhost",
      "createdAt": "2024-07-27T06:56:18.986Z",
      "updatedAt": "2024-07-27T06:56:18.986Z"
    }
  ]
}