4.6. 在 Developer 视角中使用 Red Hat OpenShift Pipelines

流程

1. 在 Developer 视角的 Add 视图中，点 Pipeline 标题查看 Pipeline Builder 页面。

2. 使用 Pipeline 构建器 视图或 YAML 视图配置管道。

   注意

   Pipeline 构建器 视图支持有限的字段，而 YAML 视图支持所有可用字段。（可选）您还可以使用 Operator 安装的、可重复使用的代码片断和样本来创建详细的管道。

   图 4.1. YAML 视图

   

   使用 Pipeline Builder 配置管道：

   1. 在 Name 字段中输入管道的唯一名称。

   2. 在 Tasks 部分中，从 Select Task 列表中选择一个任务，将任务添加到管道中。在本例中,使用 s2i-nodejs 任务。

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

      • 要为现有任务添加并行任务，请点击任务旁边显示的加号图标，从 Select Task 列表中选择您要添加到管道的并行任务。

        图 4.2. Pipeline Builder

        

   3. 在 Resources 部分，点 Add Resources 指定管道运行的资源的名称和类型。这些资源然后会被管道中的任务使用作为输入和输出。在此例中：

      1. 添加一个输入资源。在 Name 字段中输入 Source，从 Resource Type 下拉列表中选择 Git。

      2. 添加一个输出资源。在 Name 字段中输入 img，从 Resource Type 下拉列表中选择 Image。

         注意

         如果缺少资源，任务旁边会出现一个红色图标。

   4. 可选：任务的 Parameters 部分会根据任务的规格预先填充。如果需要，使用 Parameters 部分中的 Add Parameters 链接来添加额外的参数。
   5. 在 Workspaces 部分，点 Add workspace，并在 Name 字段中输入唯一工作区名称。您可以在管道中添加多个工作区。

   6. 在 Tasks 部分中，点 s2i-nodejs 任务，以查看带任务详情的侧面板。在任务侧面板中，为 s2i-nodejs 任务指定资源和参数：

      1. 如果需要，在 Parameters 部分，使用 $(params.<param-name>)语法为默认参数添加更多参数。
      2. 在 Image 部分中，按在 Resources 部分中的指定输入 Img。
      3. 从 Workspaces 部分下的 source 下拉菜单中选择一个工作区。
   7. 将资源、参数和工作空间添加到 openshift-client 任务。
3. 点 Create 在 Pipeline Details 页面中创建并查看管道。
4. 点 Actions 下拉菜单，然后点 Start，查看 Start Pipeline 页面。
5. Workspaces 部分列出了您之前创建的工作区。使用对应的下拉菜单为您的工作区指定卷源。您有以下选项： mpty Directory、Config Map、Secret、PersistentVolumeClaim 或 VolumeClaimTemplate。

流程

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

2. 点击所需管道查看 Pipeline 详情页面。

   默认情况下，Details 选项卡显示所有串行任务、并行任务、finally 任务以及管道中的 when 表达式的可视化表示。这些任务和 finally 的任务列在页面的右下角。点列出的 Tasks 和 Finally tasks 以查看任务详情。

   图 4.3. Pipeline 详情

   

3. 可选： 在 Pipeline 详情页面中，点 Metrics 选项卡查看有关管道的以下信息：

   • Pipeline 成功率
   • Pipeline 运行数量
   • 管道运行持续时间

   • 任务运行持续时间

     您可以使用这些信息来改进管道工作流，并在管道生命周期的早期解决问题。

4. 可选：点 YAML 选项卡编辑管道的 YAML 文件。

5. 可选：点 Pipeline Runs 选项卡查看已完成、正在运行或运行失败的管道。

   Pipeline Runs 选项卡提供有关管道运行、任务状态以及调试失败管道运行的链接。您可以使用 Options 菜单 来停止正在运行的管道，使用与之前的管道执行相同的参数和资源重新运行管道，或删除管道运行。

   • 点所需的管道运行查看 Pipeline Run details 页面。默认情况下，Details 选项卡显示所有串行任务、并行任务、finally 任务以及管道中运行的 when 表达式的可视化表示。成功运行的结果会显示在页面底部的 Pipeline Run 结果窗格下。

     注意

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

   • 在 Pipeline Run details 页面中，点 Task Runs 选项卡查看已完成、正在运行和运行失败的任务。

     Task Runs 选项卡提供有关任务运行的信息，以及任务和 pod 的链接，以及任务运行的状态和持续时间。使用 Options 菜单 来删除任务运行。

   • 点所需的任务运行查看 Task Run details 页面。成功运行的结果显示在页面底部的 Task Run 结果窗格下。

     注意

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

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

流程

1. 以集群管理员身份登录 OpenShift Container Platform Web 控制台。

2. 在 Administrator 视角中，使用左侧导航面板进入 Pipelines 部分。

   1. 从 Project 下拉菜单中，选择 openshift 项目。这可确保在 openshift 命名空间中执行后续步骤。

   2. 从可用管道列表中选择适合构建和部署应用程序的管道。例如，如果您的应用程序需要 node.js 运行时环境，请选择 s2i-nodejs 管道。

      注意

      不要编辑默认管道模板。它可能变得与 UI 和后端不兼容。

   3. 在所选管道的 YAML 标签页下，点 Download 并将 YAML 文件保存到本地机器中。如果自定义配置文件失败，您可以使用这个副本来恢复正常工作的配置。

3. 禁用（删除）默认管道模板：

   1. 使用左侧导航面板进入 Operators Installed Operators。
   2. 点 Red Hat OpenShift Pipelines Tekton Configuration 标签页 config YAML 标签页。

   3. 要禁用（删除） openshift 命名空间中的默认管道模板，在 TektonConfig 自定义资源 YAML 中将 pipelineTemplates 参数设置为 false，并将它保存。

      apiVersion: operator.tekton.dev/v1alpha1
      kind: TektonConfig
      metadata:
        name: config
      spec:
      profile: all
      targetNamespace: openshift-pipelines
      addon:
        params:
        - name: clusterTasks
          value: "true"
        - name: pipelineTemplates
          value: "false"
      ...

      注意

      如果手动删除默认管道模板，Operator 将在升级过程中恢复默认值。

      警告

      作为集群管理员，您可以在 Operator 配置中禁用默认管道模板安装。但是，此类配置将禁用（删除）所有默认管道模板，而不仅仅是您要自定义的模板。

4. 创建自定义管道模板：

   1. 使用左侧导航面板进入 Pipelines 部分。
   2. 在 Create 下拉列表中选择 Pipeline。

   3. 在 openshift 命名空间中创建所需的管道。为它指定不同于默认名称（如 custom-nodejs）的名称。您可以使用下载的默认管道模板作为起点并进行自定义。

      注意

      因为 openshift 是 Operator 安装的管道模板使用的默认命名空间，所以您必须在 openshift 命名空间中创建自定义管道模板。当应用程序使用管道模板时，模板会自动复制到对应项目的命名空间。

   4. 在创建的管道的 Details 标签页下，确保自定义模板中的 Labels 与默认管道中的标签匹配。自定义管道模板必须具有应用程序的运行时、类型和策略的正确标签。例如，部署在 OpenShift Container Platform 上的 node.js 应用程序所需的标签如下：

      ...
      pipeline.openshift.io/runtime: nodejs
      pipeline.openshift.io/type: openshift
      ...

      注意

      您只能将一个管道模板用于每个运行时环境和部署类型的组合。

5. 在 Developer 视角中，使用 +Add Git Repository From Git 选项选择您要创建和部署的应用程序类型。根据应用程序所需的运行时和类型，自动选择您的自定义模板。

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 服务器或镜像 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 Credentials，请指定您要进行身份验证的 Registry 服务器地址，并通过Username、Password 和 Email 项中提供您的凭证。

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

         • 如果 Authentication Type 为 Basic Authentication，在 UserName 和 Password or Token 项中指定相关的值。

         • 如果 Authentication Type 为 SSH Keys 时，在 SSH Private Key 字段中指定相关的值。

           注意

           对于基本身份验证和 SSH 身份验证，您可以使用注解，例如：

           • tekton.dev/git-0: https://github.com
           • tekton.dev/git-1: https://gitlab.com.
      4. 选择要添加 secret 的检查标记。

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

4. 点 Start 启动管道。

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

   • 将鼠标悬停在任务上，以查看执行每一步骤所需时间。
   • 点一个任务来查看任务中每一步骤的日志。
   • 点 Logs 选项卡查看与任务执行顺序相关的日志。您还可以使用相关按钮扩展窗格，单独或批量下载日志。

   • 点 Events 选项卡查看管道运行生成的事件流。

     您可以使用 Task Runs、Logs 和 Events 选项卡来帮助调试失败的管道运行或失败的任务运行。

     图 4.4. Pipeline 运行详情

     

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

   注意

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

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

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

      图 4.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 以确认删除。