README.md

Multi Cluster Observability AddOn

Description

The multicluster-observability-addon is a pluggable addon working on OCM based on the extensibility provided by addon-framework which automates the collection and forwarding of observability signals to central stores.

This is achieved through the installation of the spoke clusters of dedicated operators for each observability signal:

• Metrics are not supported by this addon. To manage metrics, use the multicluster-observability-operator.

• For Logs the operator installed will be cluster-logging-operator. The addon will also configure an instance of ClusterLogForwarder to forward logs to a configured store.

• For Traces the operator installed will be Red Hat build of OpenTelemetry. The addon will also configure an instance of OpenTelemetryCollector to forward traces to a configued store.

The logging-ocm-addon consists of one component:

• Addon-Manager: Not only manages the installation of the AddOn on spoke clusters. But also builds the manifests that will be deployed to the spoke clusters.

Getting started

Prerequisite

• OCM registration (>= 0.5.0)

Steps

Installing via Kustomize

1. Install the AddOn using Kustomize

   make install-crds
   kubectl apply -k deploy/

2. The addon should now be installed in you hub cluster

   kubectl get ClusterManagementAddOn multicluster-observability-addon

3. The addon will install automatically in spoke clusters once the resources referenced in ClusterManagementAddOn are created.

Installing via MCO

In 2.12, multicluster-observability-operator has the ability to install MCOA using the capabilities field.

1. Create a MultiClusterObservability resource and configure capabilities

   apiVersion: observability.open-cluster-management.io/v1beta2
   kind: MultiClusterObservability
   metadata:
     name: observability
   spec:
     capabilities:
       platform:
         logs:
           collection:
             enabled: true
       userWorkloads:
         logs:
           collection:
             clusterLogForwarder:
               enabled: true
         traces:
           collection:
             instrumentation:
               enabled: true
             openTelemetryCollector:
               enabled: false
     observabilityAddonSpec: {}
     storageConfig:
       metricObjectStorage:
         name: thanos-object-storage
         key: thanos.yaml

   Note: Deploy a custom image by adding the annotation: mco-multicluster_observability_addon-image: quay.io/YOUR_ORG_HERE/multicluster-observability-addon:YOUR_TAG_HERE

2. The addon should now be installed in you hub cluster

   kubectl get ClusterManagementAddOn multicluster-observability-addon

3. The addon will install automatically in spoke clusters once the resources referenced in ClusterManagementAddOn are created.

References

• Open-Cluster-Management: https://github.com/open-cluster-management-io/ocm
• Addon-Framework: https://github.com/open-cluster-management-io/addon-framework
• Multicluster-Observability-Operator: https://github.com/stolostron/multicluster-observability-operator
• Cluster-Logging-Operator: https://github.com/openshift/cluster-logging-operator
• OpenTelemetry-Operator: https://github.com/open-telemetry/opentelemetry-operator