:カスタムタスクテンプレート

制御ポリシー機能の動作

Serverless Application Centerでのタスク実行フェーズ中に、システムはユーザー用のタスクワーカーをデプロイし、実行コンテキストをペイロードの一部としてタスクワーカーに渡します。 タスクワーカーからpayloadを受け取った後、システムはステップで定義された手順に基づいてタスクを実行します。

ユーザーは、コンテキスト内のrunnerConfigとステップを設定することにより、タスクワーカーのロジックをカスタマイズできます。

カスタムタスクテンプレートのサンプルコード

次のサンプルコードは、カスタムタスクテンプレートの例を示しています。 プリセットserverless-runnerはspec.worker.presetWorkerで指定でき、実行エンジンはタスクワーカーをスケジュールし、タスクワーカーでカスタマイズした手順を実行します。

kind: TaskTemplate
name: serverless-runner-task
description: ''
createdTime: '2023-04-11T08:43:58Z'
deletionTime:
generation: 0
labels:
  source: system
resourceVersion: 0
spec:
  description: |-
    Run customized scripts on a serverless runner.
    Run custom scripts on a serverless instance. 
  worker:
    # Set the runner type to the preset serverless-runner of Serverless Application Center. 
    # The execution engine of serverless-runner recognizes the configurations of runnerConfig and steps. 
    presetWorker: serverless-runner
  executeCondition:
    # The execution is performed only if the enable == true expression is specified. 
    expression: enable == true
  contextSchema: {}

パイプラインテンプレートでのカスタムタスクテンプレートの使用例

カスタムタスクテンプレートは、パイプラインテンプレートで使用できます。 次のサンプルコードに例を示します。

kind: PipelineTemplate
name: demo-template
spec:
  context:
    data:
      deployFile: s.yaml
      #  Configure the deployment settings of task workers. If you do not configure this section, the execution is performed in a sandbox of Serverless Application Center. 
      #  The runnerConfig settings that you configure here affect all tasks that are defined in the template. 
      #  runnerConfig:
      #  Specify the Singapore region. 
      #  regionId: ap-southeast-1
      #  Configure the logging feature. The generated logs are delivered to the specified Logstore of Simple Log Service. 
      #  logConfig:
      #    logstore: function-log
      #    project: my-project
      #  Configure network settings. That is, the information about the virtual private cloud (VPC). 
      #  vpcConfig:
      #    securityGroupId: xxx
      #    vSwitchIds: ["xxx"]
      #    vpcId: xxx
      #  Configure the instance specifications. Use a compute instance that is configured with 1 vCPU and 2 GB of memory. 
      #  cpu: 1
      #  memory: 2048
      #  Specify the timeout period of the server. In this example, the timeout period is set to 15 minutes. 
      #  timeout: 900
      #  Specify whether to enable the debug mode. The Function Compute function that corresponds to the runner is not reclaimed in a short period of time. We recommend that you do not enable the debug mode. 
      #  debugMode: true
      #  Configure environment variables for task workers. 
      #  environmentVariables:
      #  DEBUG: '*'
  tasks:
  # Build and deploy. 
  - name: build-and-deploy
    context:
      data:
        # Enable task execution. By default, task execution is disabled. 
        enable: true
        # You can declare or modify runnerConfig here. 
        # runnerConfig:
        # Specify the execution procedure. The engine provided by serverless-cd is used as an example in the following steps. 
        steps:
          # Check out the code. 
          # The plugin mechanism is used to run the plug-ins of serverless-cd. 
          # @serverless-cd/checkout is an open source plug-in that is used to check out code to the default path. 
          # Function Compute continues to contribute more plug-ins for the community. 
          - plugin: '@serverless-cd/checkout'
          - run: |
              echo "Setup Serverless Devs ing..."
              # Enable the debug mode and print command outputs. 
              set -x
              ls -al
              # aliyun cloud authentication infos.
              access_key_id=${{ sts.accessKeyId || "dummy-ak" }}
              access_key_secret=${{ sts.accessKeySecret || "dummy-sk" }}
              security_token=${{ sts.securityToken || "dummy-token" }}
              uid=${{ uid || "dummy-uid" }}
              # account info alias
              alias=my-account
              s --version
              if [[ $? -ne 0 ]]; then
              echo "Serverless Devs is not installed."
              exit 1
              fi
              s config add --AccessKeyID "${access_key_id}" --AccessKeySecret "${access_key_secret}" \
              --AccountID "${uid}" --SecurityToken "${security_token}" --access "${alias}" -f
              if [[ $? -ne 0 ]]; then
              echo "Failed to setup Serverless Devs."
              exit 1
              fi
              echo "Setup Serverless Devs success."
          # Run s-deploy. 
          - run: |
              echo "Deploy by Serverless Devs ing..."
              set -x
              alias=my-account
              deploy_file=${{ ctx.data.deployFile || "" }}
              if [[ -z "${deploy_file}" ]]; then
                if [[ -f "s.yaml" ]]; then
                  deploy_file="s.yaml"
                elif [[ -f "s.yml" ]]; then
                  deploy_file="s.yml"
                fi
              fi
              if [[ ! -f "${deploy_file}" ]]; then
                echo "Failed to find s.yaml file."
                exit 1
              fi
              echo "s.yaml file location: ${deploy_file}"
              s deploy --access "${alias}" -t "${deploy_file}" --use-local --assume-yes --skip-push
              echo "Deploy by Serverless Devs success."
    # Specify the serverless-runner-task that is built in template as the task template. 
    taskTemplate: serverless-runner-task
    # Specify the execution sequence. In this example, the execution is immediately triggered without relying on tasks. 
    runAfters: []
---

runnerConfigを使用してタスクワーカーを説明する

runnerConfigを設定すると、タスクワーカーは設定に基づいて現在のアカウントにデプロイされます。 runnerConfigを設定しない場合、タスクワーカーはAlibaba Cloudサンドボックスにデプロイされます。

{
    "DEBUG":"*"
}

ステップを使用してタスクワーカーの実行を説明する

タスクワーカーの実行方法を指定するには、ステップセクションの手順を設定する必要があります。 ステップセクションには複数のステップがあり、実行エンジンは各ステップを順番に実行します。 各ステップは、実行エンジンの独立したサブプロセスである。

コマンドタイプのステップ

コマンドタイプのステップを使用すると、シェルコマンドを使用してビルドの動作を記述できます。 シェルコマンドはテンプレート構文をサポートします。 区切り文字 ['${{', '}}'] を使用して、コンテキスト内の変数を取得できます。 たとえば、echo ${{ ctx.data.appName }} コマンドを実行して、現在のコンテキスト内のアプリケーションの名前を出力できます。

区切り文字 ['${{', '}}'] は、シェルコマンドの $構文とは無関係であることに注意してください。 runコマンドでは、${{ key }} コマンドと ${key} コマンドの実行が異なります。 前者のコマンドでは、テンプレート構文に基づいて現在のコンテキストから変数を取得できますが、後者のコマンドでは、シェル構文に基づいて現在のプロセスから環境変数を含む変数を取得できます。

{
"appName": "my-application"
}

{
"accessKeyId": "Lk89k****",
"accessKeySecret": "SEC******",
"securityToken":"KJHLS****"
}

{
    "debug":"*"
}

${{ steps['my-cache'].outputs['cache-hit'] != 'true' }}

プラグインタイプのステップ

プラグインは、Serverless Application Centerによって管理されます。 重複した複雑なビルド動作をプラグインに抽象化した後、コード行を記述せずに、プラグインの名前を宣言するだけで済みます。 たとえば、コードをチェックアウトする場合は、チェックアウトを完了するためにプラグインの名前を宣言するだけで済みます。 この例では、@ serverless-cd/checkoutが使用されます。

{
    "debug":"*"
}

{
  "key1": "value1",
  "key2": "value2"
}

${{ steps['my-cache'].outputs['cache-hit'] != 'true' }}

サポートされているプラグイン

• @ serverless-cd/checkout