cadence

module
Version: v0.22.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2021 License: MIT

README

Cadence

Build Status Coverage Status Slack Status

Visit cadenceworkflow.io to learn about Cadence.

This repo contains the source code of the Cadence server. To implement workflows, activities and worker use Go client or Java client.

See Maxim's talk at Data@Scale Conference for an architectural overview of Cadence.

Getting Started

Start the cadence-server locally

We highly recommend that you use Cadence service docker to run the service.

Run the Samples

Try out the sample recipes for Go or Java to get started.

Client SDKs

Java and Golang clients are developed by Cadence team:

Other clients are developed by community:

Use CLI Tools
  • Use Cadence command-line tool to perform various tasks on Cadence server cluster

    • Use brew to install CLI: brew install cadence-workflow
    • Use docker image for CLI: docker run --rm ubercadence/cli:<releaseVersion> 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 image, see instructions
    • Check out the repo and run make cadence to build all tools. See CONTRIBUTING for prerequisite of make command.
  • For manual setup or upgrading server schema --

    • Use brew to install CLI: brew install cadence-workflow which also includes cadence-sql-tool and cadence-cassandra-tool
    • If server runs with Cassandra, Use Cadence Cassandra tool to perform various tasks on database schema of Cassandra persistence
    • If server runs with SQL database, Use Cadence SQL tool to perform various tasks on database schema of SQL based persistence

Tips: Use make tools to build all tools

Use Cadence Web

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)

Documentation

Visit cadenceworkflow.io for documentation.

Join us in Cadence Docs project. Raise an Issue or Pull Request there.

Getting Help

Contributing

We'd love your help in making Cadence great. Please review our contribution guide.

If you'd like to propose a new feature, first join the Slack channel to start a discussion and check if there are existing design discussions. Also peruse our design docs in case a feature has been designed but not yet implemented. Once you're sure the proposal is not covered elsewhere, please follow our proposal instructions.

License

MIT License, please see LICENSE for details.

Directories

Path Synopsis
lib
Package client is a generated GoMock package.
Package client is a generated GoMock package.
admin
Package admin is a generated GoMock package.
Package admin is a generated GoMock package.
frontend
Package frontend is a generated GoMock package.
Package frontend is a generated GoMock package.
history
Package history is a generated GoMock package.
Package history is a generated GoMock package.
matching
Package matching is a generated GoMock package.
Package matching is a generated GoMock package.
cmd
archiver
Package archiver is a generated GoMock package.
Package archiver is a generated GoMock package.
archiver/filestore
Package filestore is a generated GoMock package.
Package filestore is a generated GoMock package.
archiver/gcloud
Package gcloud is a generated GoMock package.
Package gcloud is a generated GoMock package.
archiver/s3store
Package s3store is a generated GoMock package.
Package s3store is a generated GoMock package.
authorization
Package authorization is a generated GoMock package.
Package authorization is a generated GoMock package.
cache
Package cache is a generated GoMock package.
Package cache is a generated GoMock package.
client
Package mock_client is a generated GoMock package.
Package mock_client is a generated GoMock package.
cluster
Package cluster is a generated GoMock package.
Package cluster is a generated GoMock package.
domain
Package domain is a generated GoMock package.
Package domain is a generated GoMock package.
dynamicconfig
Package dynamicconfig is a generated GoMock package.
Package dynamicconfig is a generated GoMock package.
log
membership
Package membership is a generated GoMock package.
Package membership is a generated GoMock package.
ndc
Package ndc is a generated GoMock package.
Package ndc is a generated GoMock package.
pagination
Package pagination is a generated GoMock package.
Package pagination is a generated GoMock package.
persistence/client
Package client is a generated GoMock package.
Package client is a generated GoMock package.
persistence/nosql/nosqlplugin/cassandra/gocql
Package gocql is a generated GoMock package.
Package gocql is a generated GoMock package.
reconciliation/invariant
Package invariant is a generated GoMock package.
Package invariant is a generated GoMock package.
reconciliation/store
Package store is a generated GoMock package.
Package store is a generated GoMock package.
task
Package task is a generated GoMock package.
Package task is a generated GoMock package.
ndc
schema
service
frontend
Package frontend is a generated GoMock package.
Package frontend is a generated GoMock package.
history
Package history is a generated GoMock package.
Package history is a generated GoMock package.
history/engine
Package engine is a generated GoMock package.
Package engine is a generated GoMock package.
history/events
Package events is a generated GoMock package.
Package events is a generated GoMock package.
history/execution
Package execution is a generated GoMock package.
Package execution is a generated GoMock package.
history/failover
Package failover is a generated GoMock package.
Package failover is a generated GoMock package.
history/ndc
Package ndc is a generated GoMock package.
Package ndc is a generated GoMock package.
history/queue
Package queue is a generated GoMock package.
Package queue is a generated GoMock package.
history/replication
Package replication is a generated GoMock package.
Package replication is a generated GoMock package.
history/reset
Package reset is a generated GoMock package.
Package reset is a generated GoMock package.
history/shard
Package shard is a generated GoMock package.
Package shard is a generated GoMock package.
history/task
Package task is a generated GoMock package.
Package task is a generated GoMock package.
matching
Package matching is a generated GoMock package.
Package matching is a generated GoMock package.
tools
cli
sql

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL