Skip to content

Getting Started

Installation

  • Couler currently only supports Argo Workflows. Please see instructions here to install Argo Workflows on your Kubernetes cluster.
  • Install Python 3.6+
  • Install Couler Python SDK via the following pip command:

pip install git+https://github.com/couler-proj/couler
Alternatively, you can clone this repository and then run the following to install:

python setup.py install

After installing Couler, run the hello world example to submit your first workflow:

import couler.argo as couler
from couler.argo_submitter import ArgoSubmitter

couler.run_container(
    image="docker/whalesay", command=["cowsay"], args=["hello world"]
)

submitter = ArgoSubmitter()
result = couler.run(submitter=submitter)

Once the workflow is successfully submitted, the following logs will be shown:

INFO:root:Found local kubernetes config. Initialized with kube_config.
INFO:root:Checking workflow name/generatedName runpy-
INFO:root:Submitting workflow to Argo
INFO:root:Workflow runpy-ddc2m has been submitted in "default" namespace!