✨ Networking config for default mode webhooks #379

bhperry · 2025-06-12T23:22:53Z

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.

operator/v1/types_clustermanager.go

coderabbitai · 2025-07-08T17:32:46Z

## 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.

## 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; retained existing test logic and error checks.                                                                                                                                                |

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 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)

🚧 Files skipped from review as they are similar to previous changes (5)

test/integration/api/clustermanager_test.go
operator/v1/zz_generated.deepcopy.go
operator/v1/types_clustermanager.go
operator/v1/0000_01_operator.open-cluster-management.io_clustermanagers.crd.yaml
operator/v1/zz_generated.swagger_doc_generated.go

✨ 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.

operator/v1/types_clustermanager.go

qiujian16

/approve

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

openshift-ci · 2025-07-09T01:17:33Z

[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:

~~OWNERS~~ [qiujian16]

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

Signed-off-by: Ben Perry <[email protected]>

qiujian16 · 2025-07-10T00:54:43Z

operator/v1/types_clustermanager.go

 }

-// WebhookConfiguration has two properties: Address and Port.
+// WebhookConfiguration represents customization of webhook servers


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

True. Maybe BindConfiguration?

Realized there is an issue for Hosted mode. The Port field is only the external endpoint for k8s API to reach the validating webhook, but if you set HostNetwork then you would also want to control the internal port bind to avoid port collision on the host net.

Perhaps a better API would be something like this:

spec: ... deployOption: hosted: workWebhookConfiguration: port: 443 address: work.webhook.example.com bindConfiguration: port: 19443 healthProbeBindAddress: ":18000" metricsBindAddress: ":18080" hostNetwork: true registrationWebhookConfiguration: ... mode: Hosted --- spec: ... deployOption: default: workWebhookConfiguration: bindConfiguration: ... registrationWebhookConfiguration: ... mode: Default

bindConfiguration would be optional and nullable

It looks like controller servers work very differently from the webhooks. They use the openshift/library-go controller builder, which only takes a single listen address:port. Whereas the webhooks use controller-runtime which has separate binds for each. So I don't think it makes sense to re-use this configuration for controllers (unless they get migrated to controller-runtime in the future)

I think we do not need to consider how the implementation is when considering this API. The controller-runtime allows bind endpoint separately does not mean we need to support that in the API level. Is there scenario that we need to let metrics/healthiness bind to the different address?

Well it's not just that it can bind separately, they are separate listeners. No option to share port with the webhook server. As a result, when using hostNetwork mode, it is important to have control over the binds.

I understand the port should be different, I am wondering if it is necessary to bind different HOST/IP for metrics/healthz endpoint.

I see. I figured if you can bind hostNet then it is reasonable to allow fully configuring the bind for metrics/healthz. Not strictly necessary though (I had no intention of using it, I'm just binding ":" for all of these).

right, I think it is sufficient to specify port for each

openshift-merge-robot · 2025-07-15T13:30:12Z

PR needs rebase.

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.

openshift-ci bot requested review from mdelder and qiujian16 June 12, 2025 23:22

bhperry mentioned this pull request Jun 12, 2025

✨ Support default mode webhook networking configuration open-cluster-management-io/ocm#1035

Open

qiujian16 reviewed Jun 25, 2025

View reviewed changes

operator/v1/types_clustermanager.go Show resolved Hide resolved

operator/v1/types_clustermanager.go Show resolved Hide resolved

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

bhperry force-pushed the default-webhook-config branch 2 times, most recently from 849e553 to b2da1b0 Compare July 8, 2025 18:09

qiujian16 reviewed Jul 9, 2025

View reviewed changes

operator/v1/types_clustermanager.go Outdated Show resolved Hide resolved

qiujian16 reviewed Jul 9, 2025

View reviewed changes

openshift-ci bot added the approved label Jul 9, 2025

bhperry force-pushed the default-webhook-config branch 2 times, most recently from b859cf1 to ab6dcf9 Compare July 9, 2025 15:16

Networking configuration options for webhooks

dc6f14d

Signed-off-by: Ben Perry <[email protected]>

bhperry force-pushed the default-webhook-config branch from ab6dcf9 to dc6f14d Compare July 9, 2025 15:22

qiujian16 reviewed Jul 10, 2025

View reviewed changes

openshift-merge-robot added the needs-rebase label Jul 15, 2025

✨ Networking config for default mode webhooks #379

Are you sure you want to change the base?

✨ Networking config for default mode webhooks #379

Uh oh!

Conversation

bhperry commented Jun 12, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related issue(s)

Summary by CodeRabbit

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

qiujian16 left a comment

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Jul 9, 2025

Uh oh!

qiujian16 Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

bhperry Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bhperry Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

qiujian16 Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

bhperry Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

qiujian16 Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bhperry Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

qiujian16 Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

openshift-merge-robot commented Jul 15, 2025

Uh oh!

Uh oh!

bhperry commented Jun 12, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 8, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

bhperry Jul 10, 2025 •

edited

Loading

qiujian16 Jul 14, 2025 •

edited

Loading