Pipelines

流程

1. 在控制台的 Administrator 视角中，导航到 Operators → OperatorHub。

2. 使用 Filter by keyword 复选框在目录中搜索 Red Hat OpenShift Pipelines Operator。点 OpenShift Pipelines Operator。

   注意

   确保您没有选择 OpenShift Pipelines Operator 的 Community 版本。

3. 参阅 Red Hat OpenShift Pipelines Operator 页中有关 Operator 的简单描述。点击 Install。

4. 在 Install Operator 页面中：

   1. 为 Installation Mode 选择 All namespaces on the cluster (default)。选择该项会将 Operator 安装至默认openshift-operators 命名空间，这将启用 Operator 以进行监视并在集群中的所有命名空间中可用。
   2. 为 Approval Strategy 选择 Automatic。这样可确保以后对 Operator 的升级由 Operator Lifecycle Manager (OLM) 自动进行。如果您选择 Manual 批准策略，OLM 会创建一个更新请求。作为集群管理员，您必须手动批准 OLM 更新请求，才可将 Operator 更新至新版本。

   3. 选择一个 Update Channel。

      • ocp-<4.x> 频道将启用 Red Hat OpenShift Pipelines Operator 最新稳定版本的安装。
      • preview3 频道启用 Red Hat OpenShift Pipelines Operator 的最新预览版本，该版本可能包含 4.x 更新频道中还未提供的功能。

5. 点击 Install。您会看到 Installed Operators 页面中列出的 Operator。

   注意

   Operator 会自动安装到 openshift-operators 命名空间中。

6. 检查 Status 是否已被设置为 Succeeded Up to date 来确认 Red Hat OpenShift Pipelines Operator 已安装成功。

流程

1. 创建一个订阅对象 YAML 文件，以便为 Red Hat OpenShift Pipelines Operator 订阅一个命名空间，如 sub.yaml：

   订阅示例

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: openshift-pipelines-operator
     namespace: openshift-operators
   spec:
     channel:  <channel name> 1
     name: openshift-pipelines-operator-rh 2
     source: redhat-operators 3
     sourceNamespace: openshift-marketplace 4

   1

   指定您要订阅 Operator 的频道名称

   2

   要订阅的 Operator 的名称。

   3

   提供 Operator 的 CatalogSource 的名称。

   4

   CatalogSource 的命名空间。将 openshift-marketplace 用于默认的 OperatorHub CatalogSource。

2. 创建订阅对象：

   $ oc apply -f sub.yaml

   Red Hat OpenShift Pipelines Operator 现在安装在默认目标命名空间 openshift-operators 中。

流程

1. 在 Web 控制台的 Administrator 视角中，导航至 Administration → Custom Resource Definition。
2. 在 Filter by name 框中键入 config.operator.tekton.dev 来搜索 Red Hat OpenShift Pipelines Operator CR。
3. 点击 CRD Config 查看 Custom Resource Definition Details 页面。

4. 点击 Actions 下拉菜单并选择 Delete Custom Resource Definition。

   注意

   删除 CR 将删除 Red Hat OpenShift Pipelines 组件，并丢失集群上的所有任务和管道。

5. 点击 Delete 以确认删除 CR。

流程

1. 在 Operators → OperatorHub 页面中，使用 Filter by keyword 复选框来搜索 Red Hat OpenShift Pipelines Operator。
2. 点 OpenShift Pipelines Operator。Operator 标题表示已安装该 Operator。
3. 在 OpenShift Pipelines Operator 描述符页面中，点击 Uninstall。

流程

1. 登录您的 OpenShift Container Platform 集群：

   $ oc login -u <login> -p <password> https://openshift.example.com:6443

2. 为示例应用程序创建一个项目。在本例中，创建 pipelines-tutorial 项目：

   $ oc new-project pipelines-tutorial

   注意

   如果您使用其他名称创建项目，请确定使用您的项目名称更新示例中使用的资源 URL。

3. 检查 pipeline ServiceAccount：

   Red Hat OpenShift Pipelines Operator 添加并配置一个名为 pipeline 的 ServiceAccount，它有足够的权限来构建和推送镜像。这个 ServiceAccount 由 PipelineRun 使用。

   $ oc get serviceaccount pipeline

流程

1. 从 pipelines-tutorial 仓库中安装 apply-manifests 和 update-deployment Task 资源，其中包含管道的可重复使用任务列表：

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/01_apply_manifest_task.yaml
   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/02_update_deployment_task.yaml

2. 使用 tkn task list 命令列出您创建的任务：

   $ tkn task list

   输出会确认创建了 apply-manifests 和 update-deployment 任务：

   NAME                DESCRIPTION   AGE
   apply-manifests                   1 minute ago
   update-deployment                 48 seconds ago

3. 使用 tkn clustertasks list 命令列出由 Operator 安装的额外 ClusterTask 资源，例如--buildah 和 s2i-python-3：

   注意

   您必须使用特权 pod 容器来运行 buildah ClusterTask 资源，因为它需要特权安全上下文。如需了解更多有关 pod 安全性上下文约束（SCC）的信息，请参阅附加资源部分。

   $ tkn clustertasks list

   输出列出了 Operator 安装的 ClusterTask 资源：

   NAME                       DESCRIPTION   AGE
   buildah                                  1 day ago
   git-clone                                1 day ago
   s2i-php                                  1 day ago
   tkn                                      1 day ago

流程

1. 复制以下 Pipeline YAML 文件示例内容并保存：

   apiVersion: tekton.dev/v1beta1
   kind: Pipeline
   metadata:
     name: build-and-deploy
   spec:
     workspaces:
     - name: shared-workspace
     params:
     - name: deployment-name
       type: string
       description: name of the deployment to be patched
     - name: git-url
       type: string
       description: url of the git repo for the code of deployment
     - name: git-revision
       type: string
       description: revision to be used from repo of the code for deployment
       default: "release-tech-preview-3"
     - name: IMAGE
       type: string
       description: image to be built from the code
     tasks:
     - name: fetch-repository
       taskRef:
         name: git-clone
         kind: ClusterTask
       workspaces:
       - name: output
         workspace: shared-workspace
       params:
       - name: url
         value: $(params.git-url)
       - name: subdirectory
         value: ""
       - name: deleteExisting
         value: "true"
       - name: revision
         value: $(params.git-revision)
     - name: build-image
       taskRef:
         name: buildah
         kind: ClusterTask
       params:
       - name: TLSVERIFY
         value: "false"
       - name: IMAGE
         value: $(params.IMAGE)
       workspaces:
       - name: source
         workspace: shared-workspace
       runAfter:
       - fetch-repository
     - name: apply-manifests
       taskRef:
         name: apply-manifests
       workspaces:
       - name: source
         workspace: shared-workspace
       runAfter:
       - build-image
     - name: update-deployment
       taskRef:
         name: update-deployment
       workspaces:
       - name: source
         workspace: shared-workspace
       params:
       - name: deployment
         value: $(params.deployment-name)
       - name: IMAGE
         value: $(params.IMAGE)
       runAfter:
       - apply-manifests

   Pipeline 定义提取 Git 源存储库和镜像 registry 的特定内容。当一个 Pipeline 被触发并执行时，这些详细信息会作为 params 添加。

2. 创建 Pipeline:

   $ oc create -f <pipeline-yaml-file-name.yaml>

   或者，还可以从 Git 存储库直接执行 YAML 文件：

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/04_pipeline.yaml

3. 使用 tkn pipeline list 命令来验证是否在应用程序中添加了 Pipeline:

   $ tkn pipeline list

   检查输出来验证创建了 build-and-deploy Pipeline:

   NAME               AGE            LAST RUN   STARTED   DURATION   STATUS
   build-and-deploy   1 minute ago   ---        ---       ---        ---

流程

1. 启动后端应用程序的管道：

   $ tkn pipeline start build-and-deploy \
       -w name=shared-workspace,volumeClaimTemplateFile=https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/03_persistent_volume_claim.yaml \
       -p deployment-name=vote-api \
       -p git-url=http://github.com/openshift-pipelines/vote-api.git \
       -p IMAGE=image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/vote-api \

   上一命令使用卷声明模板，该模板为管道执行创建持久性卷声明。

2. 要跟踪管道运行的进度，请输入以下命令：

   $ tkn pipelinerun logs <pipelinerun_id> -f

   上述命令中的 <pipelinerun_id> 是上一命令输出返回的 PipelineRun 的 ID。

3. 启动前端应用程序的 Pipeline：

   $ tkn pipeline start build-and-deploy \
       -w name=shared-workspace,volumeClaimTemplateFile=https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/01_pipeline/03_persistent_volume_claim.yaml \
       -p deployment-name=vote-ui \
       -p git-url=http://github.com/openshift-pipelines/vote-ui.git \
       -p IMAGE=image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/vote-ui \

4. 要跟踪管道运行的进度，请输入以下命令：

   $ tkn pipelinerun logs <pipelinerun_id> -f

   上述命令中的 <pipelinerun_id> 是上一命令输出返回的 PipelineRun 的 ID。

5. 几分钟后，使用 tkn pipelinerun list 命令列出所有 PipelineRuns 来验证 Pipeline 是否成功运行：

   $ tkn pipelinerun list

   输出中列出了 PipelineRuns:

    NAME                         STARTED      DURATION     STATUS
    build-and-deploy-run-xy7rw   1 hour ago   2 minutes    Succeeded
    build-and-deploy-run-z2rz8   1 hour ago   19 minutes   Succeeded

6. 获取应用程序路由：

   $ oc get route vote-ui --template='http://{{.spec.host}}'

   记录上一个命令的输出。您可以使用此路由来访问应用程序。

7. 要重新运行最后的管道运行,请使用上一管道的管道资源和服务帐户运行：

   $ tkn pipeline start build-and-deploy --last

流程

1. 复制以下 TriggerBinding YAML 示例文件的内容并保存：

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: TriggerBinding
   metadata:
     name: vote-app
   spec:
     params:
     - name: git-repo-url
       value: $(body.repository.url)
     - name: git-repo-name
       value: $(body.repository.name)
     - name: git-revision
       value: $(body.head_commit.id)

2. 创建 TriggerBinding 资源：

   $ oc create -f <triggerbinding-yaml-file-name.yaml>

   或者，您可以直接从 pipelines-tutorial Git 仓库创建 TriggerBinding 资源：

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/03_triggers/01_binding.yaml

3. 复制以下 TriggerTemplate YAML 示例文件的内容并保存：

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: TriggerTemplate
   metadata:
     name: vote-app
   spec:
     params:
     - name: git-repo-url
       description: The git repository url
     - name: git-revision
       description: The git revision
       default: release-tech-preview-3
     - name: git-repo-name
       description: The name of the deployment to be created / patched
   
     resourcetemplates:
     - apiVersion: tekton.dev/v1beta1
       kind: PipelineRun
       metadata:
         name: build-deploy-$(tt.params.git-repo-name)-$(uid)
       spec:
         serviceAccountName: pipeline
         pipelineRef:
           name: build-and-deploy
         params:
         - name: deployment-name
           value: $(tt.params.git-repo-name)
         - name: git-url
           value: $(tt.params.git-repo-url)
         - name: git-revision
           value: $(tt.params.git-revision)
         - name: IMAGE
           value: image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/$(tt.params.git-repo-name)
         workspaces:
         - name: shared-workspace
           volumeClaimTemplate:
             spec:
               accessModes:
                 - ReadWriteOnce
               resources:
                 requests:
                   storage: 500Mi

   模板指定一个卷声明模板，用于创建用于为工作空间定义存储卷的持久性卷声明。因此，您不需要创建持久性卷声明来提供数据存储。

4. 创建 TriggerTemplate 资源：

   $ oc create -f <triggertemplate-yaml-file-name.yaml>

   另外，您还可以从 pipelines-tutorial Git 仓库直接创建 TriggerTemplate 资源：

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/03_triggers/02_template.yaml

5. 复制以下 Trigger YAML 示例文件的内容并保存：

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: Trigger
   metadata:
     name: vote-trigger
   spec:
     serviceAccountName: pipeline
     bindings:
       - ref: vote-app
     template:
        name: vote-app

6. 创建 Trigger 资源：

   $ oc create -f <trigger-yaml-file-name.yaml>

   另外，您还可以直接从 pipelines-tutorial Git 仓库创建 Trigger 资源：

   $ oc create -f https://github.com/openshift/pipelines-tutorial/blob/release-tech-preview-3/03_triggers/03_trigger.yaml

7. 复制以下 EventListener YAML 示例文件的内容并保存：

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: EventListener
   metadata:
     name: vote-app
   spec:
     serviceAccountName: pipeline
     triggers:
       - triggerRef: vote-trigger

   或者，如果您还没有定义触发器自定义资源，将绑定和模板规格添加到 EventListener YAML 文件中，而不是引用触发器的名称：

   apiVersion: triggers.tekton.dev/v1alpha1
   kind: EventListener
   metadata:
     name: vote-app
   spec:
     serviceAccountName: pipeline
     triggers:
     - bindings:
       - ref: vote-app
       template:
         name: vote-app

8. 创建 EventListener 资源：

   $ oc create -f <eventlistener-yaml-file-name.yaml>

   或者，您可以直接从 pipelines-tutorial Git 仓库创建 EvenListener 资源：

   $ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/release-tech-preview-3/03_triggers/04_event_listener.yaml

9. 将 EventListener 服务公开为 OpenShift Container Platform 路由，使其可以被公开访问：

   $ oc expose svc el-vote-app

流程

1. 获取 Webhook URL:

   $ echo "URL: $(oc  get route el-vote-app --template='http://{{.spec.host}}')"

   记录下输出中的 URL。

2. 在前端存储库中手动配置 Webhook:

   1. 在浏览器中打开前端 Git 存储库 vote-ui。
   2. 点 Settings → Webhooks → Add Webhook

   3. 在 Webhooks/Add Webhook 页面中：

      1. 在 Payload URL 字段中输入第一步中的 Webhook URL
      2. 为 Content type 选择 application/json
      3. 在 Secret 字段中指定 secret
      4. 确定选择了 Just the push event
      5. 选择 Active
      6. 点击 Add webhook。
3. 重复步骤 2 来设置后端存储库 vote-api。

流程

1. 在终端中，克隆 Git 存储库 vote-api 的副本：

   $ git clone git@github.com:<your GitHub ID>/vote-ui.git -b release-tech-preview-3

2. 推送空提交：

   $ git commit -m "empty-commit" --allow-empty && git push origin release-tech-preview-3

3. 检查管道运行是否已触发：

   $ tkn pipelinerun list

   请注意，一个新的管道运行被启动。

流程

1. 在 Developer 视角的 Add 视图中，点 Pipeline 标题查看 Pipeline Builder 页面。
2. 为 Pipeline 输入唯一名称。

3. 从 Select task 列表中选择一个任务来把它添加到 Pipeline。这个示例使用 s2i-nodejs 任务。

   1. 要为 Pipeline 添加后续任务，点任务右侧或左边的加号图标，从 Select task 列表中选择您要添加到管道的任务。在本例中，使用 s2i-nodejs 任务右侧的加号图标来添加 openshift-client 任务。

   2. 要为现有任务添加并行任务，点任务下面的加号图标，从 Select Task 列表中选择您要添加到管道的并行任务。

      图 5.1. Pipeline Builder

      

4. 点 Add Resources 来指定 Pipeline Run 将要使用的资源的名称和类型。这些资源然后会被 Pipeline 中的任务使用作为输入和输出。在此例中：

   1. 添加一个输入资源。在 Name 字段中输入 Source，从 Resource Type 下拉列表中选择 Git。
   2. 添加一个输出资源。在 Name 字段中输入 img，从 Resource Type 下拉列表中选择 Image。
5. 一个任务的 Parameters 会根据任务的规格预先填充。如果需要，使用 Add Parameters 链接来添加额外的参数。

6. 如果没有指定任务的资源，则会在任务中显示 Missing Resources 警告。点 s2i-nodejs 任务，在侧面板中查看任务的详情。

   图 5.2. Pipelines Builder 中的任务详情

   

7. 在任务侧面板中为其指定资源和参数：

   1. 在 Input Resources → Source 部分中, Select Resources 下拉列表显示添加到管道中的资源。在本例中，选择 Source。
   2. 在 Output Resources → Image 部分，点 Select Resources 列表，然后选择 img。
   3. 如果需要，在 Parameters 项中，使用 $(params.<param-name>) 语法在默认参数外添加更多参数。
8. 同样，为 openshift-client 任务添加输入资源。
9. 点 Create 创建管道。Pipeline Details 页会被显示，其中显示了创建的管道的详情。
10. 点 Actions 下拉菜单，然后点 Start 启动管道。

流程

1. 在 Developer 视角的 Pipelines 视图中，从 Project 下拉列表中选择一个项目，以查看该项目中的 Pipelines。

   图 5.3. Developer 视角中的 pipelines 视图

   
2. 点所需 Pipeline 查看 Pipeline Details 页面。这个页显示 Pipeline 中所有串行和并行任务。这些任务也列在页面的右下角。您可以点击列出的 任务来查看具体任务的详情。

3. 另外，在 Pipeline Details 页面中：

   • 点 YAML 选项卡编辑 Pipeline 的 YAML 文件。

   • 点击 Pipeline Runs 标签页，查看完成、正在运行或运行失败的管道。

     注意

     Pipeline Run Details 页面的 Details 部分显示失败管道运行的日志片段。日志片断 提供一般错误信息和日志片断。Logs 部分的链接可让您快速访问失败运行的详细信息。日志片断也会显示在 Task Run Details 页面的 Details 部分。

     您可以使用 Options 菜单 来停止正在运行的管道，使用与之前的管道执行相同的参数和资源重新运行管道，或删除管道运行。

   • 点 Parameters 标签，查看管道中定义的参数。您还可以根据需要添加或者编辑附加参数。
   • 点 Resources 标签页，查看管道中定义的资源。您还可以根据需要添加或编辑附加资源。

1. 在 Developer 视角 的 Pipelines 视图中，点附加到 Pipeline 的 Options 菜单，然后选择 Start。

2. Start Pipeline 对话框显示 Git Resources 以及基于管道定义的 Image Resources。

   注意

   对于使用 From Git 选项创建的管道，Start Pipeline 对话框也会在 Parameters 部分显示 APP_NAME 字段，对话框中的所有字段都由管道模板预先填充。

   1. 如果您在命名空间中有资源，Git Resources 和 Image Resources 字段会预先填充这些资源。如果需要，使用下拉菜单选择或创建所需资源并自定义管道运行实例。

3. 可选：修改 Advanced Options 并添加凭证以验证指定的私有 Git 服务器或 Docker registry。

   1. 在 Advanced Options 下，点 Show Credentials Options 并选择 Add Secret。

   2. 在 Create Source Secret 部分，指定以下内容：

      1. secret 的唯一 Secret Name。
      2. 在 要被验证的指定供应商 部分，在 Access to 字段中指定要验证的供应商，以及基本 服务器 URL。

      3. 选择 Authentication Type 并提供凭证：

         • 对于 Authentication Type Image Registry Crendentials，请指定您要进行身份验证的 Registry 服务器地址，并通过Username、Password 和 Email 项中提供您的凭证。

           如果要指定额外的 Registry 服务器地址，选择 Add Credentials 。

         • 如果 Authentication Type 为 Basic Authentication，在 UserName 和 Password or Token 项中指定相关的值。
         • 如果 Authentication Type 为 SSH Keys 时，在 SSH Private Key 字段中指定相关的值。
      4. 选择要添加 secret 的检查标记。

   您可以根据 Pipeline 中的资源数量添加多个 secret。

4. 点 Start 启动 PipelineRun。

5. Pipeline Run Details 页面显示正在执行的 Pipeline。Pipeline 启动后，每个任务中的任务和步骤都会被执行。您可以：

   • 将鼠标悬停在任务上，以查看执行每个步骤所需时间。
   • 点击一个任务来查看任务中的每个步骤的日志。

   • 点 Logs 选项卡，根据任务的执行顺序查看日志，并使用 Download 按钮将日志下载到文本文件中。

     图 5.4. Pipeline 运行

     

6. 对于使用 From Git 选项创建的管道，您可以在启动后使用 Topology 视图来与管道进行交互：

   注意

   要使用 Pipeline Builder 在 Topology 视图中查看创建的 Pipeline，自定义 Pipeline 标识来把 Pipeline 与应用程序负载相连接。

   1. 在左侧导航面板中，点 Topology，然后点应用程序来查看在侧面面板中列出的 Pipeline Run。

   2. 在 Pipeline Runs 部分,点击 Start Last Run 来启动一个新的 Pipeline 运行，使用与前一个相同的参数和资源。如果没有启动 Pipeline Run，这个选项会被禁用。

      图 5.5. Topology 视图中的管道

      

   3. 在 Topology 页面中，把鼠标移到应用程序的左侧，以查看应用程序的管道运行状态。

      注意

      当管道在特定任务运行时失败时，Topology 页面中的应用程序节点的侧面板会显示一个日志片段。您可以在 Pipeline Runs 部分的 Resources 选项卡中查看日志片断。日志片断 提供一般错误信息和日志片断。Logs 部分的链接可让您快速访问失败运行的详细信息。

流程

1. 在 Developer 视角的 Pipelines 视图中，选择您要编辑的管道来查看 Pipeline 的详情。在 Pipeline Details 页中，点 Actions 并选择 Edit Pipeline。

2. 在 Pipeline Builder 页中：

   • 您可以将任务、参数或资源添加到管道。
   • 您可以点要修改的任务来查看侧面面板中的任务详情，并修改所需的任务详情，如显示名称、参数和资源。
   • 或者，要删除此任务，点任务，在侧面面板中点 Actions，并选择 Remove Task。
3. 点 Save 来保存修改的管道。

流程

1. 在 Developer 视角 的 Pipelines 视图中，点附加到 Pipeline 的 Options 菜单，然后选择 Delete Pipeline。
2. 在 Delete Pipeline 确认提示下，点 Delete 以确认删除。