#安装

#安装 Alauda DevOps Pipelines

本指南为集群管理员提供了在 Kubernetes 集群上安装 Alauda DevOps Pipelines Operator 的步骤。

前提条件：

• 你已使用具有 cluster-admin 权限的账户访问 Kubernetes 集群。
• 你已安装 kubectl CLI。
• 你的集群已启用 Marketplace 功能，或者可访问 Operator Hub。

#使用 Web 控制台安装 Alauda DevOps Pipelines

你可以通过使用 Marketplace 或 OperatorHub 中列出的 Operators 来安装 Alauda DevOps Pipelines Operator。安装 Alauda DevOps 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 DevOps Pipelines Operator 提供了通过在 TektonConfig Custom Resource（CR）中指定预设配置来选择要安装哪些组件的选项。安装 Operator 时会自动安装 TektonConfig CR。支持的预设包括：

• Lite：仅安装 Tekton Pipelines。
• Basic：安装 Tekton Pipelines 和 Tekton Triggers。
• All：这是安装 TektonConfig CR 时使用的默认预设。此预设会安装所有 Tekton 组件，包括 Tekton Pipelines、Tekton Triggers。

步骤

• 在 Web 控制台中，导航到 Marketplace 或 OperatorHub。

• 使用 Filter by keyword 框在目录中搜索 Alauda DevOps Pipelines Operator。单击 Alauda DevOps Pipelines Operator 标题。

• 阅读 Alauda DevOps Pipelines Operator 页面上的 Operator 概述。单击 安装。

• 在 Install Operator 页面中：

  • 对于 Installation Mode，选择 All namespaces on the cluster (default)。此模式会将 Operator 安装到默认的 tekton-operator 命名空间中，使 Operator 能够在集群的所有命名空间中进行监视并可用。
  • 对于 Approval Strategy，选择 Automatic。这可确保 Operator 的未来升级由 Operator Lifecycle Manager（OLM）自动处理。如果你选择 Manual 审批策略，OLM 将创建更新请求。作为集群管理员，你必须手动批准 OLM 更新请求，才能将 Operator 升级到新版本。
  • 如果有多个可用通道，请选择一个 Update Channel。

• 单击 安装。你将在 Installed Operators 页面上看到该 Operator。

• 验证 Status 是否为 Succeeded，以确认 Alauda DevOps Pipelines Operator 已成功安装。

• 验证 Alauda DevOps Pipelines Operator 的所有组件是否已成功安装。在终端中登录到集群并运行以下命令：

  $ kubectl get tektonconfig config

  示例输出

  NAME     VERSION   READY   REASON
  config   v0.74.1     True

  如果 READY 条件为 True，则表示 Operator 及其组件已成功安装。

  此外，运行以下命令检查各组件的版本：

  $ kubectl get tektonpipeline,tektontrigger,tektonhub,tektonchain

  示例输出

  NAME                                          VERSION           READY   REASON
  tektonpipeline.operator.tekton.dev/pipeline   v0.65.5-c96b8b8   True
  
  NAME                                        VERSION           READY   REASON
  tektontrigger.operator.tekton.dev/trigger   v0.30.1-f53d05d   True
  
  NAME                                VERSION   READY   REASON   APIURL   UIURL
  tektonhub.operator.tekton.dev/hub   1.19.2    True
  
  NAME                                    VERSION           READY   REASON
  tektonchain.operator.tekton.dev/chain   v0.23.0-927681d   True

#使用 CLI 安装 Alauda DevOps Pipelines

你可以使用命令行界面（CLI）从 OperatorHub 安装 Alauda DevOps Pipelines Operator。

通道快速参考

• stable（默认，自 v4.6.3 起）：安装最新的 LTS 版本。建议用于生产环境。
• latest：安装所有可用的 v4.6.z 版本。如果你之前依赖 latest 默认值，可以在 Subscription 中继续使用此值。
• pipelines-4.6：仅将升级锁定为 v4.6.z 补丁版本。

步骤

• 创建一个 Subscription 对象 YAML 文件，以将某个命名空间订阅到 Alauda DevOps Pipelines Operator，例如 sub.yaml：

示例 Subscription YAML

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: tektoncd-operator
  namespace: tekton-operator
spec:
  channel: stable
  name: tektoncd-operator
  source: platform
  sourceNamespace: cpaas-system

• 通过运行以下命令创建 Subscription 对象：

  $ kubectl apply -f sub.yaml

  该订阅会在 tekton-operator 命名空间中安装 Alauda DevOps Pipelines Operator。该 Operator 会自动在默认目标命名空间 tekton-pipelines 中安装 Tekton 组件。

#卸载 Alauda DevOps Pipelines

集群管理员可以通过执行以下步骤卸载 Alauda DevOps Pipelines Operator：

• 删除任何可选组件的 CR（如果存在），然后删除 TektonConfig CR。
• 卸载 Alauda DevOps Pipelines Operator。
• 如有需要，删除 operator.tekton.dev 组的 Custom Resource Definitions（CRD）。

仅卸载 Operator 并不会删除在安装 Operator 时默认创建的 Alauda DevOps Pipelines 组件。

#删除 Alauda DevOps Pipelines 资源实例

首先，删除 TektonConfig CR，以及任何其他 Tekton 组件 CR（如果存在）。

步骤

• 在 Web 控制台中，导航到 Administration → CustomResourceDefinitions 或相应部分。
• 搜索 TektonConfig CRD。
• 单击 TektonConfig CRD 以显示详细页面。
• 单击 Instances 选项卡。
• 如果显示了某个实例，单击该实例的 Options 菜单。
• 选择 Delete。
• 单击 Delete 以确认删除该 CR。
  • 删除 TektonConfig 资源将级联删除自动创建的 TektonPipelines、TektonTriggers、TektonHubs、TektonChains 等组件。
• 对可能存在的任何其他 Tekton 组件 CR 重复这些步骤。
  • 如果你手动创建了 OpenShiftPipelinesAsCodes，则可能需要手动删除它。
  • 对于仍具有独立 TektonResult 资源的旧集群，请在卸载前手动删除它。

#卸载 Alauda DevOps Pipelines Operator

你可以使用 Web 控制台卸载 Alauda DevOps Pipelines Operator。

步骤

• 从 Marketplace 或 OperatorHub 页面，导航到 Installed Operators。
• 在列表中找到 Alauda DevOps Pipelines Operator。
• 单击 Options 菜单并选择 Uninstall Operator。
• 在 Uninstall Operator? 窗口中，选择 Delete all operand instances for this operator，然后单击 Uninstall。

#删除 Alauda DevOps Pipelines 资源定义（可选）

如果你希望完全移除 Tekton Operator 的所有痕迹，可以删除 operator.tekton.dev 组的 Custom Resource Definitions（CRD）。

步骤

• 在 Web 控制台中，导航到 Administration → CustomResourceDefinitions 或相应部分。
• 搜索包含关键字 operator.tekton.dev 的 CRD。
• 对于要删除的每个 CRD：
  • 单击 Options 菜单。
  • 选择 Delete CustomResourceDefinition。
  • 单击 Delete 以确认删除该 CRD。

#自定义 TektonConfig 中的配置

在 Alauda DevOps Pipelines 中，你可以使用 TektonConfig Custom Resource（CR）自定义以下配置：

• 优化 Tekton Pipelines 性能，包括 Tekton Pipelines controller 的高可用模式
• 配置 Tekton Pipelines 控制平面
• 更改默认 service account
• 配置 pipeline resolver
• 禁用特定功能或组件

#前提条件

必须已安装 Alauda DevOps Pipelines Operator。

#使用 TektonConfig CR 调优性能

你可以修改 TektonConfig Custom Resource（CR）中的 .spec.pipeline.performance 参数下的字段，以更改 Tekton Pipelines controller 的高可用（HA）支持和性能配置。

TektonConfig 性能字段示例

apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  pipeline:
    performance:
      disable-ha: false
      buckets: 7
      replicas: 5
      threads-per-controller: 2
      kube-api-qps: 5.0
      kube-api-burst: 10
      statefulset-ordinals: false

所有字段都是可选的。设置后，Alauda DevOps Pipelines Operator 会将大多数字段作为参数包含在 tekton-pipelines-controller deployment 的 tekton-pipelines-controller 容器中。Operator 还会更新 tekton-pipelines 命名空间下 config-leader-election ConfigMap 中的 bucket 字段。

如果未指定任何值，Operator 不会更新这些字段，而是应用 Tekton Pipelines controller 的默认值。

高可用（HA）模式适用于 Tekton Pipelines controller；它会根据 pipeline run 和 task run 定义创建并启动 pod。若没有 HA 模式，则由单个 pod 执行这些操作，这可能导致高负载和显著延迟。

在 HA 模式下，Tekton Pipelines 使用多个 pod（副本）来执行这些操作。最初，Tekton Pipelines 会将每个 controller 操作分配到各个 bucket 中。每个副本从一个或多个 bucket 中选择操作。如果两个副本可以同时选择同一操作，controller 会在内部决定由谁来执行该操作。

HA 模式不会影响 pod 创建后运行的任务。

#配置 Tekton Pipelines 控制平面

你可以通过编辑 TektonConfig Custom Resource（CR）中的配置字段来自定义 Tekton Pipelines 控制平面。Alauda DevOps Pipelines Operator 会自动为配置字段包含默认值，因此你可以使用 Tekton Pipelines 控制平面。

流程

1. 在 Web 控制台中，导航到 CustomResourceDefinitions 部分。
2. 搜索 tektonconfigs.operator.tekton.dev Custom Resource Definition（CRD）。
3. 单击 TektonConfig 以查看 CRD 详细页面。
4. 单击 Instances 选项卡。
5. 单击 config 实例以查看 TektonConfig CR 的详细信息。
6. 单击 YAML 选项卡。
7. 根据你的需求编辑 TektonConfig YAML 文件。

具有默认值的 TektonConfig CR 示例

apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  pipeline:
    running-in-environment-with-injected-sidecars: true
    metrics.taskrun.duration-type: histogram
    metrics.pipelinerun.duration-type: histogram
    await-sidecar-readiness: true
    default-service-account: pipeline
    require-git-ssh-secret-known-hosts: false
    enable-tekton-oci-bundles: false
    metrics.taskrun.level: task
    metrics.pipelinerun.level: pipeline
    enable-api-fields: stable
    enable-provenance-in-status: false
    enable-custom-tasks: true
    disable-creds-init: false
    disable-affinity-assistant: true

#功能标志选项

可以在 TektonConfig CR 中配置以下功能标志，以控制 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 规范中的 default-service-account 字段来更改 Tekton Pipelines 的默认 service account。默认 service account 名称为 pipeline。

示例

apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  pipeline:
    default-service-account: custom-pipeline-account

#为安装命名空间设置 Labels 和 Annotations

你可以为 Operator 安装 Tekton Pipelines 组件的 tekton-pipelines 命名空间设置 labels 和 annotations。

通过将它们添加到 TektonConfig Custom Resource（CR）的 .spec.targetNamespaceMetadata 规范中来指定 labels 和 annotations。

为 tekton-pipelines 命名空间设置 Labels 和 Annotations 的示例

apiVersion: operator.tekton.dev/v1alpha1
kind: TektonConfig
metadata:
  name: config
spec:
  targetNamespaceMetadata:
    labels: {"example-label":"example-value"}
    annotations: {"example-annotation":"example-value"}

#后续步骤

成功安装 Alauda DevOps Pipelines Operator 后：

• 调整子组件的可选配置项
• 为 Pipeline 组件配置资源配额
• 定期清理 TaskRun 和 PipelineRun 资源