分布式追踪

流程

1. 以具有 cluster-admin 角色的用户身份登录到 OpenShift Container Platform web 控制台。如果使用 Red Hat OpenShift Dedicated，则必须有一个具有 dedicated-admin 角色的帐户。
2. 导航至 Operators → OperatorHub。
3. 在过滤器框中键入 Elasticsearch 以找到 OpenShift Elasticsearch Operator。
4. 点由红帽提供的 OpenShift Elasticsearch Operator 来显示有关 Operator 的信息。
5. 点击 Install。
6. 在 Install Operator 页中，选择 stable Update Channel。这可在发布新版本时自动更新您的 Operator。

7. 接受默认的 All namespaces on the cluster (default)。这会在默认的 openshift-operators-redhat 项目中安装 Operator，并使 Operator 可供集群中的所有项目使用。

   注意

   Elasticsearch 安装需要 OpenShift Elasticsearch Operator 的 openshift-operators-redhat 命名空间。其他 Red Hat OpenShift distributed tracing Platform Operator 安装在 openshift-operators 命名空间中。

8. 接受默认的 Automatic 批准策略。默认情况下，当这个 Operator 的新版本可用时，Operator Lifecycle Manager(OLM)将自动升级 Operator 的运行实例，而无需人为干预。如果选择手动 更新，则当有新版 Operator 可用时，OLM 会创建更新请求。作为集群管理员，您必须手动批准该更新请求，才可将 Operator 更新至新版本。

   注意

   Manual 批准策略需要具有适当凭证的用户批准 Operator 的安装和订阅过程。

9. 点击 Install。
10. 在 Installed Operators 页面中，选择 openshift-operators-redhat 项目。等待 OpenShift Elasticsearch Operator 的状态显示为 "InstallSucceeded" 后再继续进行操作。

流程

1. 以具有 cluster-admin 角色的用户身份登录到 OpenShift Container Platform web 控制台。如果使用 Red Hat OpenShift Dedicated，则必须有一个具有 dedicated-admin 角色的帐户。
2. 导航至 Operators → OperatorHub。
3. 在过滤器中输入 distributed tracing platform 找到 Red Hat OpenShift distributed tracing platform (Jaeger) Operator。
4. 点由红帽提供的 Red Hat OpenShift distributed tracing Platform (Jaeger) Operator 来显示有关 Operator 的信息。
5. 点 Install。
6. 在 Install Operator 页中，选择 stable Update Channel。这可在发布新版本时自动更新您的 Operator。

7. 接受默认的 All namespaces on the cluster (default)。这会在默认的 openshift-operators 项目中安装 Operator ，并使其可以被集群中的所有项目使用。

   • 接受默认的 Automatic 批准策略。默认情况下，当这个 Operator 的新版本可用时，Operator Lifecycle Manager(OLM)将自动升级 Operator 的运行实例，而无需人为干预。如果选择手动 更新，则当有新版 Operator 可用时，OLM 会创建更新请求。作为集群管理员，您必须手动批准该更新请求，才可将 Operator 更新至新版本。

     注意

     Manual 批准策略需要具有适当凭证的用户批准 Operator 的安装和订阅过程。

8. 点 Install。
9. 导航到 Operators → Installed Operators。
10. 在 Installed Operators 页面中，选择 openshift-operators 项目。等待 Red Hat OpenShift distributed tracing Platform (Jaeger) Operator 的状态显示为 "Succeeded"，然后再继续。

步骤

1. 以具有 cluster-admin 角色的用户身份登录到 OpenShift Container Platform web 控制台。

2. 创建一个新项目，如 tracing-system。

   注意

   如果您要作为 Service Mesh 的一部分安装，则分布式追踪平台资源必须与 ServiceMeshControlPlane 资源位于同一个命名空间中，如 istio-system。

   1. 进入 Home → Projects。
   2. 点击 Create Project。
   3. 在 Name 字段中输入 tracing-system。
   4. 点 Create。
3. 导航到 Operators → Installed Operators。
4. 如有必要，从 Project 菜单中选择 tracing-system。您可能需要等待一些时间，让 Operator 复制到新项目中。
5. 点 Red Hat OpenShift distributed tracing Platform (Jaeger) Operator。在 Details 标签页中的 Provided APIs 下，Operator 提供了一个单个链接。
6. 在 Jaeger 下，点 Create Instance。
7. 在 Create Jaeger 页面上，要使用默认值进行安装，请点 Create 来创建分布式追踪平台(Jaeger)实例。
8. 在 Jaegers 页面上，点分布式追踪平台(Jaeger)实例的名称，如 jaeger-all-in-one-inmemory。
9. 在 Jaeger Details 页面上，点击 Resources 选项卡。等待 pod 的状态变为"Running"再继续操作。

步骤

1. 以具有 cluster-admin 角色的用户身份登录到 OpenShift Container Platform web 控制台。

2. 创建一个新项目，如 tracing-system。

   注意

   如果您要作为 Service Mesh 的一部分安装，则分布式追踪平台资源必须与 ServiceMeshControlPlane 资源位于同一个命名空间中，如 istio-system。

   1. 浏览至 Home → Project。
   2. 点击 Create Project。
   3. 在 Name 字段中输入 tracing-system。
   4. 点 Create。
3. 导航到 Operators → Installed Operators。
4. 如有必要，从 Project 菜单中选择 tracing-system。您可能需要等待一些时间，让 Operator 复制到新项目中。
5. 点 Red Hat OpenShift distributed tracing Platform (Jaeger) Operator。在 Overview 选项卡上的 Provided APIs 下，Operator 提供了单个链接。
6. 在 Jaeger 下，点 Create Instance。

7. 在 Create Jaeger 页面上，将默认的 all-in-one YAML 文本替换为您的生产环境的 YAML 配置，例如：

   使用 Elasticsearch 的示例 jaeger-production.yaml 文件

   apiVersion: jaegertracing.io/v1
   kind: Jaeger
   metadata:
     name: jaeger-production
     namespace:
   spec:
     strategy: production
     ingress:
       security: oauth-proxy
     storage:
       type: elasticsearch
       elasticsearch:
         nodeCount: 3
         redundancyPolicy: SingleRedundancy
       esIndexCleaner:
         enabled: true
         numberOfDays: 7
         schedule: 55 23 * * *
       esRollover:
         schedule: '*/30 * * * *'

8. 点 Create 创建分布式追踪平台(Jaeger)实例。
9. 在 Jaegers 页面上，点分布式追踪平台(Jaeger)实例的名称，如 jaeger-prod-elasticsearch。
10. 在 Jaeger Details 页面上，点击 Resources 选项卡。等到所有 Pod 的状态变为“Running”再继续操作。

步骤

1. 以具有 cluster-admin 角色的用户身份登录到 OpenShift Container Platform web 控制台。

2. 创建一个新项目，如 tracing-system。

   注意

   如果您要作为 Service Mesh 的一部分安装，则分布式追踪平台资源必须与 ServiceMeshControlPlane 资源位于同一个命名空间中，如 istio-system。

   1. 浏览至 Home → Project。
   2. 点击 Create Project。
   3. 在 Name 字段中输入 tracing-system。
   4. 点 Create。
3. 导航到 Operators → Installed Operators。
4. 如有必要，从 Project 菜单中选择 tracing-system。您可能需要等待一些时间，让 Operator 复制到新项目中。
5. 点 Red Hat OpenShift distributed tracing Platform (Jaeger) Operator。在 Overview 选项卡上的 Provided APIs 下，Operator 提供了单个链接。
6. 在 Jaeger 下，点 Create Instance。

7. 在 Create Jaeger 页面上，将默认的 all-in-one YAML 文本替换为您的流传输 YAML 配置，例如：

   示例 Jaeger-streaming.yaml 文件

   apiVersion: jaegertracing.io/v1
   kind: Jaeger
   metadata:
     name: jaeger-streaming
   spec:
     strategy: streaming
     collector:
       options:
         kafka:
           producer:
             topic: jaeger-spans
             brokers: my-cluster-kafka-brokers.kafka:9092 1
     storage:
       type: elasticsearch
     ingester:
       options:
         kafka:
           consumer:
             topic: jaeger-spans
             brokers: my-cluster-kafka-brokers.kafka:9092

   1

   如果没有定义代理，AMQStreams 1.4.0+ self-provisions Kafka。

8. 点 Create 创建分布式追踪平台(Jaeger)实例。
9. 在 Jaegers 页面上，点分布式追踪平台(Jaeger)实例的名称，如 jaeger-streaming。
10. 在 Jaeger Details 页面上，点击 Resources 选项卡。等到所有 Pod 的状态变为“Running”再继续操作。

流程

1. 登陆到 OpenShift Container Platform Web 控制台。
2. 导航到 Operators → Installed Operators。
3. 从 Project 菜单中选择 Operators 安装的项目名称，如 openshift-operators。
4. 点 Red Hat OpenShift distributed tracing Platform (Jaeger) Operator。
5. 点 Jaeger 标签页。
6. 点击您要删除 的实例旁的 Options 菜单，然后选择 Delete Jaeger。
7. 在确认信息中，点击 Delete。

流程

1. 运行以下命令，使用 OpenShift CLI (oc) 登录：

   $ oc login --username=<NAMEOFUSER>

2. 要显示分布式追踪平台(Jaeger)实例，请运行以下命令：

   $ oc get deployments -n <jaeger-project>

   例如，

   $ oc get deployments -n openshift-operators

   Operator 的名称具有后缀 -operator。以下示例显示了两个 Red Hat OpenShift distributed tracing Platform (Jaeger) Operator 和四个分布式追踪平台(Jaeger)实例：

   $ oc get deployments -n openshift-operators

   您将看到类似如下的输出：

   NAME                     READY   UP-TO-DATE   AVAILABLE   AGE
   elasticsearch-operator   1/1     1            1           93m
   jaeger-operator          1/1     1            1           49m
   jaeger-test              1/1     1            1           7m23s
   jaeger-test2             1/1     1            1           6m48s
   tracing1                 1/1     1            1           7m8s
   tracing2                 1/1     1            1           35m

3. 要删除分布式追踪平台(Jaeger)的实例，请运行以下命令：

   $ oc delete jaeger <deployment-name> -n <jaeger-project>

   例如：

   $ oc delete jaeger tracing2 -n openshift-operators

4. 要验证删除过程，请再次运行 oc get deployments 命令：

   $ oc get deployments -n <jaeger-project>

   例如：

   $ oc get deployments -n openshift-operators

   您将看到生成的输出类似以下示例：

   NAME                     READY   UP-TO-DATE   AVAILABLE   AGE
   elasticsearch-operator   1/1     1            1           94m
   jaeger-operator          1/1     1            1           50m
   jaeger-test              1/1     1            1           8m14s
   jaeger-test2             1/1     1            1           7m39s
   tracing1                 1/1     1            1           7m59s

流程

1. 按照从集群中删除 Operator 中的说明，删除 Red Hat OpenShift distributed tracing Platform (Jaeger) Operator。
2. 可选： 删除 Red Hat OpenShift distributed tracing Platform (Jaeger) Operator 后，删除 OpenShift Elasticsearch Operator。

流程

1. 安装 Tempo Operator：

   1. 进入 Operators → OperatorHub 并搜索 Tempo Operator。

   2. 选择 Tempo Operator，OpenShift Operator for Tempo → Install → Install → View Operator.

      重要

      这会使用默认预设置来安装 Operator：

      • Update channel → stable
      • Installation mode → All namespaces on the cluster
      • Installed Namespace → openshift-tempo-operator
      • Update approval → Automatic
   3. 在已安装 Operator 页面的 Details 选项卡中，在 ClusterServiceVersion details 下验证安装 Status 是否为 Succeeded。
2. 为您要在后续步骤中创建的 TempoStack 实例创建一个项目： 进入 Home → Projects → Create Project。

3. 在您为 TempoStack 实例创建的项目中，为您的对象存储桶创建一个 secret：进入 Workloads → Secrets → Create → From YAML。

   Amazon S3 和 MinIO 存储的 secret 示例

   apiVersion: v1
   kind: Secret
   metadata:
     name: minio-test
   stringData:
     endpoint: http://minio.minio.svc:9000
     bucket: tempo
     access_key_id: tempo
     access_key_secret: <secret>
   type: Opaque

4. 创建 TempoStack 实例。

   注意

   您可以在同一集群中的独立项目中创建多个 TempoStack 实例。

   1. 进入 Operators → Installed Operators。
   2. 选择 TempoStack → Create TempoStack → YAML view。

   3. 在 YAML 视图中，自定义 TempoStack 自定义资源(CR)：

      apiVersion: tempo.grafana.com/v1alpha1
      kind: TempoStack
      metadata:
        name: sample
        namespace: <project_of_tempostack_instance>
      spec:
        storageSize: 1Gi
        storage:
          secret:
            name: <secret-name> 1
            type: <secret-provider> 2
        template:
          queryFrontend:
            jaegerQuery:
              enabled: true
              ingress:
                route:
                  termination: edge
                type: route

      1

      secret metadata 中 name 的值。

      2

      可接受的值是 azure（Azure Blob Storage），gcs（Google Cloud Storage）和 s3（Amazon S3, MinIO, 或 Red Hat OpenShift Data Foundation）。

      AWS S3 和 MinIO 存储的 TempoStack CR 示例

      apiVersion: tempo.grafana.com/v1alpha1
      kind: TempoStack
      metadata:
        name: simplest
        namespace: <project_of_tempostack_instance>
      spec:
        storageSize: 1Gi
        storage:
          secret:
            name: minio-test
            type: s3
        resources:
          total:
            limits:
              memory: 2Gi
              cpu: 2000m
        template:
          queryFrontend:
            jaegerQuery:
              enabled: true
              ingress:
                route:
                  termination: edge
                type: route

      本例中部署的堆栈被配置为接收通过 HTTP 和 OpenTelemetry 协议(OTLP)的 Jaeger Thrift，它允许使用 Jaeger UI 可视化数据。

   4. 选择 Create。

验证

1. 使用 Project: 下拉列表选择 TempoStack 实例的项目。
2. 进入 Operators → Installed Operators，以验证 TempoStack 实例的 Status 是否为 Condition: Ready。
3. 进入 Workloads → Pods，以验证 TempoStack 实例的所有组件 pod 都在运行。

4. 访问 Tempo 控制台：

   1. 进入 Networking → Routes 和 Ctrl+F，以搜索 tempo。
   2. 在 Location 列中，打开 URL 以访问 Tempo 控制台。

   3. 选择 Log In With OpenShift，将集群管理员凭证用于 Web 控制台。

      注意

      Tempo 控制台最初不会在 Tempo 控制台安装后显示 trace 数据。

流程

1. 安装 Tempo Operator：

   1. 运行以下命令，为 Tempo Operator 创建项目：

      $ oc apply -f - << EOF
      apiVersion: project.openshift.io/v1
      kind: Project
      metadata:
        labels:
          kubernetes.io/metadata.name: openshift-tempo-operator
          openshift.io/cluster-monitoring: "true"
        name: openshift-tempo-operator
      EOF

   2. 运行以下命令来创建 Operator 组：

      $ oc apply -f - << EOF
      apiVersion: operators.coreos.com/v1
      kind: OperatorGroup
      metadata:
        name: openshift-tempo-operator
        namespace: openshift-tempo-operator
      spec:
        upgradeStrategy: Default
      EOF

   3. 运行以下命令来创建订阅：

      $ oc apply -f - << EOF
      apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
        name: tempo-product
        namespace: openshift-tempo-operator
      spec:
        channel: stable
        installPlanApproval: Automatic
        name: tempo-product
        source: redhat-operators
        sourceNamespace: openshift-marketplace
      EOF

   4. 运行以下命令检查 Operator 状态：

      $ oc get csv -n openshift-tempo-operator

2. 运行以下命令，为您将在后续步骤中创建的 TempoStack 实例创建您选择的项目：

   $ oc apply -f - << EOF
   apiVersion: project.openshift.io/v1
   kind: Project
   metadata:
     name: <project_of_tempostack_instance>
   EOF

3. 在您为 TempoStack 实例创建的项目中，运行以下命令来为您的对象存储桶创建一个 secret：

   $ oc apply -f - << EOF
   <object_storage_secret>
   EOF

   Amazon S3 和 MinIO 存储的 secret 示例

   apiVersion: v1
   kind: Secret
   metadata:
     name: minio-test
   stringData:
     endpoint: http://minio.minio.svc:9000
     bucket: tempo
     access_key_id: tempo
     access_key_secret: <secret>
   type: Opaque

4. 在您为 TempoStack 实例创建的项目中创建一个 TempoStack 实例。

   注意

   您可以在同一集群中的独立项目中创建多个 TempoStack 实例。

   1. 自定义 TempoStack 自定义资源(CR)：

      apiVersion: tempo.grafana.com/v1alpha1
      kind: TempoStack
      metadata:
        name: sample
        namespace: <project_of_tempostack_instance>
      spec:
        storageSize: 1Gi
        storage:
            secret:
                name: <secret-name> 1
                type: <secret-provider> 2
        template:
          queryFrontend:
            jaegerQuery:
              enabled: true
              ingress:
                route:
                  termination: edge
                type: route

      1

      secret metadata 中 name 的值。

      2

      可接受的值是 azure（Azure Blob Storage），gcs（Google Cloud Storage）和 s3（Amazon S3, MinIO, 或 Red Hat OpenShift Data Foundation）。

      AWS S3 和 MinIO 存储的 TempoStack CR 示例

      apiVersion: tempo.grafana.com/v1alpha1
      kind: TempoStack
      metadata:
        name: simplest
        namespace: project_of_tempostack_instance
      spec:
        storageSize: 1Gi
        storage:
          secret:
            name: minio-test
            type: s3
        resources:
          total:
            limits:
              memory: 2Gi
              cpu: 2000m
        template:
          queryFrontend:
            jaegerQuery:
              enabled: true
              ingress:
                route:
                  termination: edge
                type: route

      本例中部署的堆栈被配置为接收通过 HTTP 和 OpenTelemetry 协议(OTLP)的 Jaeger Thrift，它允许使用 Jaeger UI 可视化数据。

   2. 运行以下命令来应用自定义 CR。

      $ oc apply -f - << EOF
      <TempoStack_custom_resource>
      EOF

验证

1. 运行以下命令，验证所有 TempoStack 组件 的状态是否为 Running，并且条件为 type: Ready ：

   $ oc get tempostacks.tempo.grafana.com simplest -o yaml

2. 运行以下命令，验证所有 TempoStack 组件 pod 是否正在运行：

   $ oc get pods

3. 访问 Tempo 控制台：

   1. 运行以下命令来查询路由详情：

      $ export TEMPO_URL=$(oc get route -n <control_plane_namespace> tempo -o jsonpath='{.spec.host}')

   2. 在网页浏览器中打开 https://<route_from_previous_step>。

   3. 使用 Web 控制台的集群管理员凭证登录。

      注意

      Tempo 控制台最初不会在 Tempo 控制台安装后显示 trace 数据。

流程

1. 进入 Operators → Installed Operators → Tempo Operator → TempoStack。
2. 要删除 TempoStack 实例，请选择 → Delete TempoStack → Delete。
3. 可选：删除 Tempo Operator。

流程

1. 运行以下命令，获取 TempoStack 实例的名称：

   $ oc get deployments -n <project_of_tempostack_instance>

2. 运行以下命令来删除 TempoStack 实例：

   $ oc delete tempo <tempostack_instance_name> -n <project_of_tempostack_instance>

3. 可选：删除 Tempo Operator。

验证

1. 运行以下命令，以验证输出中没有找到 TempoStack 实例，这表示其删除成功：

   $ oc get deployments -n <project_of_tempostack_instance>