Reference
PachCTL

Transform PPS

Set the name of the Docker image that your jobs use.

March 24, 2023

ℹī¸

For a single-page view of all PPS options, go to the PPS series page.

Spec #


"transform": {
    "image": string,
    "cmd": [ string ],
    "err_cmd": [ string ],
    "env": {
        string: string
    },

    "secrets": [ {
        "name": string,
        "mount_path": string
    },
    {
        "name": string,
        "env_var": string,
        "key": string
    } ],
    "image_pull_secrets": [ string ],
    "stdin": [ string ],
    "err_stdin": [ string ],
    "accept_return_code": [ int ],
    "debug": bool,
    "user": string,
    "working_dir": string,
    "dockerfile": string,
    "memory_volume": bool,
},

Attributes #

Attribute Description
cmd Passes a command to the Docker run invocation.
stdin Passes an array of lines to your command on stdin.
err_cmd Passes a command executed on failed datums.
err_stdin Passes an array of lines to your error command on stdin.
env Enables a key-value map of environment variables that Pachyderm injects into the container.
secrets Passes an array of secrets to embed sensitive data.
image_pull_secrets Passes an array of secrets that are mounted before the containers are created.
accept_return_code Passes an array of return codes that are considered acceptable when your Docker command exits.
debug Enables debug logging for the pipeline
user Sets the user that your code runs as.
working_dir Sets the directory that your command runs from.
memory_volume Sets pachyderm-worker’s emptyDir.Medium to Memory, allowing Kubernetes to mount a memory-backed volume (tmpfs).

Behavior #

When to Use #

You must always use the transform attribute when making a pipeline.