-
Couldn't load subscription status.
- Fork 2
chore: clean-up and improve repository setup #25
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
Conversation
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.
Pull Request Overview
This PR standardizes the operator name, removes legacy v1beta1 CRDs, and updates controller setup calls.
- Renamed
co-metrics-operatorlabels and image references tometrics-operatoracross RBAC, Prometheus, manager, and default configs - Deleted obsolete
clusteraccessesv1beta1 CRDs inconfig/crdand embedded directory - Replaced
setupReconcilersV1beta1withsetupFederatedMetricControllerandsetupFederatedManagedMetricControllerincmd/main.go - Updated Helm chart repository paths and example names in README
Reviewed Changes
Copilot reviewed 51 out of 51 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| config/rbac/*.yaml | Renamed labels co-metrics-operator → metrics-operator |
| config/crd/bases/metrics.cloud.sap_clusteraccesses.yaml | Removed obsolete CRD v1beta1 |
| cmd/main.go | Dropped v1beta1 setup, added federated controllers |
| charts/metrics-operator/values.yaml.tpl & values.yaml | Updated image repository URL |
| README.md | Simplified example resource names |
| PROJECT | Cleaned up deprecated API entries |
Comments suppressed due to low confidence (3)
charts/metrics-operator/values.yaml.tpl:8
- The image repository path includes
github.comin the URL, which looks unusual for a container registry. Please confirm the correct registry path (e.g.,ghcr.io/sap/metrics-operator) and update accordingly.
repository: ghcr.io/sap/github.com/sap/metrics-operator/images/metrics-operator
charts/metrics-operator/values.yaml:8
- The image repository path includes
github.comin the URL, which looks unusual for a container registry. Please confirm the correct registry path (e.g.,ghcr.io/sap/metrics-operator) and update accordingly.
repository: ghcr.io/sap/github.com/sap/metrics-operator/images/metrics-operator
README.md:157
- [nitpick] Using "pod" as the metadata name may conflict with built-in Pod resources and reduce clarity in examples. Consider using a more descriptive and unique example name, such as
metric-pod-count.
name: pod
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.
see comment above
…erator into docs/improvements
|
Work in progress. Still cleaning up some stuff. |
@mirzakopic This error is resolved. I've also enhanced the README with more information on how to quickly get started. Looking forward to your review. Once this is merged, we can proceed in making the metrics-operator public from my side. |
|
Additionally, I would suggest to make a release after this PR is merged. 🚀 |
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.
Lgtm, an example with an open search and metrics ingestion would be great. Maybe as a follow up?
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.
LGTM
Merging this PR now, because all concerns are addressed and reviewed by @moelsayed ✅

This pull request introduces significant updates to the
Makefile,PROJECT, andREADME.mdfiles to enhance the build process, streamline resource definitions, and improve documentation. Key changes include the restructuring of theMakefilefor better organization and functionality, updates to resource paths in thePROJECTfile, and expanded documentation in theREADME.mdto provide more clarity and usability.Build System Enhancements:
Makefilestructure: Added new sections for build dependencies, testing, deployment, and local development utilities. This includes targets for downloading tools likekustomize,golangci-lint, andcontroller-gen, as well as new commands for creating and managing localkindclusters. [1] [2] [3]lintandlint-fixtargets for code quality checks and automated fixes, and restructured thetesttarget for better integration with environment setup. [1] [2]Resource Configuration Updates:
PROJECT: Migrated several resources fromv1beta1tov1alpha1for consistency and alignment with the latest API definitions. This affects resources likeClusterAccess,FederatedMetric, andFederatedManagedMetric.Documentation Improvements:
README.md: Added a detailed table of contents, resource type descriptions with links to CRD files, and sections on data sink integration and migration from legacy configurations. This improves accessibility and clarity for users and contributors. [1] [2]These changes collectively improve the maintainability, usability, and developer experience of the project.