Catalyst

by Zoho
×
キャンセル

このページにアクセス
  • チュートリアル
  • FAQ
  • 開発者ツール
    CLI
    SDK
    Java Node.js Python Web Android iOS Flutter
    REST API
    ユーティリティ
    拡張機能 ツール インテグレーション
    • コンソールへ

    お知らせ：

    当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

    スキーマリファレンス

    Catalyst PipelinesのYAML schema referenceは、pipelineのさまざまなコンポーネントの事前定義されたキーを概説しています。これらのキーを使用して、必要なコンポーネントを組み込み、pipelineの実行フローを定義できます。 各コンポーネントの詳細については、それぞれのヘルプページで説明します。こちらから開始できます。CatalystコンソールからのPipelineの設定方法については、こちらのページを参照してください。

    YAML定義

    以下は、Catalystのcatalyst-pipelines.yamlファイルでサポートされているキーのリストです。

    キーワード 説明
    version pipelineのバージョンは任意の整数値として定義でき、pipeline設定を個別の再利用可能なバージョンとして保持する目的で使用されます。
    runners runnerは、stageレベルまたはjobレベルで定義できる仮想マシン構成です。runnersのconfig-idキーの値としてrunner specificationを定義できます。詳細については、こちらのヘルプページを参照してください。
    images imageは、pipeline内のjobsの実行に必要なパッケージまたは依存関係のセットです。imagesはstageレベルまたはjobレベルで定義できます。

    imageキーでimage nameを定義し、registryキーで外部パッケージレジストリ（Dockerhubなど）のURLを定義できます。

    指定されたregistryを認証するためにauthキーも定義する必要があります。詳細については、こちらのヘルプページを参照してください。
    auth 外部registryアカウントを認証し、job実行に必要なパッケージをプルするには、authキーにusernameとpasswordキーを指定する必要があります。詳細については、こちらのヘルプセクションを参照してください。
    variables このキーワードは、pipelineレベルまたはjobレベルでプレースホルダー値を格納するために使用されます。詳細については、こちらのヘルプページを確認してください。
    steps pipeline内のビルド、テスト、デプロイプロセスを実行するために定義できるコマンドのセットです。ビルドするアプリケーション、そのテスト手順、およびアプリケーションをデプロイする環境に基づいてstepsを定義できます。stepsの詳細については、こちらのヘルプページを参照してください。
    jobs jobは、stage内で定義されたstepsのシーケンスです。stage内に最大5つのjobsを定義でき、各jobの下にjobsキーを使用してsteps、variables、runners、およびimagesを定義できます。

    アプリケーションをテストまたはデプロイする前にビルドするようにpipelineを設定している場合、生成されたコードのビルドファイルをCatalyst Stratusサービスに一時的に保存できます。これらの設定はartifactsキーを使用して定義できます。

    このキーには、notifyとapproveという2つのサブキーも含まれています。

    詳細については、こちらのヘルプページを参照してください。
    notify このキーを使用すると、job実行の開始時またはjobの正常完了時に通知を送信できます。この目的には、on-startまたはon-endキーを使用できます。詳細については、こちらのヘルプセクションを確認してください。
    approve このキーは、approval jobsでjobレビュアーの詳細とカスタム承認メッセージを定義するために使用されます。

    type-nameサブキーを使用して承認タイプを設定し、type-variablesキーにレビュアーのメールアドレスとカスタムレビューメッセージを追加できます。このキーには、それぞれreviewersとmessageサブキーが含まれています。
    artifacts このキーは、pipeline実行中に生成されたアプリケーションビルドファイルのアップロードおよびダウンロードプロセスを表すために使用されます。そのために、それぞれuploadとdownloadキーに値を設定できます。artifactsの詳細については、こちらのヘルプページを参照してください。
    upload このキーは、生成されたビルドZIPファイルをCatalyst Stratusサービスに保存するために使用されます。name、location、およびfilesサブキーをそれぞれ使用して、ビルドファイルの名前、ファイルを保存する場所、およびその他のファイル条件を定義する必要があります。
    download このキーは、Catalyst Stratusサービスから保存されたビルドZIPファイルを取得するために使用できます。uploadキーワードと同様に、name、location、およびfilesサブキーも定義できます。
    stages stageは、複数のjobsを含む個別のフェーズです。pipeline内に最大5つのstagesを定義でき、それぞれにjobsのセットが含まれます。stageレベルでrunnersとimagesも定義できます。
    when-equal このキーは、2つの値が完全に一致するかどうかを評価し、検証がtrueの場合にのみ、指定されたpipelineの実行フローを続行するために使用できます。
    when-not このキーは、特定の条件がtrueまたはfalseであるかどうかを評価するために使用できます。評価結果に基づいて、定義されたpipelineフローが実行されます。
    when-not-equal このキーは、2つの値が一致しないかどうかを評価し、その場合に定義されたpipelineフローの実行を続行するために使用できます。
    when-and このキーは、andキーで定義された2つの条件がtrueであるかどうかを評価するために使用できます。trueの場合、when conditionで定義されたフローが実行されます。
    when-or このキーは、orキーで定義された条件のいずれかがtrueであるかどうかを評価するために使用できます。trueの場合、whenキーで定義されたpipelineフローが実行されます。
    pipeline-when pipelineレベルで定義できる条件ロジックで、pipeline全体の実行フローを制御します。pipeline-when conditionとともに、and、equal、or、not、not-equalキーを使用できます。
    pipeline-runner このキーは、pipelineレベルでrunnerを定義するために使用でき、すべてのstagesおよびjobsからアクセス可能です。
    pipeline-image このキーは、pipelineレベルでimageを定義するために使用でき、すべてのstagesおよびjobsからアクセス可能です。
    注意: pipeline-imageファイルでpipelineの実行フローを定義する際は、Catalystが指定した正確なキーワードをキーとして使用し、各キーに対応するデータを割り当てるようにしてください。

    最終更新日 2026-02-23 18:09:41 +0530 IST

    前へ

    次へ

    このページについて