#安装 Alauda Build of OpenTelemetry v2

安装 Alauda Build of OpenTelemetry v2 包括以下步骤：

• 安装 Alauda Build of OpenTelemetry v2 Operator
• 为 OpenTelemetry Collector 创建命名空间
• 部署 OpenTelemetry Collector 实例

#安装 Alauda Build of OpenTelemetry v2 Operator

#通过 Web 控制台安装

前提条件

• 必须已上传 Alauda Container Platform Application Observability（之前称为 Alauda Build of OpenTelemetry v2）。
• 您已以 cluster-admin 身份登录 Alauda Container Platform Web 控制台。

操作步骤

1. 在 Alauda Container Platform Web 控制台中，导航至 管理员。
2. 选择 Marketplace > OperatorHub。
3. 搜索 Alauda Container Platform Application Observability 插件（在重命名之前发布的软件包显示为 Alauda Build of OpenTelemetry v2）。
4. 找到 Alauda Container Platform Application Observability 插件（或 Alauda Build of OpenTelemetry v2），并单击以选中它。
5. 单击 安装。
6. 在 安装 Alauda Container Platform Application Observability 对话框中（对于重命名之前发布的软件包，标题为 安装 Alauda Build of OpenTelemetry v2），执行以下步骤：
   1. 选择 stable channel，以安装最新稳定版本的 Alauda Build of OpenTelemetry v2 Operator。
7. 单击 安装，然后单击 确认 以安装 Operator。

验证

在 安装信息 部分中，验证 Operator 安装状态是否报告为 Succeeded。

#通过 CLI 安装

前提条件

• 必须已上传 Alauda Container Platform Application Observability（之前称为 Alauda Build of OpenTelemetry v2）。
• 集群管理员已通过具有 cluster-admin 角色的有效 ACP CLI（kubectl）会话登录。

操作步骤

1. 检查可用版本

   (
     echo -e "CHANNEL\tNAME\tVERSION"
     kubectl get packagemanifest opentelemetry-operator2 -o json | jq -r '
       .status.channels[] |
       .name as $channel |
       .entries[] |
       [$channel, .name, .version] | @tsv
     '
   ) | column -t -s $'\t'

   示例输出

   CHANNEL  NAME                                    VERSION
   stable   opentelemetry-operator2.v0.157.0-r1     0.157.0-r1

   字段：

   • CHANNEL：Operator channel 名称
   • NAME：CSV 资源名称
   • VERSION：Operator 版本

2. 确认 catalogSource

   kubectl get packagemanifests opentelemetry-operator2 -ojsonpath='{.status.catalogSource}'

   示例输出

   platform

   这表示 opentelemetry-operator2 来自 platform catalogSource。

3. 创建命名空间

   kubectl get namespace opentelemetry-operator2 || kubectl create namespace opentelemetry-operator2

4. 创建 Subscription

   kubectl apply -f - <<EOF
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     annotations:
       cpaas.io/target-namespaces: ""
     labels:
       catalog: platform
     name: opentelemetry-operator2
     namespace: opentelemetry-operator2
   spec:
     channel: stable
     installPlanApproval: Manual
     name: opentelemetry-operator2
     source: platform
     sourceNamespace: cpaas-system
     startingCSV: opentelemetry-operator2.v0.157.0-r1
   EOF

   字段说明

   • annotation cpaas.io/target-namespaces：建议将其设置为空；空值表示集群范围安装。
   • .metadata.name：Subscription 名称（符合 DNS 规范，最多 253 个字符）。
   • .metadata.namespace：安装 Operator 的命名空间。
   • .spec.channel：订阅的 Operator channel。
   • .spec.installPlanApproval：审批策略（Manual 或 Automatic）。此处，Manual 要求手动批准安装/升级。
   • .spec.source：Operator catalogSource。
   • .spec.sourceNamespace：必须设置为 cpaas-system，因为平台提供的所有 catalogSource 都位于此命名空间中。
   • .spec.startingCSV：指定 Manual approval 要安装的版本；为空时默认为 channel 中的最新版本。Automatic 不需要此字段。

5. 检查 Subscription 状态

   kubectl -n opentelemetry-operator2 get subscriptions opentelemetry-operator2 -o yaml

   关键输出

   • .status.state：UpgradePending 表示 Operator 正在等待安装或升级。
   • Condition InstallPlanPending = True：正在等待手动批准。
   • .status.currentCSV：最新订阅的 CSV。
   • .status.installPlanRef：关联的 InstallPlan；必须批准后才能继续安装。

   等待 InstallPlanPending 条件变为 True：

   kubectl -n opentelemetry-operator2 wait --for=condition=InstallPlanPending subscription opentelemetry-operator2 --timeout=2m

6. 批准 InstallPlan

   kubectl -n opentelemetry-operator2 get installplan \
     "$(kubectl -n opentelemetry-operator2 get subscriptions opentelemetry-operator2 -o jsonpath='{.status.installPlanRef.name}')"

   示例输出

   NAME            CSV                                     APPROVAL   APPROVED
   install-abc12   opentelemetry-operator2.v0.157.0-r1     Manual     false

   手动批准

   PLAN="$(kubectl -n opentelemetry-operator2 get subscription opentelemetry-operator2 -o jsonpath='{.status.installPlanRef.name}')"
   kubectl -n opentelemetry-operator2 patch installplan "$PLAN" --type=json -p='[{"op": "replace", "path": "/spec/approved", "value": true}]'

验证

等待 CSV 创建；Phase 变为 Succeeded：

kubectl wait --for=jsonpath='{.status.phase}'=Succeeded csv --all -n opentelemetry-operator2 --timeout=3m

检查 CSV 状态：

kubectl -n opentelemetry-operator2 get csv

示例输出

NAME                                    DISPLAY                                  VERSION      REPLACES   PHASE
opentelemetry-operator2.v0.157.0-r1     Alauda Build of OpenTelemetry v2         0.157.0-r1              Succeeded

字段

• NAME：已安装的 CSV 名称
• DISPLAY：Operator 显示名称
• VERSION：Operator 版本
• REPLACES：升级期间替换的 CSV
• PHASE：安装状态（Succeeded 表示成功）

#部署 OpenTelemetry Collector

成功安装 Alauda Build of OpenTelemetry v2 Operator 后，通过创建 OpenTelemetryCollector 自定义资源来部署 OpenTelemetry Collector。

#为 Collector 创建命名空间

在部署 OpenTelemetry Collector 之前，为 Collector 实例创建专用命名空间。不得将 Collector 部署在与 Operator 相同的命名空间中。

kubectl get namespace opentelemetry-collector || \
  kubectl create namespace opentelemetry-collector

#通过 Web 控制台部署

前提条件

• 必须已安装 Alauda Container Platform Application Observability（之前称为 Alauda Build of OpenTelemetry v2）Operator。
• 您已以 cluster-admin 身份登录 Alauda Container Platform Web 控制台。
• 已为 Collector 实例创建专用命名空间。

操作步骤

1. 在 Alauda Container Platform Web 控制台中，导航至 管理员。

2. 选择 Marketplace > OperatorHub。

3. 搜索 Alauda Container Platform Application Observability 插件（对于重命名前发布的软件包，显示为 Alauda Build of OpenTelemetry v2）。

4. 找到 Alauda Container Platform Application Observability 插件（或 Alauda Build of OpenTelemetry v2），然后单击以选中它。

5. 单击 所有实例选项卡。

6. 单击创建。

7. 找到并选择 OpenTelemetryCollector，然后单击创建。

8. 从命名空间下拉列表中选择 Collector 命名空间。

9. 单击 YAML 选项卡。

10. 在 YAML 代码编辑器中自定义 OpenTelemetryCollector 自定义资源（CR）：

    OpenTelemetryCollector CR 示例

    apiVersion: opentelemetry.io/v1beta1
    kind: OpenTelemetryCollector
    metadata:
      name: otel
      namespace: opentelemetry-collector
    spec:
      mode: deployment
      replicas: 1
      config:
        receivers:
          otlp:
            protocols:
              grpc: {}
              http: {}
          jaeger:
            protocols:
              grpc: {}
              thrift_binary: {}
              thrift_compact: {}
              thrift_http: {}
          zipkin: {}
        processors:
          batch: {}
          memory_limiter:
            check_interval: 1s
            limit_percentage: 80
            spike_limit_percentage: 20
        exporters:
          debug: {}
        service:
          pipelines:
            traces:
              receivers: [otlp, jaeger, zipkin]
              processors: [memory_limiter, batch]
              exporters: [debug]
    1. 用于部署 OpenTelemetry Collector 实例的命名空间。此处使用 opentelemetry-collector 作为示例；请将其替换为您为 Collector 创建的命名空间。此命名空间必须不同于 Operator 的命名空间。
    2. Collector 部署模式。支持的值包括：deployment（默认）、daemonset、statefulset 或 sidecar。
    3. 接收器定义遥测数据如何进入 Collector。此示例配置了 OTLP、Jaeger 和 Zipkin 协议接收器。
    4. 处理器负责处理接收与导出之间的数据。此示例使用 batch 对遥测数据进行批处理，并使用 memory_limiter 控制内存使用量。
    5. 导出器定义遥测数据的目标位置。此示例使用 debug 导出器，将数据输出到 Collector 日志。

11. 单击创建。

验证

等待 OpenTelemetry Collector 的 pod 运行。

#通过 CLI 部署

前提条件

• 具有 cluster-admin 角色的集群管理员已建立活动 ACP CLI（kubectl）会话。
• 必须已安装 Alauda Container Platform Application Observability（之前称为 Alauda Build of OpenTelemetry v2）Operator。
• 已为 Collector 实例创建专用命名空间。

操作步骤

1. 自定义并应用 OpenTelemetryCollector 自定义资源（CR）：

   kubectl apply -f - <<EOF
   apiVersion: opentelemetry.io/v1beta1
   kind: OpenTelemetryCollector
   metadata:
     name: otel
     namespace: opentelemetry-collector
   spec:
     mode: deployment
     replicas: 1
     config:
       receivers:
         otlp:
           protocols:
             grpc: {}
             http: {}
         jaeger:
           protocols:
             grpc: {}
             thrift_binary: {}
             thrift_compact: {}
             thrift_http: {}
         zipkin: {}
       processors:
         batch: {}
         memory_limiter:
           check_interval: 1s
           limit_percentage: 80
           spike_limit_percentage: 20
       exporters:
         debug: {}
       service:
         pipelines:
           traces:
             receivers: [otlp, jaeger, zipkin]
             processors: [memory_limiter, batch]
             exporters: [debug]
   EOF
   NOTE

   有关 OpenTelemetryCollector CR 的详细字段说明，请参阅上文通过 Web 控制台部署部分中的 CR 示例。

2. 等待 Collector pod 就绪：

   kubectl wait --for=condition=Ready pod -l app.kubernetes.io/managed-by=opentelemetry-operator -n opentelemetry-collector --timeout=3m

验证

检查 Collector pod 是否正在运行：

kubectl get pods -n opentelemetry-collector

示例输出

NAME                              READY   STATUS    RESTARTS   AGE
otel-collector-7877b4cdcf-bj7br   1/1     Running   0          69s

#卸载

要从集群中移除 Alauda Distributed Tracing 组件，请按照卸载 Alauda Build of OpenTelemetry v2中的说明操作。