Function Compute:.yaml ファイルを使用したパイプラインの記述

前提条件

開始する前に、以下の前提条件を満たしていることを確認してください。

• パイプラインとパイプラインテンプレートに関する知識。 詳細については、「パイプライン」および「パイプラインテンプレート」をご参照ください。

• Serverless Application Center でサポートされている Git リポジトリと、その管理権限。 アプリケーションの設定時に Serverless Application Center が作成するリポジトリを使用できます。

• リポジトリのルートディレクトリにある .yaml ファイル (例: cicd.yaml)

仕組み

.yaml ファイルは、Serverless Application Center がパイプラインの実行に使用するパイプラインオブジェクトとデータ構造を記述します。このファイルでは、パイプライン名、グローバルコンテキスト、およびタスクのリストとその依存関係を指定します。コミットによってパイプラインがトリガーされると、Serverless Application Center はすべての <% %> プレースホルダーを実際のランタイム値に置き換えてから、パイプラインとタスクオブジェクトを送信します。

ファイルは 3 階層の構造を使用します。

Pipeline
  └── spec
        ├── context.data      (グローバル構成: appName, deployFile, notifications)
        └── templateSpec
              └── tasks[]     (タスクのリスト)
                    ├── context.data.steps[]   (プラグインまたはシェルコマンド)
                    ├── taskTemplate           (タスクの動作: runner または approval)
                    └── runAfters[]            (依存関係の宣言)

フィールドリファレンス

次の表は、パイプラインの .yaml ファイルにおけるトップレベルおよび一般的に使用されるフィールドをまとめたものです。

パイプラインの .yaml ファイルの設定

次の例では、事前チェックを実行し、手動承認を待ってから、アプリケーションをビルドしてデプロイする 3 つのタスクからなるパイプラインを定義します。

---
# パイプラインを送信して実行します。
kind: Pipeline
# 名前はグローバルに一意である必要があります。コミット ID とタイムスタンプを使用すると、一意性が保証されます。
name: "p-<% .git.shortCommitId %>-<% .currentTimestampMs %>"
description: 'demo pipeline'
spec:
  context:
    data:
      ## グローバルな DingTalk 通知設定。タスクごとの通知設定をオーバーライドします。
      ## 有効にするにはコメントを解除します。
      #dingdingNotification:
      #  enable: false
      #  skipOnSuccess: false
      #  webhook: https://oapi.dingtalk.com/robot/send?access_token=xxx
      #  secret: xxx
      #  message:
      #    at:
      #      isAtAll: false
      #      atUserIds: ["admin"]
      #      atMobiles: ["188xxxx8888"]
      #    msgtype: text
      #    text: |
      #      task finished.
      #      TaskName: {{ .currentTask.name }}
      #      Success: {{ .success }}
      #      Status: {{ .currentTask.status.phase }}
      # Serverless Application Center のアプリケーション名。トリガーされると自動的に提供されます。
      appName: <% .appName %>
      # Serverless Devs で使用される s.yaml ファイルへのパス。これはルートの s.yaml を参照します。
      deployFile: s.yaml
  # インラインタスク定義。Serverless Application Center は、組み込みのテンプレート記述をサポートしています。
  templateSpec:
    tasks:
    - name: pre-check
      context:
        data:
          displayName: "Pre-check"
          enable: true
          steps:
            - plugin: "@serverless-cd/checkout"
            - plugin: "@serverless-cd/s-setup"
            - run: s plan -t "${{ ctx.data.deployFile }}"
      taskTemplate: serverless-runner-task
      runAfters: []
    - name: pre-check-approval
      context:
        data:
          displayName: "Manual review"
          enable: true
      # need-approval は、レビュアーが Serverless Application Center コンソールで承認または拒否するまでパイプラインを一時停止する組み込みのタスクテンプレートです。
      taskTemplate: need-approval
      runAfters:
      - name: pre-check
    - name: build-and-deploy
      context:
        data:
          displayName: "Building and deployment"
          enable: true
          steps:
            - plugin: "@serverless-cd/checkout"
            - plugin: "@serverless-cd/s-setup"
            - run: s deploy -t "${{ ctx.data.deployFile }}" --use-local --assume-yes --skip-push
      taskTemplate: serverless-runner-task
      runAfters:
      - name: pre-check-approval
---

Git イベントがこのパイプラインをトリガーすると、Serverless Application Center は p-<% .git.shortCommitId %>-<% .currentTimestampMs %> というフォーマットで名前が付けられたパイプラインを生成し、次のタスクを順番に実行します。

1. 事前チェック — コードをチェックアウトし、Serverless Devs をセットアップし、s plan を実行して変更をプレビューします。

2. 手動レビュー — レビュアーがコンソールで承認するまでパイプラインを一時停止します。

3. ビルドとデプロイ — コードをチェックアウトし、Serverless Devs をセットアップし、s deploy を実行してアプリケーションをデプロイします。

tasks:
- name: task-a
  runAfters: []          # パイプラインがトリガーされるとすぐに開始します
- name: task-b
  runAfters:
  - name: task-a         # task-a が成功した後にのみ開始します
- name: task-c
  runAfters:
  - name: task-b         # task-b が成功した後にのみ開始します

- name: pre-check-approval
  context:
    data:
      displayName: "Manual review"
      enable: true
  taskTemplate: need-approval   # 組み込みの承認ゲート — ステップは不要です
  runAfters:
  - name: pre-check

事前定義変数

パイプラインがトリガーされると、Serverless Application Center はパイプラインを送信する前に、.yaml ファイル内の <% %> プレースホルダーを次の表の値に置き換えます。

次のステップ

• パイプラインの管理 — アプリケーションの作成時または環境の設定時に .yaml ファイルを指定または更新します