PipelineSpec

PipelineSpec
PipelineSpec

Pipeline Specification

JSON Example 
{
    "_inputMeta": {
        "test": {
            "description": "test-value",
            "mandatory": false
        }
    },
    "concurrency": 10,
    "description": "string",
    "enabled": true,
    "input": [
        {
            "ip": "10.5.23.84",
            "script": "testScript.sh"
        }
    ],
    "name": "My-Name",
    "notifications": {
        "email": [
            {
                "to": [
                    "[email protected]"
                ],
                "subject": "Pipeline execution notification",
                "body": "pipeline-execution-1234",
                "event": "SUCCESS",
                "endpoint": "Codestream-Default-Email"
            }
        ],
        "jira": [
            {
                "assignee": "[email protected]",
                "description": "Details about the issue being reported",
                "endpoint": "string",
                "event": "string",
                "issuetype": "Bug/Story",
                "project": "VRCS",
                "stage": "string",
                "summary": "Pipeline-1 execution failed",
                "task": "string"
            }
        ],
        "webhook": [
            {
                "action": "POST/PUT/PATCH",
                "endpoint": "string",
                "event": "string",
                "payload": {
                    "text": "executionId",
                    "username": "[email protected]"
                },
                "stage": "string",
                "task": "string",
                "url": "string"
            }
        ]
    },
    "options": [
        "DOCKER_TRIGGER"
    ],
    "output": [
        {
            "deployedMachineIP": "10.108.35.54",
            "result": "true"
        }
    ],
    "project": "My-Project",
    "rollbacks": [
        {
            "stage": "Deploy to Prod",
            "task": "Deploy",
            "name": "Undo Deployment",
            "inputs": {}
        }
    ],
    "stageOrder": [
        "AcquireToken",
        "Upgrade",
        "E2E"
    ],
    "starred": {
        "input": {
            "input": "commitId"
        },
        "output": {
            "output": "owner"
        }
    },
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "workspace": {
        "autoCloneForTrigger": true,
        "cache": [
            "/root/.m2",
            "/temp/"
        ],
        "endpoint": "string",
        "image": "fedora:latest",
        "path": "/usr/administrator/",
        "registry": "Docker Trusted Registry"
    }
}
object
_inputMeta
Optional

Additional information about Input Properties

integer As int32 As int32
concurrency
Optional

Number of Executions of the Pipeline that can run concurrently.

string
description
Required

A human-friendly description.

boolean
enabled
Optional

Indicates if the Pipeline is in enabled state.

object
input
Optional

Map representing the Input properties for the Pipeline.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

NotificationConfiguration
notifications
Optional

notifications

array of string
options
Optional

Represents the different options to trigger a Pipeline. Selecting an option auto injects the Input properties needed to execute a Pipeline with that trigger.

object
output
Optional

Map representing the Output properties for the Pipeline.

string
project
Optional

The project this entity belongs to.

array of RollbackConfiguration
rollbacks
Optional

Represents the various Rollback Configurations for the Pipeline

array of string
stageOrder
Optional

Represents the order in which Stages will be executed.

object
stages
Optional

Map representing the details of the various Stages of the Pipeline.

Pipeline_StarredProperty
starred
Optional

starred

array of string
tags
Optional

A set of tag keys and optional values that were set on on the resource.

Workspace
workspace
Optional

workspace

Parameter To