Skip to content

✨ Networking config for default mode webhooks #379

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bhperry
Copy link
Contributor

@bhperry bhperry commented Jun 12, 2025

Summary

API changes to support customizing webhook ports and hostNetwork in Default installation mode

Related issue(s)

open-cluster-management-io/ocm#1035

Summary by CodeRabbit

  • New Features
    • Added support for customizing webhook server configurations in both Default and Hosted deployment modes, including health probe address, metrics address, host network, and port settings.
  • Enhancements
    • Improved validation and default port handling for webhook configurations.
    • Expanded documentation to cover new webhook configuration options and defaults.
  • Bug Fixes
    • Enhanced deep copy functionality to support new webhook configuration structures.

@bhperry bhperry force-pushed the default-webhook-config branch from ffa7865 to 6bcba1c Compare July 8, 2025 17:32
Copy link

coderabbitai bot commented Jul 8, 2025

Warning

Rate limit exceeded

@bhperry has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 9 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ab6dcf9 and dc6f14d.

📒 Files selected for processing (5)
  • operator/v1/0000_01_operator.open-cluster-management.io_clustermanagers.crd.yaml (3 hunks)
  • operator/v1/types_clustermanager.go (3 hunks)
  • operator/v1/zz_generated.deepcopy.go (3 hunks)
  • operator/v1/zz_generated.swagger_doc_generated.go (4 hunks)
  • test/integration/api/clustermanager_test.go (6 hunks)
## Walkthrough

This change extends the ClusterManager CustomResourceDefinition and its Go type definitions to support detailed webhook server configuration for both Default and Hosted deployment modes. It introduces new configuration fields for webhook servers, updates validation rules, augments deep copy logic, and enhances Swagger documentation to reflect these additions. Additionally, a test was updated to reflect changes in default port values for Hosted mode webhook configurations and to add coverage for Default mode default ports.

## Changes

| Files/Paths                                                      | Change Summary                                                                                                                                                                                                                                                                                                                                                                     |
|-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| operator/v1/0000_01_operator.open-cluster-management.io_...yaml | Extended CRD schema: added `default` under `deployOption` with webhook server configuration fields; added new fields (`healthProbeBindAddress`, `hostNetwork`, `metricsBindAddress`) to both `default` and `hosted` webhook configs; added `port` with default 9443 for `default` mode; updated hosted mode webhook configs with new fields and retained port default 443; refined descriptions and validation for webhook configuration fields. |
| operator/v1/types_clustermanager.go                             | Added `DefaultClusterManagerConfiguration` struct; updated `ClusterManagerDeployOption` to include `Default`; extended `WebhookConfiguration` with new fields (`HealthProbeBindAddress`, `MetricsBindAddress`, `HostNetwork`); introduced separate `DefaultWebhookConfiguration` (with `Port` default 9443) and `HostedWebhookConfiguration` (with required `Address` and `Port` default 443); changed `Address` to required only in Hosted mode.              |
| operator/v1/zz_generated.deepcopy.go                            | Added deep copy methods for `DefaultClusterManagerConfiguration`, `DefaultWebhookConfiguration`, and `HostedWebhookConfiguration`; updated `ClusterManagerDeployOption` deep copy logic to handle new `Default` field.                                                                                                                                                            |
| operator/v1/zz_generated.swagger_doc_generated.go               | Added SwaggerDoc methods for `DefaultClusterManagerConfiguration`, `DefaultWebhookConfiguration`, and `HostedWebhookConfiguration`; updated docs for `ClusterManagerDeployOption` and `WebhookConfiguration` to include new fields and detailed descriptions; removed `address` and `port` from base `WebhookConfiguration` Swagger docs and moved them to hosted/default specific docs.                                                        |
| test/integration/api/clustermanager_test.go                     | Replaced `WebhookConfiguration` with `HostedWebhookConfiguration` in Hosted mode tests; clarified default port expectations for Hosted mode; added new test case verifying default port values (9443) for Default mode webhook configurations; retained existing test logic and error checks.                                                                                      |
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@bhperry bhperry force-pushed the default-webhook-config branch 2 times, most recently from 849e553 to b2da1b0 Compare July 8, 2025 18:09
RegistrationWebhookConfiguration WebhookConfiguration `json:"registrationWebhookConfiguration,omitempty"`

// WorkWebhookConfiguration represents the customized webhook-server configuration of work.
// +optional
// +kubebuilder:validation:XValidation:rule="self.address != ''",message="Address is required for hosted webhook configuration"
Copy link
Member

Choose a reason for hiding this comment

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

it seems cel validation is not added in the crd definition? Is it because we are using a lower version of crd gen?

Copy link
Contributor Author

@bhperry bhperry Jul 9, 2025

Choose a reason for hiding this comment

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

@qiujian16 Pushed change to inline common settings in separate Default and Hosted configuration structs. I didn't like that Address was left unused in Default mode. Also we get to keep the simple required Address validation for hosted (instead of CEL) as well as different default ports for each. What do you think?

Copy link
Member

Choose a reason for hiding this comment

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

I think it is ok. We could have a better name for it I think.

Copy link
Member

@qiujian16 qiujian16 left a comment

Choose a reason for hiding this comment

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

/approve

only issue is cel validation is not added in the crd.

Copy link
Contributor

openshift-ci bot commented Jul 9, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bhperry, qiujian16

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

The pull request process is described 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

@openshift-ci openshift-ci bot added the approved label Jul 9, 2025
@bhperry bhperry force-pushed the default-webhook-config branch 2 times, most recently from b859cf1 to ab6dcf9 Compare July 9, 2025 15:16
@bhperry bhperry force-pushed the default-webhook-config branch from ab6dcf9 to dc6f14d Compare July 9, 2025 15:22
}

// WebhookConfiguration has two properties: Address and Port.
// WebhookConfiguration represents customization of webhook servers
Copy link
Member

Choose a reason for hiding this comment

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

actually it is not WebhookConfiguration, I think we could also use this for controller to set healthiness and metrics endpoint?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants