Workflows

[更新日：2025年2月26日]

サービス基本情報 

概要 

「Workflows」は、さくらクラウド上に、ワークフローを実行する基盤を提供するサービスです。ワークフローを使って、反復実行するための特定操作をYAMLで定義できます。

機能説明 

1. シリアル処理
ワークフロー内の処理を順番に実行します。処理の依存関係がある場合、処理を順番に実行することで処理の正常な実行を保証します。
2. 並列処理
複数の処理を同時に実行します。特定の処理同士の依存関係がない場合、処理を同時に実行することで処理時間を短縮できます。
3. 条件分岐
条件に基づいて処理を分岐します。条件によって処理を選択またはスキップすることで、処理の柔軟な制御が可能です。

β版における注意事項と制限事項 

ご利用いただく前に、以下の点にご注意ください。

品質保証（SLA）の適用対象外です。
サポートは限定的となり、利用状況によっては一時的に利用が制限される場合があります。

主な制限事項

項目	制限事項
Runbookでの最大ステップ数	5000ステップ
Switchでの最大分岐数	50分岐
Workflowでの最大分岐数	10分岐
Workflowでの最大並列ネスト数	2回
RunbookのYAMLでの最大サイズ	256KB
Runbook内に書く式の最大長	512文字
Workflowの最大実行時間	1年間
Workflow実行ログの最大保存期間	90日間

料金体系 

β版での提供期間中は無償でご利用いただけます。
正式版リリースに伴う課金開始の際には、事前にアナウンスさせていただきます。

サポート 

ご不明点やお困りの際は、会員メニュー内のメールサポートより、サービス情報を「さくらのクラウド」としてお問い合わせください。

利用手順 

Workflowsの利用を開始するための基本的な手順を説明します。

前提条件 

以下の準備が完了していることが前提となります。

さくらのクラウドご利用開始手順が完了していること

1. APIキーの作成 

さくらのクラウドのコントロールパネルにログインし、使用するクラウドアカウントを選択します。
APIキーのマニュアルを参照し、APIキーを作成してください。

注釈

アクセスレベルは「アクセス不可」以外のいずれかを選択してください。
「他サービスへのアクセス権」で「ワークフロー」にチェックを入れてください。
上記の設定を行うことで、いずれのアクセスレベルでもadmin権限での利用が可能となります。

2. Workflow Runbookを作成する 

テキストエディタを開き、Workflow Runbookを作成します。
ワークフローの書き方については、リファレンスを参照してください。
作成したWorkflow Runbookを保存します。

注釈

ランブックの書き方については、リファレンスを参照してください。

3. Workflow Runbookの登録 

Workflows APIを参照し、Runbook作成のAPIエンドポイントとパラメータを確認します。
curlコマンドを使用して、Runbook登録のAPIリクエストを送信します。
登録が完了すると、作成されたWorkflowの情報が返却されます。

注釈

詳細は Workflows APIドキュメントを参照してください。

4. Workflowの実行 

Workflows APIを参照し、Workflow実行のAPIエンドポイントとパラメータを確認します。
curlコマンドを使用して、Workflow実行のAPIリクエストを送信します。
実行が完了すると、Workflow実行に関する情報が返却されます。

注釈

詳細は Workflows APIドキュメントを参照してください。

5. Workflow実行結果の取得 

Workflows APIを参照し、Workflow実行結果取得のAPIエンドポイントとパラメータを確認します。
curlコマンドを使用して、Workflow実行結果取得のAPIリクエストを送信します。
実行結果が完了すると、Workflow実行結果の情報が返却されます。

注釈

詳細は Workflows APIドキュメントを参照してください。

次のステップ 

アプリケーションの状態を確認し、必要に応じて設定を調整してください。
他の機能（ワークフローの一覧取得、リビジョンの追加、ワークフロー実行のキャンセルなど）をお試しください。
これらの機能の詳細についても、上記のAPIドキュメントを参照してください。
また、Runbookの詳しい書き方(並列処理や例外)については、リファレンスを参照してください。

用語集 

Workflows で使用される主な用語と概念を説明します。

本システムのことは Workflows と呼びます。

ランブック 

Workflowの実行に必要な情報（メタデータ、各Workflowのステップなど）のことです。
また、それをYAML形式で記述したファイルのことをランブックファイル/Runbook File と呼びます。

リビジョン 

ランブックの変更履歴のことです。
リビジョン番号は、ランブックファイルの変更があるたびにインクリメントされます。

リビジョンエイリアス 

リビジョン番号に対して、ユーザが任意の名前をつけることができます。
リビジョンエイリアスは、リビジョン番号と同じようにランブックファイルの変更履歴を参照するために使用されます。