Skip to content

LOG-9400: API description does not list possible values for deliveryMode#3286

Open
Clee2691 wants to merge 1 commit into
openshift:masterfrom
Clee2691:LOG-9400
Open

LOG-9400: API description does not list possible values for deliveryMode#3286
Clee2691 wants to merge 1 commit into
openshift:masterfrom
Clee2691:LOG-9400

Conversation

@Clee2691
Copy link
Copy Markdown
Contributor

@Clee2691 Clee2691 commented May 19, 2026

Description

This PR adds the possible values for DeliveryMode.

/cc @vparfonov
/assign @jcantrill

Links

Summary by CodeRabbit

Release Notes

  • Documentation
    • Clarified valid DeliveryMode values (AtLeastOnce and AtMostOnce) in documentation comments and schema descriptions across multiple output configurations.

@openshift-ci-robot
Copy link
Copy Markdown

openshift-ci-robot commented May 19, 2026

@Clee2691: This pull request references LOG-9400 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.8.0" version, but no target version was set.

Details

In response to this:

Description

This PR adds the possible values for DeliveryMode.

/cc @vparfonov
/assign @jcantrill

Links

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 19, 2026
@openshift-ci openshift-ci Bot requested a review from vparfonov May 19, 2026 22:56
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: d9258b2a-d921-4fa7-8f62-fefdbecf67b5

📥 Commits

Reviewing files that changed from the base of the PR and between 1e78ce5 and a53aa21.

📒 Files selected for processing (3)
  • api/observability/v1/output_types.go
  • bundle/manifests/observability.openshift.io_clusterlogforwarders.yaml
  • config/crd/bases/observability.openshift.io_clusterlogforwarders.yaml

📝 Walkthrough

Walkthrough

This PR improves documentation clarity for the DeliveryMode configuration field across the cluster logging operator's observability API. A source documentation comment was added to explicitly enumerate valid values (AtLeastOnce and AtMostOnce), and consistent formatting was applied to the same information across generated manifest files and CRD definitions for improved readability.

Changes

DeliveryMode Documentation Clarification

Layer / File(s) Summary
DeliveryMode source documentation comment
api/observability/v1/output_types.go
Source code documentation for DeliveryMode now explicitly states the valid enum values are AtLeastOnce and AtMostOnce.
Manifest formatting for DeliveryMode descriptions
bundle/manifests/observability.openshift.io_clusterlogforwarders.yaml, config/crd/bases/observability.openshift.io_clusterlogforwarders.yaml
Blank-line separators were added before "Valid values" text in tuning.deliveryMode descriptions across all output plugin schemas (AzureLogsIngestion, azureMonitor, cloudwatch, elasticsearch, googleCloudLogging, http, kafka, loki, LokiStack, otlp, s3, splunk, syslog) in both the bundle manifest and CRD base for consistent, improved readability.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A doc here, a blank line there,
DeliveryMode values laid bare,
AtLeastOnce, AtMostOnce so bright,
Formatted clean, oh what a sight!
Documentation hops along with care. 📋✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically references the JIRA issue (LOG-9400) and describes the main change: adding documentation for deliveryMode possible values.
Description check ✅ Passed The description includes all mandatory sections (description summary, /cc reviewer, /assign approver) and references the relevant JIRA issue, though some context about the change rationale could be more detailed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@Clee2691
Copy link
Copy Markdown
Contributor Author

/retest

1 similar comment
@vparfonov
Copy link
Copy Markdown
Contributor

/retest

@jcantrill
Copy link
Copy Markdown
Contributor

/approve

@jcantrill
Copy link
Copy Markdown
Contributor

@Clee2691 do we need to run make docs

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 20, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Clee2691, jcantrill

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 20, 2026
@Clee2691
Copy link
Copy Markdown
Contributor Author

@Clee2691 do we need to run make docs

I ran make docs but no changes related to this PR was made to any of the docs.

@Clee2691
Copy link
Copy Markdown
Contributor Author

/retest

@jcantrill
Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label May 20, 2026
@Clee2691
Copy link
Copy Markdown
Contributor Author

/retest

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 20, 2026

@Clee2691: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/functional-target a53aa21 link true /test functional-target

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants