4.9. 在 web 控制台中使用 Red Hat OpenShift Pipelines
您可以使用 Administrator 或 Developer 视角从 OpenShift Container Platform Web 控制台中的 Pipelines 页面创建和修改 Pipeline
、PipelineRun
和 Repository
对象。您还可以使用 web 控制台的 Developer 视角中的 +Add 页面为软件交付过程创建 CI/CD 管道。
4.9.1. 在 Developer 视角中使用 Red Hat OpenShift Pipelines
在 Developer 视角中,您可以从 +Add 页面访问以下选项来创建管道:
-
使用 +Add
Pipelines Pipeline builder 选项为您的应用程序创建自定义管道。 -
使用 +Add
From Git 选项,在创建应用程序时使用管道模板和资源创建管道。
在为应用程序创建管道后,可以在 Pipelines 视图中查看并以视觉化的形式与部署进行交互。您还可以使用 Topology 视图与使用 From Git 选项创建的管道交互。您需要将自定义标识应用到使用 Pipeline builder 创建的管道,以便在 Topology 视图中查看它。
先决条件
- 您可以访问 OpenShift Container Platform 集群,并切换到 Developer 视角。
- 在集群中安装了 Pipelines Operator。
- 您是集群管理员,或是有创建和编辑权限的用户。
- 您已创建了一个项目。
4.9.2. 使用 Pipeline 构建器构建管道
在控制台的 Developer 视角中,您可以使用 +Add
- 使用 Pipeline 构建器 或 YAML 视图 配置管道。
- 使用现有任务和集群任务构建管道流。安装 OpenShift Pipelines Operator 时,它会在集群中添加可重复使用的管道集群任务。
- 指定管道运行所需的资源类型,如有必要,将额外参数添加到管道。
- 引用管道中的每个任务中的这些管道资源作为输入和输出资源。
- 如果需要,引用任务中添加至管道的任何额外参数。任务的参数会根据任务的规格预先填充。
- 使用 Operator 安装的、可重复使用的片断和示例来创建详细的管道。
流程
- 在 Developer 视角的 Add 视图中,点 Pipeline 标题查看 Pipeline Builder 页面。
使用 Pipeline 构建器 视图或 YAML 视图配置管道。
注意Pipeline 构建器 视图支持有限的字段,而 YAML 视图支持所有可用字段。(可选)您还可以使用 Operator 安装的、可重复使用的代码片断和样本来创建详细的管道。
图 4.1. YAML 视图
使用 Pipeline 构建器配置管道:
- 在 Name 字段中输入管道的唯一名称。
在 Tasks 部分:
- 单击 Add task。
- 使用快速搜索字段搜索任务,然后从显示的列表中选择所需的任务。
点击 Add 或 Install and add。在本例中,使用 s2i-nodejs 任务。
注意搜索列表包含集群中可用的所有 Tekton Hub 任务和任务。此外,如果某一任务已经安装,它将显示 Add 添加该任务,而它将显示 Install and add 以安装和添加该任务。当使用更新的版本添加相同的任务时,它将显示 Update and add。
在管道中添加后续任务:
-
点击任务右侧或左侧的加号图标
点 Add task。 - 使用快速搜索字段搜索任务,然后从显示的列表中选择所需的任务。
点击 Add 或 Install and add。
图 4.2. Pipeline 构建器
-
点击任务右侧或左侧的加号图标
添加最后一项任务:
-
点 Add finally task
Click Add task。 - 使用快速搜索字段搜索任务,然后从显示的列表中选择所需的任务。
- 点击 Add 或 Install and add。
-
点 Add finally task
在 Resources 部分,点 Add Resources 指定管道运行的资源的名称和类型。这些资源然后会被管道中的任务使用作为输入和输出。在此例中:
-
添加一个输入资源。在 Name 字段中输入
Source
,从 Resource Type 下拉列表中选择 Git。 添加一个输出资源。在 Name 字段中输入
img
,从 Resource Type 下拉列表中选择 Image。注意如果缺少资源,任务旁边会出现一个红色图标。
-
添加一个输入资源。在 Name 字段中输入
- 可选:任务的 Parameters 部分会根据任务的规格预先填充。如果需要,使用 Parameters 部分中的 Add Parameters 链接来添加额外的参数。
- 在 Workspaces 部分,点 Add workspace,并在 Name 字段中输入唯一工作区名称。您可以在管道中添加多个工作区。
在 Tasks 部分中,点 s2i-nodejs 任务,以查看带任务详情的侧面板。在任务侧面板中,为 s2i-nodejs 任务指定资源和参数:
- 如果需要,在 Parameters 部分,使用 $(params.<param-name>)语法为默认参数添加更多参数。
-
在 Image 部分中,按在 Resources 部分中的指定输入
Img
。 - 从 Workspaces 部分下的 source 下拉菜单中选择一个工作区。
- 将资源、参数和工作空间添加到 openshift-client 任务。
- 点 Create 在 Pipeline Details 页面中创建并查看管道。
- 点 Actions 下拉菜单,然后点 Start,查看 Start Pipeline 页面。
- Workspaces 部分列出了您之前创建的工作区。使用对应的下拉菜单为您的工作区指定卷源。您有以下选项: mpty Directory、Config Map、Secret、PersistentVolumeClaim 或 VolumeClaimTemplate。
4.9.3. 创建 OpenShift Pipelines 和应用程序
要与应用程序一同创建管道,使用 Developer 视角的 Add+ 视图中的 From Git 选项。您可以查看所有可用的管道,并在导入代码或部署镜像时选择用来创建应用程序的管道。
Tekton Hub 集成默认是启用的,您可以看到集群支持的 Tekton Hub 中的任务。管理员可以选择不使用 Tekton Hub 集成,将不会显示 Tekton Hub 任务。您还可以检查是否为生成的管道存在 webhook URL。为使用 +Add 流创建的管道添加默认 Webhook,URL 在 Topology 视图中所选资源侧面面板中可见。
如需更多信息,请参阅使用 Developer 视角创建应用程序。
4.9.4. 使用 Developer 视角与管道交互
开发者视角中的 Pipelines 视图列出了项目中的所有管道,以及以下详细信息:
- 创建管道的命名空间
- 最后一次管道运行
- 管道运行中的任务状态
- 管道运行的状态
- 最后一次管道运行的创建时间
流程
- 在 Developer 视角的 Pipelines 视图中,从 Project 下拉列表中选择一个项目,以查看该项目中的管道。
点击所需管道查看 Pipeline 详情页面。
默认情况下,Details 选项卡显示所有串行任务、并行任务、
finally
任务以及管道中的 when 表达式的可视化表示。这些任务和finally
的任务列在页面的右下角。点列出的 Tasks 和 Finally tasks 以查看任务详情。图 4.3. Pipeline 详情
可选: 在 Pipeline 详情页面中,点 Metrics 选项卡查看有关管道的以下信息:
- Pipeline 成功率
- Pipeline 运行数量
- 管道运行持续时间
任务运行持续时间
您可以使用这些信息来改进管道工作流,并在管道生命周期的早期解决问题。
- 可选:点 YAML 选项卡编辑管道的 YAML 文件。
可选:点 Pipeline Runs 选项卡查看已完成、正在运行或运行失败的管道。
Pipeline Runs 选项卡提供有关管道运行、任务状态以及调试失败管道运行的链接。您可以使用 Options 菜单 来停止正在运行的管道,使用与之前的管道执行相同的参数和资源重新运行管道,或删除管道运行。
点所需的管道运行查看 Pipeline Run details 页面。默认情况下,Details 选项卡显示所有串行任务、并行任务、
finally
任务以及管道中运行的 when 表达式的可视化表示。成功运行的结果会显示在页面底部的 Pipeline Run 结果窗格下。另外,您只能查看由集群支持的 Tekton Hub 中的任务。在查看某个任务时,您可以点击相关链接来跳至任务文档。注意Pipeline Run Details 页面的 Details 部分显示失败管道运行的日志片段。日志片断 提供一般错误信息和日志片断。Logs 部分的链接可让您快速访问失败运行的详细信息。
在 Pipeline Run details 页面中,点 Task Runs 选项卡查看已完成、正在运行和运行失败的任务。
Task Runs 选项卡提供有关任务运行的信息,以及任务和 pod 的链接,以及任务运行的状态和持续时间。使用 Options 菜单 来删除任务运行。
点所需的任务运行查看 Task Run details 页面。成功运行的结果显示在页面底部的 Task Run 结果窗格下。
注意Task Run details 页面的 Details 部分显示失败任务运行的日志片段。日志片断 提供一般错误信息和日志片断。Logs 部分的链接可让您快速访问失败的任务运行的详细信息。
- 点 Parameters 标签,查看管道中定义的参数。您还可以根据需要添加或者编辑附加参数。
- 点 Resources 标签页,查看管道中定义的资源。您还可以根据需要添加或编辑附加资源。
4.9.5. 从 Pipelines 视图启动管道
创建管道后,您需要启动它以在定义的顺序中执行包含的任务。您可从 Pipelines 视图、Pipeline Details 页面或 Topology 视图启动管道。
流程
使用 Pipelines 视图启动管道:
- 在 Developer 视角 的 Pipelines 视图中,点附加到 Pipeline 的 Options 菜单,然后选择 Start。
Start Pipeline 对话框显示 Git Resources 以及基于管道定义的 Image Resources。
注意对于使用 From Git 选项创建的管道,Start Pipeline 对话框也会在 Parameters 部分显示
APP_NAME
字段,对话框中的所有字段都由管道模板预先填充。- 如果您在命名空间中有资源,Git Resources 和 Image Resources 字段会预先填充这些资源。如果需要,使用下拉菜单选择或创建所需资源并自定义管道运行实例。
可选:修改 Advanced Options 以添加验证指定私有 Git 服务器或镜像 registry 的凭证。
- 在 Advanced Options 下,点 Show Credentials Options 并选择 Add Secret。
在 Create Source Secret 部分,指定以下内容:
- secret 的唯一 Secret Name。
- 在 要被验证的指定供应商 部分,在 Access to 字段中指定要验证的供应商,以及基本 服务器 URL。
选择 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
.
-
- 选择要添加 secret 的检查标记。
您可以根据频道中的资源数量添加多个 secret。
- 点 Start 启动管道。
Pipeline Run Details 页面显示正在执行的管道。管道启动后,每个任务中的任务和步骤都会被执行。您可以:
- 将鼠标悬停在任务上,以查看执行每一步骤所需时间。
- 点一个任务来查看任务中每一步骤的日志。
- 点 Logs 选项卡查看与任务执行顺序相关的日志。您还可以使用相关按钮扩展窗格,单独或批量下载日志。
点 Events 选项卡查看管道运行生成的事件流。
您可以使用 Task Runs、Logs 和 Events 选项卡来帮助调试失败的管道运行或失败的任务运行。
图 4.4. Pipeline 运行详情
4.9.6. 从 Topology 视图启动管道
对于使用 From Git 选项创建的管道,您可以在启动后使用 Topology 视图来与管道进行交互:
要使用 Pipeline Builder 在 Topology 视图中查看创建的管道,自定义管道标识来把 Pipeline 与应用程序负载相连接。
流程
- 单击左侧导航面板中的 Topology。
- 点应用程序在侧面面板中显示 Pipeline Runs。
在 Pipeline Runs 中,点 Start Last Run 来启动一个新的管道运行,使用与前一个相同的参数和资源。如果没有启动管道运行,这个选项会被禁用。您还可以在创建管道时启动管道运行。
图 4.5. Topology 视图中的管道
在 Topology 页面中,把鼠标移到应用程序的左侧,以查看其管道运行的状态。添加管道后,底部左图标表示存在关联的管道。
4.9.7. 从 Topology 视图与管道交互
Topology 页面中的应用程序节点的侧面板显示管道运行的状态,并可与之交互。
- 如果管道运行没有自动启动,则侧面板会显示管道无法自动启动的消息,因此需要手动启动。
- 如果创建一个管道,但用户没有启动管道,则其状态不会启动。当用户点击 Not started status 图标时,Topology 视图中会打开启动对话框。
- 如果管道没有构建或构建配置,则无法看到 Builds 部分。如果存在管道和构建配置,则 Builds 部分 可见。
- 当管道运行在特定任务运行时,侧边面板会显示一个 日志片段。您可以在 Pipeline Runs 部分的 Resources 选项卡中查看日志片断。它提供常规错误消息和日志片断。Logs 部分的链接可让您快速访问失败运行的详细信息。
4.9.8. 编辑管道
您可以使用 web 控制台的 Developer 视角编辑集群中的 Pipelines:
流程
- 在 Developer 视角的 Pipelines 视图中,选择您要编辑的管道来查看 Pipeline 的详情。在 Pipeline Details 页中,点 Actions 并选择 Edit Pipeline。
在 Pipeline builder 页面中,您可以执行以下任务:
- 在 Pipeline 中添加额外的任务、参数或资源。
- 点要修改的任务来查看侧面面板中的任务详情,并修改所需的任务详情,如显示名称、参数和资源。
- 或者,要删除此任务,点任务,在侧面面板中点 Actions,并选择 Remove Task。
- 点 Save 来保存修改的管道。
4.9.9. 删除管道
您可以使用 web 控制台的 Developer 视角删除集群中的管道。
流程
- 在 Developer 视角 的 Pipelines 视图中,点 Pipeline 旁的 Options 菜单,然后选择 Delete Pipeline。
- 在 Delete Pipeline 确认提示下,点 Delete 以确认删除。
4.9.9.1. 其他资源
4.9.10. 在 Administrator 视角中创建管道模板
作为集群管理员,您可以创建管道模板,开发人员可在集群上创建管道时重复使用该模板。
先决条件
- 您可以使用集群管理员权限访问 OpenShift Container Platform 集群,并切换到 Administrator 视角。
- 已在集群中安装了 Pipelines Operator。
流程
- 进入到 Pipelines 页面来查看现有的管道模板。
- 点 图标进入 Import YAML 页面。
为管道模板添加 YAML。模板必须包含以下信息:
apiVersion: tekton.dev/v1beta1 kind: Pipeline metadata: # ... namespace: openshift 1 labels: pipeline.openshift.io/runtime: <runtime> 2 pipeline.openshift.io/type: <pipeline-type> 3 # ...
- 点 Create。创建管道后,会进入 Pipeline 详情页面,您可以在其中查看或编辑管道的信息。