-
Notifications
You must be signed in to change notification settings - Fork 7
docs(metrics-operator): add service-provider-metrics-operator docs #191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
GenosseOtt
wants to merge
7
commits into
main
Choose a base branch
from
docs/metrics-operator
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+104
−0
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
464f21a
docs(metrics-operator): add service-provider-metrics-operator to exam…
GenosseOtt 290c768
chore: update examples to latest version
maximiliantech f08afda
docs(metrics-operator): use metrics.svg logo
GenosseOtt 6240a82
Update docs/users/getting-started/03-configure.md
GenosseOtt e0471fe
Update docs/users/getting-started/03-configure.md
GenosseOtt 6b3ad65
Update docs/reference/services/metrics-operator.md
GenosseOtt dc6d359
Update docs/reference/services/metrics-operator.md
GenosseOtt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| sidebar_position: 7 | ||
| id: metrics-operator | ||
| --- | ||
|
|
||
| import CRDViewerCompact from '@site/src/components/CRDViewerCompact'; | ||
|
|
||
| # Metrics Operator | ||
|
|
||
| <div className="crd-header-container"> | ||
| <img src="/img/logos/metrics.svg" alt="Metrics Operator" className="crd-header-icon" /> | ||
| <div className="crd-header-text"> | ||
| <p>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.</p> | ||
| </div> | ||
| </div> | ||
|
|
||
| **API Group:** `metrics.services.open-control-plane.io` | ||
| **API Version:** `v1alpha1` | ||
| **Kind:** `MetricsOperator` | ||
|
|
||
| <CRDViewerCompact | ||
| crdUrl="https://raw.githubusercontent.com/openmcp-project/service-provider-metrics-operator/main/api/crds/manifests/metrics.services.open-control-plane.io_metricsoperators.yaml" | ||
| name="MetricsOperator" | ||
| description="MetricsOperator service provider resource" | ||
| exampleUrl="https://raw.githubusercontent.com/openmcp-project/service-provider-metrics-operator/main/test/e2e/onboarding/metricsoperator.yaml" | ||
| /> | ||
|
|
||
| ## 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: extract the octocat as
/img/logos/octocat.svg?