Skip to content

Commit

Permalink
Updates README.md and removes outdated demo
Browse files Browse the repository at this point in the history
  • Loading branch information
JoaoBraveCoding committed Aug 21, 2024
1 parent 3e5d6f7 commit f8de21f
Show file tree
Hide file tree
Showing 39 changed files with 48 additions and 2,640 deletions.
56 changes: 48 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ which automates the collection and forwarding of observability signals to centra

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

- For Metrics the addon will deploy an instance of Prometheus running in agent mode, that will forward metrics to the hub.
- For Metrics, currently the multicluster-observability-operator should be used.

- For Logs the operator installed will be [cluster-logging-operator](https://docs.openshift.com/container-platform/latest/logging/cluster-logging.html). The addon will also configure an instance of [ClusterLogForwarder](https://docs.openshift.com/container-platform/latest/logging/log_collection_forwarding/configuring-log-forwarding.html) to forward logs to a configured store.

Expand All @@ -24,8 +24,6 @@ The logging-ocm-addon consists of one component:
### Prerequisite

- OCM registration (>= 0.5.0)
- cert-manager operator
- multicluster-observability-operator (for metrics)

### Steps

Expand All @@ -42,12 +40,54 @@ $ kubectl apply -k deploy/
$ kubectl get ClusterManagementAddOn multicluster-observability-addon
```

3. The addon can now be installed it managed clusters by creating `ManagedClusterAddOn` resources in their respective namespaces
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](https://github.com/stolostron/multicluster-observability-operator/blob/5d1fc789df365b20951b5fe1c378b5eebb306390/operators/multiclusterobservability/api/v1beta2/multiclusterobservability_types.go#L187-L212).

1. Create a `MultiClusterObservability` resource and configure `capabilities`
```yaml
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
```
## Demo
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`

Steps to deploy a demo of the addon can be found at [demo/README.md](https://github.com/rhobs/multicluster-observability-addon/tree/main/demo#readme)
2. The addon should now be installed in you hub cluster
```shell
$ kubectl get ClusterManagementAddOn multicluster-observability-addon
```

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

- Addon-Framework: [https://github.com/open-cluster-management-io/addon-framework](https://github.com/open-cluster-management-io/addon-framework)
## References
- Open-Cluster-Management: [https://github.com/open-cluster-management-io/ocm](https://github.com/open-cluster-management-io/ocm)
- Addon-Framework: [https://github.com/open-cluster-management-io/addon-framework](https://github.com/open-cluster-management-io/addon-framework)
- Multicluster-Observability-Operator: [https://github.com/stolostron/multicluster-observability-operator](https://github.com/stolostron/multicluster-observability-operator)
- Cluster-Logging-Operator: [https://github.com/openshift/cluster-logging-operator](https://github.com/openshift/cluster-logging-operator)
- OpenTelemetry-Operator: [https://github.com/open-telemetry/opentelemetry-operator](https://github.com/open-telemetry/opentelemetry-operator)
61 changes: 0 additions & 61 deletions demo/README.md

This file was deleted.

13 changes: 0 additions & 13 deletions demo/addon-config/Chart.yaml

This file was deleted.

5 changes: 0 additions & 5 deletions demo/addon-config/charts/logging/Chart.yaml

This file was deleted.

This file was deleted.

This file was deleted.

5 changes: 0 additions & 5 deletions demo/addon-config/charts/logging/values.yaml

This file was deleted.

5 changes: 0 additions & 5 deletions demo/addon-config/charts/tracing/Chart.yaml

This file was deleted.

27 changes: 0 additions & 27 deletions demo/addon-config/charts/tracing/templates/otel-collector.yaml

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion demo/addon-config/charts/tracing/values.yaml

This file was deleted.

22 changes: 0 additions & 22 deletions demo/addon-config/values.yaml

This file was deleted.

5 changes: 0 additions & 5 deletions demo/addon-install/Chart.yaml

This file was deleted.

19 changes: 0 additions & 19 deletions demo/addon-install/templates/logging-url-configmap.yaml

This file was deleted.

47 changes: 0 additions & 47 deletions demo/addon-install/templates/managed-cluster-addon.yaml

This file was deleted.

15 changes: 0 additions & 15 deletions demo/addon-install/templates/tracing-endpoint-configmap.yaml

This file was deleted.

Loading

0 comments on commit f8de21f

Please sign in to comment.