Chapter 1. Installing

Procedure

1. Install the Red Hat build of OpenTelemetry Operator:

   1. In the web console, search for Red Hat build of OpenTelemetry Operator.

      Tip

      In OpenShift Container Platform 4.19 or earlier, go to Operators OperatorHub.

      In OpenShift Container Platform 4.20 or later, go to Ecosystem Software Catalog.

   2. Select the Red Hat build of OpenTelemetry Operator that is provided by Red Hat Install Install View Operator.

      Important

      This installs the Operator with the default presets:

      • Update channel stable
      • Installation mode All namespaces on the cluster
      • Installed Namespace openshift-opentelemetry-operator
      • Update approval Automatic
   3. In the Details tab of the installed Operator page, under ClusterServiceVersion details, verify that the installation Status is Succeeded.
2. Create a permitted project of your choice for the OpenTelemetry Collector instance that you will create in the next step by going to Home Projects Create Project. Project names beginning with the openshift- prefix are not permitted.

3. Create an OpenTelemetry Collector instance.

   1. Go to Ecosystem Installed Operators.
   2. Select OpenTelemetry Collector Create OpenTelemetry Collector YAML view.

   3. In the YAML view, customize the OpenTelemetryCollector custom resource (CR):

      Example OpenTelemetryCollector CR

      apiVersion: opentelemetry.io/v1beta1
      kind: OpenTelemetryCollector
      metadata:
        name: otel
        namespace: <permitted_project_of_opentelemetry_collector_instance>
      spec:
        mode: <deployment_mode>
        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: 50
              spike_limit_percentage: 30
          exporters:
            debug: {}
          service:
            pipelines:
              traces:
                receivers: [otlp,jaeger,zipkin]
                processors: [memory_limiter,batch]
                exporters: [debug]

      where:

      namespace

      Project that you have chosen for the OpenTelemetryCollector deployment. Project names beginning with the openshift- prefix are not permitted.

      mode

      Deployment mode with the following supported values: the default deployment, daemonset, statefulset, or sidecar. For details, see Deployment Modes.

      receivers

      For details, see Receivers.

      processors

      For details, see Processors.

      exporters

      For details, see Exporters.

   4. Select Create.

Verification

1. Use the Project: dropdown list to select the project of the OpenTelemetry Collector instance.
2. Go to Ecosystem Installed Operators to verify that the Status of the OpenTelemetry Collector instance is Condition: Ready.
3. Go to Workloads Pods to verify that all the component pods of the OpenTelemetry Collector instance are running.

Procedure

1. Install the Red Hat build of OpenTelemetry Operator:

   1. Create a project for the Red Hat build of OpenTelemetry Operator by running the following command:

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

   2. Create an Operator group by running the following command:

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

   3. Create a subscription by running the following command:

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

   4. Check the Operator status by running the following command:

      $ oc get csv -n openshift-opentelemetry-operator

2. Create a permitted project of your choice for the OpenTelemetry Collector instance that you will create in a subsequent step:

   • To create a permitted project without metadata, run the following command:

     $ oc new-project <permitted_project_of_opentelemetry_collector_instance>

     where:

     <permitted_project_of_opentelemetry_collector_instance>

     Project names beginning with the openshift- prefix are not permitted.

   • To create a permitted project with metadata, run the following command:

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

     where:

     name

     Project names beginning with the openshift- prefix are not permitted.

3. Create an OpenTelemetry Collector instance in the project that you created for it.

   Note

   You can create multiple OpenTelemetry Collector instances in separate projects on the same cluster.

   1. Customize the OpenTelemetryCollector custom resource (CR):

      Example OpenTelemetryCollector CR

      apiVersion: opentelemetry.io/v1beta1
      kind: OpenTelemetryCollector
      metadata:
        name: otel
        namespace: <permitted_project_of_opentelemetry_collector_instance>
      spec:
        mode: <deployment_mode>
        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: 50
              spike_limit_percentage: 30
          exporters:
            debug: {}
          service:
            pipelines:
              traces:
                receivers: [otlp,jaeger,zipkin]
                processors: [memory_limiter,batch]
                exporters: [debug]

      where:

      namespace

      Project that you have chosen for the OpenTelemetryCollector deployment. Project names beginning with the openshift- prefix are not permitted.

      mode

      Deployment mode with the following supported values: the default deployment, daemonset, statefulset, or sidecar. For details, see Deployment Modes.

      receivers

      For details, see Receivers.

      processors

      For details, see Processors.

      exporters

      For details, see Exporters.

   2. Apply the customized CR by running the following command:

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

Verification

1. Verify that the status.phase of the OpenTelemetry Collector pod is Running and the conditions are type: Ready by running the following command:

   $ oc get pod -l app.kubernetes.io/managed-by=opentelemetry-operator,app.kubernetes.io/instance=<namespace>.<instance_name> -o yaml

2. Get the OpenTelemetry Collector service by running the following command:

   $ oc get service -l app.kubernetes.io/managed-by=opentelemetry-operator,app.kubernetes.io/instance=<namespace>.<instance_name>