Runbookによるワークフロー定義の概要
[更新: 2026年7月2日]
さくらのクラウドのWorkflowsは ワークフロー を実行する基盤を提供します。ワークフローとは、定義された順序や条件に基づいて、リソースの起動やAPIの呼び出しといった特定の操作を自動的に実行する仕組みです。Workflowsのワークフローは、YAML形式の Rubook （ランブック）で定義します。
ここではワークフローを定義するRunbookをどのように入力して更新するかの概要を説明します。具体的な作業については、当マニュアルの「Workflowsを利用する」にある画面ごとの操作説明を参照します。
参考
Runbookの記述形式については「Runbook 構文リファレンス」を参照してください。
ワークフローの作成とRunbookの入力
それぞれのワークフローは「ワークフロー作成画面」で作成します。作成画面の「Runbook」欄で、ワークフローの実際の挙動を記述したRunbookを入力します。
作成したワークフローは「実行開始画面」で実行できます。実行したワークフローのRunbookを「実行詳細画面」の「Runbook」タブで確認できます。
参考
Runbookの最大サイズなどについて「Runbookに関する上限」を参照してください。
Runbookの更新とリビジョンの作成
ワークフローの実行が失敗したり期待した結果が得られなかった際にRunbookを更新するには、そのワークフローについて新たに リビジョン を作成します。
修正したいワークフローの詳細画面から「リビジョン作成画面」を開く
「Runbook」欄に、その時点で最新のRunbookが表示される
Runbookを修正して「保存」する
上記の手順で、そのワークフローに新しいリビジョンが作成されます。
リビジョンIDとエイリアス
同一ワークフローの異なるリビジョンを区別するため、リビジョンの作成ごとに数字の リビジョンID が自動で付与されます。ワークフローを作成した際のリビジョンIDは1で、Runbookを更新（リビジョンを作成）するごとに1ずつインクリメントされます。
これに対して、利用者が任意でリビジョンごとに エイリアス を付けることもできます。エイリアスは、リビジョンIDと同様にRunbookの変更履歴を参照するために使用されますが、リビジョンIDと違って分かりやすい文字列を自由に設定できます。
リビジョンIDやエイリアス、Runbookの内容といったリビジョンごとの詳細は「リビジョン詳細画面」で確認できます。
参考
エイリアスの最大文字数など、ワークフローの各項目の仕様は「ワークフロー作成画面を操作する」を参照してください。
リビジョンの一覧と管理
リビジョンは、Runbookの変更履歴として扱うことができます。同一のワークフローのすべてのリビジョンを、ワークフロー詳細画面の「リビジョン」タブで一覧表示できます。
注意
作成したリビジョンを削除することはできません。