diff --git a/README.md b/README.md index ce55581a0593..acf21d1d2102 100644 --- a/README.md +++ b/README.md @@ -2,51 +2,93 @@ [![CI](https://github.com/argoproj/argo-workflows/workflows/CI/badge.svg)](https://github.com/argoproj/argo-workflows/actions?query=event%3Apush+branch%3Amaster) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3830/badge)](https://bestpractices.coreinfrastructure.org/projects/3830) -![Argo Image](docs/assets/argo.png) - ## What is Argo Workflows? -Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. Argo Workflows is implemented as a Kubernetes CRD (Custom Resource Definition). + +Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. Argo +Workflows is implemented as a Kubernetes CRD (Custom Resource Definition). * Define workflows where each step in the workflow is a container. -* Model multi-step workflows as a sequence of tasks or capture the dependencies between tasks using a directed acyclic graph (DAG). -* Easily run compute intensive jobs for machine learning or data processing in a fraction of the time using Argo Workflows on Kubernetes. -* Run CI/CD pipelines natively on Kubernetes without configuring complex software development products. +* Model multi-step workflows as a sequence of tasks or capture the dependencies between tasks using a directed acyclic + graph (DAG). +* Easily run compute intensive jobs for machine learning or data processing in a fraction of the time using Argo + Workflows on Kubernetes. Argo is a [Cloud Native Computing Foundation (CNCF)](https://cncf.io/) hosted project. [![Argo Workflows in 5 minutes](https://img.youtube.com/vi/TZgLkCFQ2tk/0.jpg)](https://www.youtube.com/watch?v=TZgLkCFQ2tk) +## Use Cases + +* Machine Learning pipelines +* Data and batch processing +* ETL +* Infrastructure automation +* CI/CD + ## Why Argo Workflows? -* Designed from the ground up for containers without the overhead and limitations of legacy VM and server-based environments. + +* Argo Workflows is the most popular workflow execution engine for Kubernetes. +* It can run 1000s of workflows a day, each with 1000s of concurrent tasks. +* Our users say it is lighter-weight, faster, more powerful, and easier to use +* Designed from the ground up for containers without the overhead and limitations of legacy VM and server-based + environments. * Cloud agnostic and can run on any Kubernetes cluster. -* Easily orchestrate highly parallel jobs on Kubernetes. -* Argo Workflows puts a cloud-scale supercomputer at your fingertips! + +[Read what people said in our latest survey](https://blog.argoproj.io/argo-workflows-2021-survey-results-d6fa890030ee) ## Try Argo Workflows -[Access the demo enviromnment](https://workflows.apps.argoproj.io/workflows/argo) (login using Github) +[Access the demo environment](https://workflows.apps.argoproj.io/workflows/argo) (login using Github) + +![Screenshot](docs/assets/screenshot.png) + +## Ecosystem + +![Ecosystem](docs/assets/ecosystem.png) + +[Argo Events](https://github.com/argoproj/argo-events) +| +[Argo Workflows Catalog](https://argoproj-labs.github.io/argo-workflows-catalog/) +| +[Couler](https://github.com/couler-proj/couler) +| +[OnePanel](https://www.onepanel.ai/) +| +[Ploomber](https://github.com/ploomber/ploomber) +| +[SQLFlow](https://github.com/sql-machine-learning/sqlflow) +| +[Kubeflow Pipelines](https://github.com/kubeflow/pipelines) + +## SDKs + +Check out our [Java, Golang and Python SDKs](https://github.com/argoproj-labs/argo-client-gen). ## Quickstart + ```bash kubectl create namespace argo kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo-workflows/stable/manifests/install.yaml ``` ## Who uses Argo Workflows? + [Official Argo Workflows user list](USERS.md) ## Documentation + * [Get started here](docs/quick-start.md) * [How to write Argo Workflow specs](examples/README.md) * [How to configure your artifact repository](docs/configure-artifact-repository.md) ## Features + * UI to visualize and manage Workflows * Artifact support (S3, Artifactory, Alibaba Cloud OSS, HTTP, Git, GCS, raw) * Workflow templating to store commonly used Workflows in the cluster * Archiving Workflows after executing for later access -* Scheduled workflows -* Server interface with REST API +* Scheduled workflows using cron +* Server interface with REST API (HTTP and GRPC) * DAG or Steps based declaration of workflows * Step level input & outputs (artifacts/parameters) * Loops @@ -71,14 +113,27 @@ kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo-workflo * Multiple executors * Multiple pod and workflow garbage collection strategies * Automatically calculated resource usage per step +* Java/Golang/Python SDKs * Pod Disruption Budget support +* Single-sign on (OAuth2/OIDC) +* Webhook triggering +* CLI +* Out-of-the box and custom Prometheus metrics +* Windows container support +* Embedded widgets +* Multiplex log viewe ## Community Meetings -We host monthly community meetings where we and the community showcase demos and discuss the current and future state of the project. Feel free to join us! For Community Meeting information, minutes and recordings please [see here](https://bit.ly/argo-wf-cmty-mtng). -Participation in the Argo Workfows project is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) +We host monthly community meetings where we and the community showcase demos and discuss the current and future state of +the project. Feel free to join us! For Community Meeting information, minutes and recordings +please [see here](https://bit.ly/argo-wf-cmty-mtng). + +Participation in the Argo Workflows project is governed by +the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) ## Community Blogs and Presentations + * [Automation of Everything - How To Combine Argo Events, Workflows & Pipelines, CD, and Rollouts](https://youtu.be/XNXJtxkUKeY) * [Argo Workflows and Pipelines - CI/CD, Machine Learning, and Other Kubernetes Workflows](https://youtu.be/UMaivwrAyTA) * [Argo Ansible role: Provisioning Argo Workflows on OpenShift](https://medium.com/@marekermk/provisioning-argo-on-openshift-with-ansible-and-kustomize-340a1fda8b50) @@ -91,6 +146,7 @@ Participation in the Argo Workfows project is governed by the [CNCF Code of Cond * TGI Kubernetes with Joe Beda: [Argo workflow system](https://www.youtube.com/watch?v=M_rxPPLG8pU&start=859) ## Project Resources + * Argo GitHub: https://github.com/argoproj * Argo Website: https://argoproj.github.io/ * Argo Slack: [click here to join](https://argoproj.github.io/community/join-slack) diff --git a/docs/assets/ecosystem.png b/docs/assets/ecosystem.png new file mode 100644 index 000000000000..46778ab44b76 Binary files /dev/null and b/docs/assets/ecosystem.png differ diff --git a/docs/assets/screenshot.png b/docs/assets/screenshot.png new file mode 100644 index 000000000000..0d1db1430211 Binary files /dev/null and b/docs/assets/screenshot.png differ