Skip to content

improve: health probes showcase & docs to operations#3291

Open
csviri wants to merge 35 commits intooperator-framework:mainfrom
csviri:operations-health
Open

improve: health probes showcase & docs to operations#3291
csviri wants to merge 35 commits intooperator-framework:mainfrom
csviri:operations-health

Conversation

@csviri
Copy link
Copy Markdown
Collaborator

@csviri csviri commented Apr 13, 2026

  • showcase health probes
  • rename of the metrics processing module to operations
  • improves on diagnostic logs

Signed-off-by: Attila Mészáros a_meszaros@apple.com

Copilot AI review requested due to automatic review settings April 13, 2026 12:48
@csviri csviri marked this pull request as draft April 13, 2026 12:48
@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 13, 2026
@openshift-ci openshift-ci Bot requested review from metacosm and xstefank April 13, 2026 12:48
@csviri csviri changed the title improve: metrics processing to showcase all operations [WIP] improve: metrics processing to showcase all operations Apr 13, 2026
@csviri csviri changed the title [WIP] improve: metrics processing to showcase all operations [WIP] improve: health probes showcase & docs to operations Apr 13, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-processing to operations.
  • Updates E2E Helm values, E2E test constants, and OTEL resource attributes to use the new operations naming.
  • 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.

Comment thread sample-operators/pom.xml
Comment thread .github/workflows/e2e-test.yml
Comment thread docs/content/en/docs/documentation/operations/metrics.md Outdated
@csviri csviri linked an issue Apr 13, 2026 that may be closed by this pull request
@csviri csviri marked this pull request as ready for review April 17, 2026 09:35
@csviri csviri force-pushed the operations-health branch from 4140f1d to c527bf1 Compare April 17, 2026 09:36
@csviri csviri changed the title [WIP] improve: health probes showcase & docs to operations improve: health probes showcase & docs to operations Apr 17, 2026
@openshift-ci openshift-ci Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 17, 2026
@csviri
Copy link
Copy Markdown
Collaborator Author

csviri commented Apr 17, 2026

@xstefank @metacosm this is now ready for review, PTAL, thank you!

Comment thread docs/content/en/docs/documentation/operations/health-probes.md
Comment thread helm/generic-helm-chart/templates/deployment.yaml
@openshift-ci openshift-ci Bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 23, 2026
@csviri csviri force-pushed the operations-health branch from ddde815 to d21401e Compare April 24, 2026 10:56
@openshift-ci openshift-ci Bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 24, 2026
@csviri csviri force-pushed the operations-health branch 2 times, most recently from d25a1fc to 3b935e8 Compare April 28, 2026 07:13
@csviri csviri requested review from Copilot, metacosm and xstefank April 28, 2026 08:27
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 26 out of 28 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (2)

sample-operators/operations/src/test/java/io/javaoperatorsdk/operator/sample/operations/OperationsE2E.java:394

  • runCommand reads stdout fully and only then reads stderr. If the process writes enough data to stderr to fill the buffer, it can block and the test will hang. Prefer redirectErrorStream(true) (single reader) or drain stdout/stderr concurrently (e.g., separate threads) before waitFor().
    sample-operators/operations/src/main/java/io/javaoperatorsdk/operator/sample/operations/OperationsSampleOperator.java:66
  • The startup log line still says "Metrics Handling Sample Operator starting!" after the module/class were renamed to operations. This makes logs confusing when running the sample; update the message to reflect the new operator name.

Comment thread docs/content/en/docs/documentation/operations/helm-chart.md Outdated
Comment thread helm/generic-helm-chart/values.yaml Outdated
@csviri csviri force-pushed the operations-health branch from bab062f to eaa0bb8 Compare April 28, 2026 11:14
csviri and others added 27 commits April 29, 2026 14:12
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
…ator/junit/ClusterDeployedOperatorExtension.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
…ator/junit/ClusterDeployedOperatorExtension.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
@csviri csviri force-pushed the operations-health branch from eef95ca to df8bb9e Compare April 29, 2026 12:12
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
probes:
startup:
enabled: true
path: /health
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/health/startup

Copy link
Copy Markdown
Collaborator Author

@csviri csviri Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in this sample we are using the same endpoint, actually it we should think rather to remove startup probe, I added it here since some might need it for long running startup, but that probe can be used for both ready and startup.

So as far I can see it is correct as it is.

Comment thread sample-operators/operations/src/test/resources/helm-values.yaml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document and showcase health probes in operations sample

4 participants