--- title: "スキーマリファレンス" url: https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/schema-reference/ description: "catalyst-pipelines.yamlファイルの事前定義されたスキーマ定義について詳しく学びます。" last_updated: 2026-02-23T12:39:41Z service: Pipelines type: general --- # スキーマリファレンス Catalyst PipelinesのYAML schema referenceは、pipelineのさまざまなコンポーネントの事前定義されたキーを概説しています。これらのキーを使用して、必要なコンポーネントを組み込み、pipelineの実行フローを定義できます。 各コンポーネントの詳細については、それぞれのヘルプページで説明します。[こちら](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners/)から開始できます。CatalystコンソールからのPipelineの設定方法については、[こちらのページ](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/implementation)を参照してください。 ### YAML定義 以下は、Catalystの`catalyst-pipelines.yaml`ファイルでサポートされているキーのリストです。
キーワード 説明
`version` pipelineのバージョンは任意の整数値として定義でき、pipeline設定を個別の再利用可能なバージョンとして保持する目的で使用されます。
`runners` runnerは、**stage**レベルまたは**job**レベルで定義できる仮想マシン構成です。`runners`の`config-id`キーの値としてrunner specificationを定義できます。詳細については、[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners)を参照してください。
`images` imageは、pipeline内のjobsの実行に必要なパッケージまたは依存関係のセットです。imagesは**stage**レベルまたは**job**レベルで定義できます。 `image`キーでimage nameを定義し、`registry`キーで外部パッケージレジストリ（Dockerhubなど）のURLを定義できます。 指定されたregistryを認証するために`auth`キーも定義する必要があります。詳細については、[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images)を参照してください。
`auth` 外部registryアカウントを認証し、job実行に必要なパッケージをプルするには、`auth`キーに`username`と`password`キーを指定する必要があります。詳細については、[こちらのヘルプセクション](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images)を参照してください。
`variables` このキーワードは、**pipeline**レベルまたは**job**レベルでプレースホルダー値を格納するために使用されます。詳細については、[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/variables)を確認してください。
`steps` pipeline内のビルド、テスト、デプロイプロセスを実行するために定義できるコマンドのセットです。ビルドするアプリケーション、そのテスト手順、およびアプリケーションをデプロイする環境に基づいてstepsを定義できます。stepsの詳細については、[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/steps)を参照してください。
`jobs` jobは、stage内で定義されたstepsのシーケンスです。stage内に最大5つのjobsを定義でき、各jobの下に`jobs`キーを使用して`steps`、`variables`、`runners`、および`images`を定義できます。 アプリケーションをテストまたはデプロイする前にビルドするようにpipelineを設定している場合、生成されたコードのビルドファイルをCatalyst Stratusサービスに一時的に保存できます。これらの設定は`artifacts`キーを使用して定義できます。 このキーには、`notify`と`approve`という2つのサブキーも含まれています。 詳細については、[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction)を参照してください。
`notify` このキーを使用すると、job実行の開始時またはjobの正常完了時に通知を送信できます。この目的には、`on-start`または`on-end`キーを使用できます。詳細については、[こちらのヘルプセクション](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction)を確認してください。
`approve` このキーは、[approval jobs](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction)でjobレビュアーの詳細とカスタム承認メッセージを定義するために使用されます。 `type-name`サブキーを使用して承認タイプを設定し、`type-variables`キーにレビュアーのメールアドレスとカスタムレビューメッセージを追加できます。このキーには、それぞれ`reviewers`と`message`サブキーが含まれています。
`artifacts` このキーは、pipeline実行中に生成されたアプリケーションビルドファイルのアップロードおよびダウンロードプロセスを表すために使用されます。そのために、それぞれ`upload`と`download`キーに値を設定できます。artifactsの詳細については、[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/artifacts)を参照してください。
`upload` このキーは、生成されたビルドZIPファイルをCatalyst Stratusサービスに保存するために使用されます。`name`、`location`、および`files`サブキーをそれぞれ使用して、ビルドファイルの名前、ファイルを保存する場所、およびその他のファイル条件を定義する必要があります。
`download` このキーは、Catalyst Stratusサービスから保存されたビルドZIPファイルを取得するために使用できます。uploadキーワードと同様に、`name`、`location`、および`files`サブキーも定義できます。
`[stages](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/stages)` stageは、複数のjobsを含む個別のフェーズです。pipeline内に最大5つのstagesを定義でき、それぞれにjobsのセットが含まれます。stageレベルで`runners`と`images`も定義できます。
`[when-equal](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-equal)` このキーは、2つの値が完全に一致するかどうかを評価し、検証がtrueの場合にのみ、指定されたpipelineの実行フローを続行するために使用できます。
`[when-not](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-not)` このキーは、特定の条件が`true`または`false`であるかどうかを評価するために使用できます。評価結果に基づいて、定義されたpipelineフローが実行されます。
`[when-not-equal](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-not-equal)` このキーは、2つの値が一致しないかどうかを評価し、その場合に定義されたpipelineフローの実行を続行するために使用できます。
`[when-and](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-andwhen-or)` このキーは、`and`キーで定義された2つの条件がtrueであるかどうかを評価するために使用できます。trueの場合、`when` conditionで定義されたフローが実行されます。
`[when-or](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-andwhen-or)` このキーは、`or`キーで定義された条件のいずれかがtrueであるかどうかを評価するために使用できます。trueの場合、`when`キーで定義されたpipelineフローが実行されます。
`[pipeline-when](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#global-configuration)` pipelineレベルで定義できる条件ロジックで、pipeline全体の実行フローを制御します。`pipeline-when` conditionとともに、`and`、`equal`、`or`、`not`、`not-equal`キーを使用できます。
`[pipeline-runner](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners/#global-configuration)` このキーは、pipelineレベルでrunnerを定義するために使用でき、すべてのstagesおよびjobsからアクセス可能です。
`[pipeline-image](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images/#global-configuration)` このキーは、pipelineレベルでimageを定義するために使用でき、すべてのstagesおよびjobsからアクセス可能です。
> **注意:** [pipeline-image](https://docs.catalyst.zoho.com/ja/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images/#global-configuration) ファイルでpipelineの実行フローを定義する際は、Catalystが指定した正確なキーワードをキーとして使用し、各キーに対応するデータを割り当てるようにしてください。