cadence

ケイデンス

このリポジトリには、Cadence サーバーのソース コードと、CLI、スキーマ ツール、ベンチ、カナリアなどのその他のツールが含まれています。

当社のクライアント ライブラリの 1 つを使用してワークフローを実装できます。 Go および Java ライブラリは Cadence チームによって公式に保守されており、Python および Ruby クライアント ライブラリはコミュニティによって開発されています。

iWF を Cadence 上の DSL フレームワークとして使用することもできます。

Cadence のアーキテクチャの概要については、Data@Scale Conference での Maxim の講演を参照してください。

Cadence の詳細については、cadenceworkflow.io にアクセスしてください。 Cadence Documentation プロジェクトに参加してください。そこでお気軽に Issue や Pull Request を提起してください。

コミュニティ

• Github ディスカッション
  • Q&A、サポート/ヘルプ、一般的な議論、お知らせに最適
• スタックオーバーフロー
  • Q&Aや一般的なディスカッションに最適
• Githubの問題
  • バグや機能リクエストの報告に最適
• スラック
  • 貢献/開発ディスカッションに最適

はじめる

ケイデンスサーバーを起動します

Cadence サービスをローカルで実行するには、Cadence サービス Docker を使用してサービスを実行することを強くお勧めします。指示に従ってビルドして実行することもできます。

実稼働/クラスターのセットアップについては、ドキュメント サイトを参照してください。

サンプルを実行する

まずは Go または Java のサンプル レシピを試してください。

ケイデンス CLI を使用する

Cadence CLI は、ワークフロー、タスクリスト、ドメイン、さらにはクラスターの操作に使用できます。

Cadence CLI をインストールするには、次の方法を使用できます。

• brew を使用して CLI をインストールします: brew install cadence-workflow
  • Homebrew 経由で古いバージョンの CLI をインストールする必要がある場合は、指示に従ってください。通常、これは古すぎるバージョンのサーバーを実行している場合にのみ必要になります。
• CLI の docker イメージを使用します: docker run --rm ubercadence/cli:<releaseVersion>またはdocker run --rm ubercadence/cli:master 。新しい機能を試したい場合は、必ずイメージを更新してください: docker pull ubercadence/cli:master
• CLI バイナリを自分でビルドし、リポジトリをチェックアウトして、 make cadence実行してすべてのツールをビルドします。 make コマンドの前提条件については、「CONTRIBUTING」を参照してください。
• CLI イメージを自分でビルドします。手順を参照してください。

Cadence CLI は強力なツールです。コマンドはタブごとに編成されています。たとえば、 workflow -> batch -> start 、またはadmin -> workflow -> describe 。

ドキュメントを読み、学習および探索するために常に任意のタブで--helpを試してください。

ケイデンスウェブを使用する

Cadence Web UI を試して、Cadence 上のワークフローを表示します。 (docker compose で Cadence を実行している場合、これは localhost:8088 ですでに利用可能です)

貢献する

Cadence を素晴らしいものにするために、皆様のご協力をお待ちしております。貢献ガイドをご覧ください。

新しい機能を提案したい場合は、まず Slack チャネルに参加してディスカッションを開始し、既存の設計ディスカッションがあるかどうかを確認してください。機能が設計されていてもまだ実装されていない場合には、設計ドキュメントもよく読んでください。提案が他で取り上げられていないことを確認したら、提案の指示に従ってください。

このリポジトリ内の他のバイナリ

ベンチ/ストレス テスト ワークフロー ツール

ベンチのドキュメントを参照してください。

定期機能ヘルスチェックワークフローツール (別名 Canary)

Canary のドキュメントを参照してください。

SQL および Cassandra 用のスキーマ ツール

このツールは、データベース スキーマの手動セットアップまたはアップグレード用です。

• サーバーが Cassandra で実行されている場合は、Cadence Cassandra ツールを使用します
• サーバーが SQL データベースで実行されている場合は、Cadence SQL ツールを使用します

スキーマ ツールを入手する最も簡単な方法は、自作を使用することです。

brew install cadence-workflow cadence-sql-toolとcadence-cassandra-toolも含まれています。

• スキーマ ファイルは/usr/local/etc/cadence/schema/にあります。
• アップグレードするには、まず古い ElasticSearch スキーマを削除してください: mv /usr/local/etc/cadence/schema/elasticsearch /usr/local/etc/cadence/schema/elasticsearch.old && brew upgrade cadence-workflow 。そうしないと、ElasticSearch スキーマを更新できない可能性があります。
• Homebrew 経由で古いバージョンのスキーマ ツールをインストールする必要がある場合は、指示に従ってください。ただし、より簡単な方法は、古いバージョンのスキーマで新しいバージョンのスキーマ ツールを使用することです。必要なのは、このリポジトリから古いバージョンのスキーマをチェックアウトすることだけです。 git checkout v0.21.3実行して、スキーマ フォルダーに v0.21.3 スキーマを取得します。

時を超えたスターゲイザー

ライセンス

MIT ライセンス。詳細については、「ライセンス」を参照してください。