Pipeline

Pipeline
Pipeline

Represents a pipeline in TAC to package, verify and distribute an application in a registry of an organization

JSON Example
{
    "id": "94bd3a9b-ddfd-4b7e-ac56-200b8a73484d",
    "triggers": [
        {
            "type": "CVE_PATCH",
            "context": "CVE-25010-1312"
        }
    ],
    "status": "IN_PROGRESS",
    "started_at": "2023-03-03T00:59:52.762Z",
    "ended_at": "2023-03-03T00:59:52.762Z",
    "product": {
        "name": "Argo CD",
        "key": "argo-cd",
        "description": "Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes",
        "long_display_name": "Argo CD packaged by VMware",
        "disclaimer": "Trademarks: This software listing is packaged by VMware. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement",
        "category": "Developer Tools",
        "based_on_scratch": true
    },
    "base_image": {
        "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
        "name": "Debian 11",
        "description": "Debian 11 base image",
        "container_image": "docker.io/library/debian:11",
        "operating_system": {
            "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
            "name": "Centos 7",
            "distro": "centos",
            "version": "7"
        },
        "healthy": true,
        "last_checked_at": "2023-03-03T00:59:52.762Z"
    },
    "branch": "1",
    "packaging_type": "HELM_CHART",
    "version": "15.4.0",
    "product_version": "4.0.7",
    "revision": "r2",
    "phases": [
        {
            "type": "PACKAGING",
            "status": "IN_PROGRESS",
            "started_at": "2023-03-03T00:59:52.762Z",
            "ended_at": "2023-03-03T00:59:52.762Z",
            "failure": {
                "error_message": "Error building the container",
                "cause": "CUSTOMIZATION_BUILD_ERROR",
                "pipeline_metadata": [
                    {
                        "id": "127e6fbfe24a750e72930c220a8e138275656b8e5d8f48a98c3c92df2caba935",
                        "mime_type": "trigger_info",
                        "url": "https://app-catalog.vmware.com/api/v1/artifacts/89a6380a7d010648bad74e4de1c2ef17481a7f4715ff62bb8924e5c0b907bf3d?filename=common-postgresql-15-15.2.0-r5-debian-11-amd64.ova&namespace=68c0f832-5169-4433-ab2f-40e939e3f1bc",
                        "filename": "result.json"
                    }
                ]
            }
        }
    ],
    "registry": {
        "id": "549cfa79-352c-4555-9d28-4442de551829",
        "name": "Harbor registry for my org",
        "url": "https://harbor.mydomain.com",
        "healthy": true,
        "last_checked_at": "2023-03-03T00:59:52.762Z"
    },
    "release_id": "64455e6bd3c480fd58546c75",
    "customization": {
        "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
        "version": "v4",
        "artifact": {
            "id": "127e6fbfe24a750e72930c220a8e138275656b8e5d8f48a98c3c92df2caba935",
            "url": "/v1/catalogs/46ba3c35-fb85-44a1-8336-694b4d4f4b91/files/81a957b549848a7424eb434d3d10642dd29b6d0577757c27c09b0b9e967eb64b?filename=custom-postgresql-15-15.2.0-r5-debian-11-amd64.ova",
            "filename": "script.sh"
        }
    },
    "application_id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
    "_links": {
        "catalog": {
            "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9"
        },
        "application": {
            "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/applications/d16c7f4d-b38a-405b-a1ca-3ac0a79418c1"
        },
        "base_image": {
            "href": "/v1/base-images/cc6c7f4d-405b-a1ca-3ac0a79418c1"
        },
        "release": {
            "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/releases/12sdfe6bd3c480fd58549c03"
        },
        "registry": {
            "href": "/v1/registries/64455e6bd3c480fd58546c75"
        },
        "product": {
            "href": "/v1/applications/product/wordpress/branch/7?packaging=CONTAINER_IMAGE&distro=photon-4"
        },
        "customization": {
            "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/customizations/d16c7f4d-b38a-405b-a1ca-3ac0a79418c1"
        }
    }
}
id
Required

Identifier of the pipeline

triggers
Required

triggers

string
status
Required

Pipeline status (IN_PROGRESS, SUCCEEDED, FAILED, CANCELLED)

string As date-time As date-time
started_at
Required

Date of the start of the pipeline

string As date-time As date-time
ended_at
Optional

Date of the end of the pipeline

product
Required

It contains information about the software offered

base_image
Required

It contains information about the base image used for an application

string
branch
Required

Branch of the releaseable built by the pipeline

packaging_type
Required

Packaging type of the application (HELM_CHART, OVA, CONTAINER_IMAGE)

string
version
Required

Version of the releaseable built by the pipeline.

string
product_version
Required

Version of the product built by the pipeline.

string
revision
Optional

Revision of the releaseable built by the pipeline

phases
Required

phases

registry
Optional

Registry where the artifacts of an application release are pushed to

release_id
Optional

Unique identifier of a release

customization
Optional

It contains information about a customization in a catalog

application_id
Optional

Identifier of the application

object
_links
Required

Section to include hyperlinks based on Hypertext Application Language

Returned By