cadence-workflow /cadence
Cadence is a distributed, scalable, durable, and highly available orchestration engine to execute asynchronous long-running business logic in a scalable and resilient way.
★ 9,556⑂ 931👁 1,410⑃ 6,916● 1,692▤ 106
+0
Daily
9,556
stars
931
forks
1,410
watchers
6,916
prs
1,692
issues
106
releases
README
Cadence Cadence Workflow is an open-source platform since 2017 for building and running scalable, fault-tolerant, and long-running workflows. This repository contains the core orchestration engine and tools including CLI, schema managment, benchmark and canary. Getting Started Cadence backend consists of multiple services, a database (Cassandra/MySQL/PostgreSQL) and optionally Kafka+Elasticsearch. As a user, you need a worker which contains your workflow implementation. Once you have Cadence backend and worker(s) running, you can trigger workflows by using SDKs or via CLI. 1. Start cadence backend components locally docker compose -f docker/docker-compose.yml up 2. Run the Samples Try out the sample recipes for Go or Java. 3. Visit UI Visit http://localhost:8088 to check workflow histories and detailed traces. Kubernetes Deployment For a guided Kubernetes installation experience, KubeStellar Console provides a step-by-step mission that deploys Cadence using the official Helm chart from cadence-charts. The mission includes pre-flight checks, validation, troubleshooting, and rollback support. Client Libraries You can implement your workflows with one of our client libraries: - Official Cadence Go SDK - Official Cadence Java SDK There are also unofficial Python and Ruby SDKs developed by the community. You can also use iWF as a DSL framework on top of Cadence. CLI Cadence CLI can be used to operate workflows, tasklist, domain and even the clusters. You can use the following ways to install Cadence CLI: Use brew to install CLI: brew install cadence-workflow Follow the instructions if you need to install older versions of CLI via homebrew. Usually this is only needed when you are running a server of a too old version. Use docker image for CLI: docker run --rm ubercadence/cli: or docker run --rm ubercadence/cli:master . Be sure to update your image when you want to try new features: docker pull ubercadence/cli:master Build the CLI binary yourself, check out the repo and run make cadence to build all tools. See CONTRIBUTING for prerequisite of make command. Build the CLI image yourself, see instructions Cadence CLI is a powerful tool. The commands are organized by tabs. E.g. workflow-batch-start, or admin-workflow-describe. Please read the documentation and always try out --help on any tab to learn & explore. UI Try out Cadence Web UI to view your workflows on Cadence. (This is already available at localhost:8088 if you run Cadence with docker compose) Other binaries in this repo Bench/stress test workflow tools See bench documentation. Periodical feature health check workflow tools(aka Canary) See canary documentation. Schema tools for SQL and Cassandra The tools are for manual setup or upgrading database schema If server runs with Cassandra, Use Cadence Cassandra tool If server runs with SQL database, Use Cadence SQL tool The easiest way to get the schema tool is via homebrew. brew install
Top issues
#7830Guided Cadence install mission in KubeStellar Console14 comments · 2026-03-18#3914Proposal: Reset to a reset point with pending ChildWorkflows13 comments · 2021-01-22#348Feature request: Provide http interface for activity workers10 comments · 2017-09-12#7195Add domain created_time value to DescribeDomainResponse8 comments · 2025-08-20#4520OAuth public/private key concerns8 comments · 2021-09-29#7643Refactor ExecutionManager/ExecutionStore to be a host-level component7 comments · 2026-01-23#2403Concurrency control of inflight workflows7 comments · 2019-08-16#6706Role based Cadence-web6 comments · 2025-03-03
Discussions
#7706Client Request Auto-Forwarding0 comments · 2026-02-13#7508RBAC in the Cadence Web4 comments · 2025-12-05#6888Reporting scam emails1 comments · 2025-05-06#6633delaystart seems not working when adding to the workflow option4 comments · 2025-01-17#6372Upgrade cadence mysql db only?2 comments · 2024-10-16#6269history_node table is taking too much storage [database: postgres]1 comments · 2024-09-06#6024When can we expect the official helm charts to be released?1 comments · 2024-05-15#5958Can anyone please help with the monitoring params that needs to be taken into account1 comments · 2024-04-30
Latest release
v1.4.5 v1.4.5 2026-10-30Upgrade Notes - Cassandra schema: apply migrations through v0.55 before rollout (current is v0.52 in v1.4.2). v0.53 adds the semaphore_info type and executions.semaphore_map, v0.54 adds jitter_coefficient to workflow_execution and activity_info, and v0.55 adds semaphore_name to transfer_task. MySQL, PostgreSQL and SQLite schemas are unchanged. Schema updates that fail partway can now be re-run: duplicate DDL statements are logged and skipped (8598). - If you're on a version older than v1.4.2, deploy v1.4.2 first, since it carries the read filter the tombstone reduction depends on. See Cass