安装
目录
安装 Alauda Container Platform Pipelines前提条件使用 Web 控制台安装 Alauda Container Platform Pipelines使用 CLI 安装 Alauda Container Platform Pipelines卸载 Alauda Container Platform Pipelines删除 Alauda Container Platform Pipelines 资源实例卸载Alauda Container Platform Pipelines Operator删除 Alauda Container Platform Pipelines 资源定义(可选)在 TektonConfig 中自定义配置前提条件使用 TektonConfig CR 调整性能配置 Tekton Pipelines 控制平面Feature Flag 选项更改默认 Service Account为安装命名空间设置标签和注释后续步骤安装 Alauda Container Platform Pipelines
本指南为集群管理员提供在 Kubernetes 集群上安装 Alauda Container Platform Pipelines Operator 的流程。
前提条件
-
您可以使用具有
cluster-admin权限的帐户访问 Kubernetes 集群。 -
您已安装
kubectlCLI。 -
您的集群已启用 Marketplace 功能,或可访问 Operator Hub。
-
下载 operator 软件包,并将其保存到操作机器上的工作目录中。
-
下载 Operator
INFO可以从 Alauda Cloud 获取 Alauda Container Platform Pipelines。
有关更多信息,请联系 Consumer Support。
-
上传 Operator
无论是导入新的 operator 还是向现有 operator 添加新版本,都可以使用
violet工具完成此任务,所使用的命令相同。在工作目录中执行以下命令:
- 运行
violet工具,将 operator 软件包上传到平台。 <operator-package>:operator 软件包的名称(示例:tektoncd-operator.latest.amd64.v4.7.0.tgz)。<platform-address>:平台的 URL 地址(示例:https://platform.example.com)。<platform-username>:平台用户名,需要具有 Platform Administrator 权限。<platform-password>:平台密码。<clusters>:需要上传 operator 的集群列表,使用逗号分隔(示例:global, business)。--force:强制覆盖 registry 中现有的镜像和构件。
WARNING如果要上传新版本以更新现有的
tektoncd-operator,使用 violet 上传Operator时必须指定--force参数,以覆盖 registry 中现有的镜像和构件。然后转到平台的
Platform Management->Marketplace->Upload Packages页面, 搜索 operator 关键字,然后单击 operator 名称进入 operator 详情页面。详情页面将显示 operator 的新版本。 如果状态为
Uploaded,则表示上传成功。 - 运行
-
使用 Web 控制台安装 Alauda Container Platform Pipelines
您可以使用 Marketplace 或 OperatorHub 中列出的 Operators 安装 Alauda Container Platform Pipelines Operator。安装 Alauda Container Platform Pipelines Operator 时,所需的 Custom Resources(CR)会随 Operator 自动安装。
该 Operator 提供以下 Custom Resource Definitions(CRD)来管理 Tekton 组件:tektonconfigs.operator.tekton.dev、tektonpipelines.operator.tekton.dev、tektontriggers.operator.tekton.dev、tektonhubs.operator.tekton.dev 等。
如果您的集群中已安装 Tekton Pipelines,Operator 将无缝升级现有安装。
Alauda Container Platform Pipelines Operator 支持通过在 TektonConfig Custom Resource(CR)中指定预设配置来选择要安装的组件。安装 Operator 时会自动安装 TektonConfig CR。支持的预设包括:
- Lite:仅安装 Tekton Pipelines。
- Basic:安装 Tekton Pipelines 和 Tekton Triggers。
- All:安装
TektonConfigCR 时使用的默认预设。此预设会安装所有 Tekton 组件,包括 Tekton Pipelines 和 Tekton Triggers。
从 v4.12.0 开始,任何预设默认都不会部署内置的 Tekton Hub — Tekton catalog 构件由平台独立的 ArtifactHub 组件提供。若要将内置的 Tekton Hub 作为过渡选项进行部署,请参阅启用内置 Tekton Hub。
Channel 快速参考
stable(默认):安装最新的 LTS 版本。推荐用于生产环境。latest:安装最新的可用版本,包括非 LTS 版本。推荐用于开发和测试环境。pipelines-4.10:仅将升级锁定到v4.10.z的补丁版本。
步骤
-
在 Web 控制台中,转到 Marketplace 或 OperatorHub。
-
使用目录中的 按关键字筛选 框搜索
Alauda Container Platform PipelinesOperator。单击Alauda Container Platform PipelinesOperator 标题。 -
在
Alauda Container Platform PipelinesOperator 页面上查看 Operator 概览。单击 安装。 -
在 安装 Operator 页面上:
- 对于 安装模式,选择 集群上的所有命名空间(默认)。此模式会将 Operator 安装在默认的
tekton-operator命名空间中,使 Operator 能够监控集群中的所有命名空间,并在所有命名空间中可用。 - 对于 批准策略,选择 自动。这可确保 Operator 的未来升级由 Operator Lifecycle Manager(OLM)自动处理。如果选择
Manual批准策略,OLM 将创建更新请求。作为集群管理员,您必须手动批准 OLM 更新请求,才能将 Operator 升级到新版本。 - 如果有多个 Channel 可用,请选择一个 更新 Channel。
- 对于 安装模式,选择 集群上的所有命名空间(默认)。此模式会将 Operator 安装在默认的
-
单击 安装。您将在已安装的 Operators 页面上看到该 Operator。
-
验证 状态 是否设置为 Succeeded,以确认
Alauda Container Platform PipelinesOperator 已成功安装。 -
验证
Alauda Container Platform PipelinesOperator 的所有组件是否已成功安装。在终端中登录集群并运行以下命令:示例输出
如果
READY条件为True,则表示 Operator 及其组件已成功安装。此外,运行以下命令检查组件的版本:
示例输出
如果已启用内置的
Tekton Hub(自v4.12.0起默认不部署),还需使用kubectl get tektonhub检查其状态。
使用 CLI 安装 Alauda Container Platform Pipelines
您可以通过 Command Line Interface(CLI)从 OperatorHub 安装 Alauda Container Platform Pipelines Operator。
步骤
- 创建一个
Subscription对象 YAML 文件,以将命名空间订阅到Alauda Container Platform PipelinesOperator,例如sub.yaml:
Subscription YAML 示例
- 要订阅的 Channel 名称。
stable为默认值,会安装最新的 LTS 版本。使用latest接收每个版本,或使用pipelines-4.10保持在v4.10.z补丁更新范围内。 - 要订阅的 Operator 名称。
- 提供 Operator 的
CatalogSource对象名称。 CatalogSource对象所在的命名空间。此值可能因集群配置而异。
-
运行以下命令创建
Subscription对象:该订阅将在
tekton-operator命名空间中安装Alauda Container Platform PipelinesOperator。Operator 将在默认目标命名空间tekton-pipelines中自动安装 Tekton 组件。
卸载 Alauda Container Platform Pipelines
集群管理员可以执行以下步骤卸载 Alauda Container Platform Pipelines Operator:
- 如果存在任何可选组件 CR,请先将其删除,然后删除
TektonConfigCR。 - 卸载
Alauda Container Platform PipelinesOperator。 - 如有需要,删除
operator.tekton.dev组的 Custom Resource Definitions(CRD)。
仅卸载 Operator 不会删除在安装 Operator 期间默认创建的 Alauda Container Platform Pipelines 组件。
删除 Alauda Container Platform Pipelines 资源实例
首先,删除 TektonConfig CR,以及其他存在的 Tekton 组件 CR。
步骤
- 在 Web 控制台中,导航至 管理 → CustomResourceDefinitions 或相应的部分。
- 搜索
TektonConfigCRD。 - 单击
TektonConfigCRD 以显示详细信息页面。 - 单击 实例 选项卡。
- 如果显示了实例,请单击该实例的
Options菜单。 - 选择 删除。
- 单击 删除 以确认删除 CR。
- 删除
TektonConfig资源将级联删除自动创建的TektonPipelines、TektonTriggers、TektonHubs、TektonChains等组件。
- 删除
- 对可能存在的其他 Tekton 组件 CR 重复这些步骤。
- 如果您手动创建了
TektonResults或OpenShiftPipelinesAsCodes,可能需要手动将其删除。
- 如果您手动创建了
卸载 Alauda Container Platform Pipelines Operator
您可以使用 Web 控制台卸载 Alauda Container Platform Pipelines Operator。
步骤
- 在 Marketplace 或 OperatorHub 页面中,导航至 已安装的 Operator。
- 在列表中找到
Alauda Container Platform PipelinesOperator。 - 单击 选项 菜单,然后选择 卸载 Operator。
- 在 卸载 Operator? 窗口中,选择 删除此 Operator 的所有 operand 实例,然后单击 卸载。
删除 Alauda Container Platform Pipelines 资源定义(可选)
如果您希望完全删除 Tekton Operator 的所有痕迹,可以删除 operator.tekton.dev 组的 Custom Resource Definitions(CRD)。
步骤
- 在 Web 控制台中,导航至 管理 → CustomResourceDefinitions 或相应的部分。
- 使用关键字
operator.tekton.dev搜索 CRD。 - 对于要删除的每个 CRD:
- 单击 选项 菜单。
- 选择 删除 CustomResourceDefinition。
- 单击 删除 以确认删除 CRD。
在 TektonConfig 中自定义配置
在 Alauda Container Platform Pipelines 中,您可以使用 TektonConfig Custom Resource(CR)自定义以下配置:
- 优化 Tekton Pipelines 性能,包括 Tekton Pipelines controller 的高可用模式
- 配置 Tekton Pipelines 控制平面
- 更改默认 service account
- 配置 pipeline resolvers
- 禁用特定功能或组件
前提条件
必须安装 Alauda Container Platform Pipelines Operator。
使用 TektonConfig CR 调整性能
您可以修改 TektonConfig Custom Resource(CR)中 .spec.pipeline.performance 参数下的字段,以更改 Tekton Pipelines controller 的高可用(HA)支持和性能配置。
TektonConfig 性能字段示例
所有字段均为可选字段。设置后,Alauda Container Platform Pipelines Operator 会将大多数字段作为参数包含在 tekton-pipelines-controller 部署的 tekton-pipelines-controller 容器中。Operator 还会更新 tekton-pipelines 命名空间中 config-leader-election ConfigMap 的 bucket 字段。
如果未指定任何值,Operator 不会更新这些字段,而是应用 Tekton Pipelines controller 的默认值。
如果您修改或删除任何性能字段,Operator 将更新 tekton-pipelines-controller 部署和 config-leader-election ConfigMap(如果 bucket 字段已更改),并重新创建 tekton-pipelines-controller pod。
高可用(HA)模式适用于 Tekton Pipelines controller;它会根据 pipeline runs 和 task runs 定义创建并启动 pod。在没有 HA 模式时,单个 pod 执行这些操作,可能会导致高负载和明显延迟。
在 HA 模式下,Tekton Pipelines 使用多个 pod(replica)执行这些操作。最初,Tekton Pipelines 会将每个 controller 操作分配到各个 bucket 中。每个 replica 从一个或多个 bucket 中选择操作。如果两个 replica 可以同时选择同一个操作,controller 会在内部决定由哪个 replica 执行该操作。
HA 模式不会影响 pod 创建后运行的 task。
配置 Tekton Pipelines 控制平面
您可以通过编辑 TektonConfig Custom Resource(CR)中的配置字段来自定义 Tekton Pipelines 控制平面。Alauda Container Platform Pipelines Operator 会自动为配置字段包含默认值,以便您使用 Tekton Pipelines 控制平面。
操作步骤
- 在 Web 控制台中,导航至 CustomResourceDefinitions 部分。
- 搜索
tektonconfigs.operator.tekton.devCustom Resource Definition(CRD)。 - 单击 TektonConfig 以查看 CRD 详细信息页面。
- 单击 实例 选项卡。
- 单击 config 实例以查看
TektonConfigCR 的详细信息。 - 单击 YAML 选项卡。
- 根据您的需求编辑
TektonConfigYAML 文件。
包含默认值的 TektonConfig CR 示例
Feature Flag 选项
您可以在 TektonConfig CR 中配置以下 feature flag,以控制 Tekton Pipelines 的不同操作:
disable-affinity-assistant(默认值:false)disable-creds-init(默认值:false)enable-api-fields(默认值:stable)enable-custom-tasks(默认值:true)await-sidecar-readiness(默认值:true)running-in-environment-with-injected-sidecars(默认值:true)require-git-ssh-secret-known-hosts(默认值:false)enable-provenance-in-status(默认值:true)
有关各选项的详细说明,请参阅 Tekton Operator 文档。
更改默认 Service Account
您可以通过编辑 .spec.pipeline specification 中的 default-service-account 字段来更改 Tekton Pipelines 的默认 service account。默认 service account 名称为 pipeline。
示例
为安装命名空间设置标签和注释
您可以为 tekton-pipelines 命名空间设置标签和注释,Operator 会在该命名空间中安装 Tekton Pipelines 组件。
在 TektonConfig Custom Resource(CR)的 .spec.targetNamespaceMetadata specification 中添加标签和注释,以指定这些标签和注释。
为 tekton-pipelines 命名空间设置标签和注释的示例
后续步骤
成功安装 Alauda Container Platform Pipelines Operator 后:
Tekton™ 是 The Linux Foundation 的商标。
Red Hat® 和 OpenShift® 是 Red Hat, Inc. 在美国和其他国家/地区的注册商标。
Alauda 是独立供应商。本产品与 The Linux Foundation 或 Red Hat, Inc. 没有任何关联,也未获得其认可或赞助。所有商标均归其各自所有者所有,本文使用这些商标仅用于标识目的。