Run Commands
Read the PPS series >

Metadata PPS

Add metadata to your pipeline pods using Kubernetes' labels and annotations.

December 4, 2023

Spec #

This is a top-level attribute of the pipeline spec.

{
    "pipeline": {...},
    "transform": {...},
    "metadata": {
        "annotations": {
            "annotation": string
        },
        "labels": {
            "label": string
        }
    },
    ...
}

Behavior #

Both parameters require a key-value pair. Do not confuse this parameter with podPatch, which adds metadata to the user container of the pipeline pod. For more information, see Labels and Selectors and Kubernetes Annotations in the Kubernetes documentation.

When to Use #

Use metadata for operation ergonomics and to simplify the querying of Kubernetes objects.