Skip to content
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

Specify the default batch mode for each backend type. #49809

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

MohammadAlavi1986
Copy link
Contributor

Specify the default batch mode for each backend type.

The default batch mode for webhook backend is batch and blocking for log backend. However, the current documentation gives the impression that batch is the default mode for both backend types.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign rayandas for approval. For more information see the Code Review Process.

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

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

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 17, 2025
Copy link

netlify bot commented Feb 17, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit cc8fd81
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67d6d321836c3d000850f237
😎 Deploy Preview https://deploy-preview-49809--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

- `batch` - buffer events and asynchronously process them in batches. This is the default.
- `blocking` - block API server responses on processing each individual event.
- `batch` - buffer events and asynchronously process them in batches. This is the default mode for `webhook` backend.
- `blocking` - block API server responses on processing each individual event. This is the default mode for `log` backend.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure this is relevant to a description of the --audit-webhook-mode command line argument. I think this detail belongs elsewhere in the document @MohammadAlavi1986

Copy link
Contributor Author

@MohammadAlavi1986 MohammadAlavi1986 Feb 17, 2025

Choose a reason for hiding this comment

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

To get the same flag for log backend, replace webhook with log in the flag name

I think the documentation focuses only on the webhook backend flags for brevity, as the log backend flags are identical.

@sftim
Copy link
Contributor

sftim commented Mar 14, 2025

@MohammadAlavi1986 would you have capacity / be willing to revise this based on feedback so far?

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 16, 2025
@MohammadAlavi1986
Copy link
Contributor Author

@MohammadAlavi1986 would you have capacity / be willing to revise this based on feedback so far?

I added tabs to list flags specific to each backend separately. I also added --audit-*-batch-throttle-enable flag to the list of flags and specified the default value for each flag.

@MohammadAlavi1986 MohammadAlavi1986 requested a review from sftim March 16, 2025 13:41
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 19, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 8d64615348974a26e2ec663ac598ed7e0ef46ac9

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants