pipeline-configuration.md

Plankton Pipeline Configuration Reference

build

jobs:
  JOB:
    build: CONTEXT
  JOB:
    build:
      context: CONTEXT
      dockerfile: DOCKERFILE

command

jobs:
  JOB:
    command: OPTION
  JOB:
    command:
      - OPTION1
      - OPTION2

depends_on

jobs:
  JOB:
    depends_on: OTHER
  JOB:
    depends_on:
      - OTHER1
      - OTHER2
  JOB:
    depends_on:
      OTHER:
        condition: job_completed_successfully
  JOB:
    depends_on:
      OTHER:
        condition: job_failed
  JOB:
    depends_on:
      OTHER:
        condition: service_healthy

entrypoint

jobs:
  JOB:
    entrypoint: COMMAND
  JOB:
    entrypoint:
      - COMMAND1
      - COMMAND2

environment

jobs:
  JOB:
    environment:
      - VARIABLE=VALUE
  JOB:
    environment:
      VARIABLE: VALUE

env_file

jobs:
  JOB:
    env_file: FILEPATH
  JOB:
    env_file:
      - FILEPATH1
      - FILEPATH2

expose

jobs:
  JOB:
    expose:
      - PORT

extends

jobs:
  JOB:
    extends: JOB
  JOB:
    extends:
      file: FILE
      job: JOB

group_add

jobs:
  JOB:
    group_add:
      - GROUP

healthcheck

jobs:
  JOB:
    healthcheck:
      test: TEST
      interval: INTERVAL
      timeout: TIMEOUT
      retries: RETRIES
      start_period: START_PERIOD
  JOB:
    healthcheck:
      disabled: true

image

jobs:
  JOB:
    image: IMAGE

profiles

jobs:
  JOB:
    profiles:
      - PROFILE

scale

jobs:
  JOB:
    scale: SCALE

user

jobs:
  JOB:
    user: USER

volumes

jobs:
  JOB:
    volumes:
      - type: bind
        source: SOURCE_PATH
        target: TARGET_PATH
        read_only: BOOLEAN
  JOB:
    volumes:
      - SOURCE_PATH:TARGET_PATH
      - SOURCE_PATH:TARGET_PATH:rw
      - SOURCE_PATH:TARGET_PATH:ro

working_dir

jobs:
  JOB:
    working_dir: WORKING_DIR