[WIP] improve: health probes showcase & docs to operations#3291
[WIP] improve: health probes showcase & docs to operations#3291csviri wants to merge 2 commits intooperator-framework:mainfrom
Conversation
- rename of the module to operations - showcase health probes Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
openshift-ci
bot
added
the
do-not-merge/work-in-progress
csviri
changed the title
csviri
changed the title
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Renames the metrics-processing sample to operations and updates docs / CI references accordingly.
Changes:
- Switches the parent Maven module entry from
metrics-processingtooperations. - Updates E2E Helm values, E2E test constants, and OTEL resource attributes to use the new
operationsnaming. - Updates documentation and the E2E GitHub Actions workflow to reference
sample-operators/operations.
Reviewed changes
Copilot reviewed 9 out of 19 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| sample-operators/pom.xml | Updates the aggregated module list to reference operations. |
| sample-operators/metrics-processing/src/test/resources/helm-values.yaml | Renames image repository / nameOverride to operations-operator. |
| sample-operators/metrics-processing/src/test/java/.../MetricsHandlingE2E.java | Updates Helm release name to operations. |
| sample-operators/metrics-processing/src/main/java/.../MetricsHandlingSampleOperator.java | Updates OTEL resource attribute value from metrics-processing to operations. |
| sample-operators/metrics-processing/pom.xml | Renames artifact / image / display metadata to operations. |
| docs/content/en/docs/documentation/operations/metrics.md | Updates links from metrics-processing to operations. |
| docs/content/en/docs/documentation/operations/helm-chart.md | Updates narrative + example YAML + links to operations. |
| docs/content/en/blog/releases/v5-3-release.md | Updates sample operator link to operations. |
| .github/workflows/e2e-test.yml | Updates the E2E workflow to run sample-operators/operations. |
| <module>leader-election</module> | ||
| <module>controller-namespace-deletion</module> | ||
| <module>metrics-processing</module> | ||
| <module>operations</module> |
There was a problem hiding this comment.
This changes the Maven reactor module to operations, but the PR diff still shows the sample’s POM and sources under sample-operators/metrics-processing/.... If the directory rename to sample-operators/operations isn’t included, the build will fail because Maven won’t find sample-operators/operations/pom.xml. Either rename/move the module directory (and adjust paths accordingly) or keep the module entry pointing to metrics-processing.
| <module>operations</module> | |
| <module>metrics-processing</module> |
| - "sample-operators/webpage" | ||
| - "sample-operators/leader-election" | ||
| - "sample-operators/metrics-processing" | ||
| - "sample-operators/operations" |
There was a problem hiding this comment.
The E2E workflow now targets sample-operators/operations. If the module directory isn’t actually renamed in this PR (the diff still shows tests/resources under sample-operators/metrics-processing), CI will likely fail because the path won’t exist. Align the workflow path with the actual checked-in directory name, or include the directory rename in the PR.
| - "sample-operators/operations" | |
| - "sample-operators/metrics-processing" |
| [`operations` sample operator](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators/operations) | ||
| includes a full end-to-end test, | ||
| [`MetricsHandlingE2E`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/metrics-processing/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java), | ||
| [`MetricsHandlingE2E`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/operations/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java), |
There was a problem hiding this comment.
Docs links were updated to point at sample-operators/operations/..., but in this PR diff the referenced files are still located under sample-operators/metrics-processing/.... If the directory rename isn’t part of the PR, these links will be broken. Either include the directory move/rename so the links resolve, or update the links to match the actual location.
Signed-off-by: Attila Mészáros a_meszaros@apple.com