diff --git a/docs/developers/serviceprovider/06-examples.mdx b/docs/developers/serviceprovider/06-examples.mdx index a436418..d75d004 100644 --- a/docs/developers/serviceprovider/06-examples.mdx +++ b/docs/developers/serviceprovider/06-examples.mdx @@ -115,6 +115,20 @@ Community Service Providers that extend OpenControlPlane. Use these as inspirati +
+
+ Metrics Operator Service Provider +

service-provider-metrics-operator

+
+
+ Integrates the Prometheus metrics-operator into OpenControlPlane for metrics collection and alerting on managed workloads. +
+
+ GitHub + CRD Browser +
+
+ ## Community Service Providers diff --git a/docs/reference/services/metrics-operator.md b/docs/reference/services/metrics-operator.md new file mode 100644 index 0000000..184607a --- /dev/null +++ b/docs/reference/services/metrics-operator.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 7 +id: metrics-operator +--- + +import CRDViewerCompact from '@site/src/components/CRDViewerCompact'; + +# Metrics Operator + +
+ Metrics Operator +
+

Delivers the OTel [metrics-operator](https://github.com/openmcp-project/metrics-operator) as a service within `ControlPlanes`, enabling metrics collection and alerting for managed workloads.

+
+
+ +**API Group:** `metrics.services.open-control-plane.io` +**API Version:** `v1alpha1` +**Kind:** `MetricsOperator` + + + +## Usage + +Deploy the metrics-operator within a control plane: + +```yaml +apiVersion: metrics.services.open-control-plane.io/v1alpha1 +kind: MetricsOperator +metadata: + name: my-controlplane + namespace: project-platform-team--ws-dev +spec: + version: "v1.0.0" +``` + +The MetricsOperator service provider manages the installation and lifecycle of [metrics-operator](https://github.com/openmcp-project/metrics-operator) within your ControlPlane, enabling OTel-based metrics collection and alerting for managed workloads. diff --git a/docs/users/getting-started/03-configure.md b/docs/users/getting-started/03-configure.md index 7cdce60..b1efb51 100644 --- a/docs/users/getting-started/03-configure.md +++ b/docs/users/getting-started/03-configure.md @@ -222,6 +222,33 @@ kubectl apply -f external-secrets.yaml Once installed, you can create `SecretStore` and `ExternalSecret` resources on the ControlPlane to pull secrets from your chosen backend. + + + +[Metrics Operator](https://github.com/openmcp-project/service-provider-metrics-operator) installs the OTel-based metrics-operator into your ControlPlane, enabling metrics collection and alerting for managed workloads. + +To install the Metrics Operator, create a `MetricsOperator` resource in the same namespace and with the same name as your `ControlPlane`: + +:::apply-to-onboarding-api + +```yaml +apiVersion: metrics.services.open-control-plane.io/v1alpha1 +kind: MetricsOperator +metadata: + name: my-controlplane + namespace: project-platform-team--ws-dev +spec: + version: "v1.0.0" +``` + +```bash +kubectl apply -f metrics-operator.yaml +``` + +::: + +The chart version and Helm values are configured by your platform owner via the `ProviderConfig`. See the [MetricsOperator CRD reference](/reference/services/metrics-operator) for the full API. + @@ -282,3 +309,4 @@ Congratulations! You have a working ControlPlane with managed services. Here's w - **[Flux Service Provider](https://github.com/openmcp-project/service-provider-flux)** — GitOps-driven continuous delivery - **[Velero Service Provider](https://github.com/openmcp-project/service-provider-velero)** — Backup and disaster recovery - **[External Secrets Service Provider](https://github.com/openmcp-project/service-provider-external-secrets)** — Sync secrets from external vaults +- **[Metrics Operator Service Provider](https://github.com/openmcp-project/service-provider-metrics-operator)** — Prometheus metrics collection and alerting diff --git a/static/img/logos/metrics.svg b/static/img/logos/metrics.svg new file mode 100644 index 0000000..88c0df9 --- /dev/null +++ b/static/img/logos/metrics.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + \ No newline at end of file