feat: allows users to specify host ports when creating a cluster by leon-inf · Pull Request #9892 · apecloud/kubeblocks

leon-inf · 2025-11-25T10:10:48Z

apecloud-bot · 2025-11-25T10:11:02Z

Auto Cherry-pick Instructions

Usage:
  - /nopick: Not auto cherry-pick when PR merged.
  - /pick: release-x.x [release-x.x]: Auto cherry-pick to the specified branch when PR merged.

Example:
  - /nopick
  - /pick release-1.0

leon-inf · 2025-11-25T10:12:51Z

/pick release-1.0

dudizimber · 2025-11-25T10:34:56Z

apis/apps/v1/types.go

+	// Therefore, it is the user's responsibility to specify all container ports that need to be bound to host ports.
+	// Check @cmpd.spec.hostNetwork to obtain all container ports that need to be bound.
+	//
+	// !!!!! When you specify the host ports, you must specify two additional ports for the kbagent sidecar of KB: 'http', 'streaming'.


@leon-inf can you please clarify why the kbagent ports must also be defined? in theory they could be randomly assigned, no?

It may conflict with the host ports used by the database service. (It occupies the host ports assigned to the database service if it starts up first.)

If we can remove those predefined host ports from the DefaultPortManager it wouldn't conflict, and you wouldn't have to define them manually.
Additionally, there's no actual need for the kbagent to use a HostPort, right? The database has the need of latency, but that is not true for the kbagent. Hence, if we could selectively expose only the database, the kbagent wouldn't need a hostport at all.

What you actually expect is the node-port service. The database service can use the host ports while other services still run in the container network.

When the host-network is enabled, pods will share the host network's namespace, and there will inevitably be port conflict issues and management requirements.

Yes, but pods sharing the host network's namespace make sense when it comes to the database service. That's the only thing that should require "manual" port management on the user side.

The other sidecars running on the same pod shouldn't by default be exposed by HostPort. Meaning that the hostPort configuration should be at the container level, not pod level.

For example:

spec: containers: - name: database ports: - containerPort: 8080 hostPort: 8080 # this will be bound to the node’s network namespace - name: kbagent ports: - containerPort: 9000 # no hostPort

I think the first one.
In my mind the first version gives me control to expose only the database container in a HostPort, while the second forces me to have all containers in the HostNetwork, which will require more ports than actually necessary.

I see. What the system provides currently is the second one, while what you want is a completely different feature, the cost is that there will be a DNAT for the traffic of all data requests.

I'll update this PR later to support it.

@dudizimber Please review the updated API again to check if the behavior meets your requirements.

Looks good. Thanks!

codecov · 2025-11-26T03:52:45Z

Codecov Report

❌ Patch coverage is 62.86550% with 127 lines in your changes missing coverage. Please review.
✅ Project coverage is 51.13%. Comparing base (6e1e349) to head (5626c80).
⚠️ Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
pkg/controllerutil/host_port_manager.go	64.88%	75 Missing and 30 partials ⚠️
...s/apps/component/transformer_component_hostport.go	39.13%	13 Missing and 1 partial ⚠️
...pps/component/transformer_component_hostnetwork.go	0.00%	6 Missing ⚠️
pkg/parameters/config_util.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9892      +/-   ##
==========================================
+ Coverage   50.79%   51.13%   +0.34%     
==========================================
  Files         539      541       +2     
  Lines       58214    58389     +175     
==========================================
+ Hits        29568    29857     +289     
+ Misses      25745    25602     -143     
- Partials     2901     2930      +29

Flag	Coverage Δ
unittests	`51.13% <62.86%> (+0.34%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

cjc7373 · 2025-12-03T07:51:41Z

controllers/apps/component/transformer_component_hostport.go

+		for i, c := range synthesizedComp.PodSpec.Containers {
+			for j, p := range c.Ports {
+				if hostPort, ok := ports[p.Name]; ok {
+					synthesizedComp.PodSpec.Containers[i].Ports[j].HostPort = hostPort


Will the HostPort allocated here be conflict with the ports automatically allocated by portmanager?

This should be guaranteed by the user. Either turn off the default port manager or assign a separate port range to it.

Ok. Another question. What if two containers have defined ports with a same name?

K8s requires that each named port in a Pod must have a unique name.

This should be guaranteed by the user. Either turn off the default port manager or assign a separate port range to it.

It looks like when using hostNetwork, ports defined in hostPorts spec also won't be managed by portmanager?

cjc7373

I suggest mention in the API that user should be aware of the potential port conflict when using both default portmanager and hostPorts.

Other things LGTM.

apecloud-bot · 2025-12-03T09:34:16Z

/cherry-pick release-1.0

apecloud-bot · 2025-12-03T09:34:39Z

🤖 says: Error cherry-picking.

Auto-merging apis/apps/v1/types.go
CONFLICT (content): Merge conflict in apis/apps/v1/types.go
Auto-merging apis/apps/v1/zz_generated.deepcopy.go
CONFLICT (content): Merge conflict in apis/apps/v1/zz_generated.deepcopy.go
Auto-merging cmd/manager/main.go
Auto-merging config/crd/bases/apps.kubeblocks.io_clusters.yaml
CONFLICT (content): Merge conflict in config/crd/bases/apps.kubeblocks.io_clusters.yaml
Auto-merging config/crd/bases/apps.kubeblocks.io_components.yaml
CONFLICT (content): Merge conflict in config/crd/bases/apps.kubeblocks.io_components.yaml
Auto-merging controllers/apps/component/component_controller.go
Auto-merging controllers/apps/component/suite_test.go
Auto-merging controllers/apps/component/transformer_component_hostnetwork.go
CONFLICT (content): Merge conflict in controllers/apps/component/transformer_component_hostnetwork.go
Auto-merging controllers/operations/suite_test.go
Auto-merging deploy/helm/crds/apps.kubeblocks.io_clusters.yaml
CONFLICT (content): Merge conflict in deploy/helm/crds/apps.kubeblocks.io_clusters.yaml
Auto-merging deploy/helm/crds/apps.kubeblocks.io_components.yaml
CONFLICT (content): Merge conflict in deploy/helm/crds/apps.kubeblocks.io_components.yaml
Auto-merging docs/developer_docs/api-reference/cluster.md
CONFLICT (content): Merge conflict in docs/developer_docs/api-reference/cluster.md
Auto-merging pkg/controller/component/synthesize_component.go
Auto-merging pkg/controller/component/type.go
Auto-merging pkg/controller/component/utils.go
CONFLICT (content): Merge conflict in pkg/controller/component/utils.go
Auto-merging pkg/controller/component/vars.go
Auto-merging pkg/controller/component/vars_test.go
Auto-merging pkg/controller/configuration/config_utils.go
Auto-merging pkg/controller/configuration/suite_test.go
CONFLICT (content): Merge conflict in pkg/controller/configuration/suite_test.go
error: could not apply d144cac... feat: allows users to specify host ports when creating a cluster (#9892)
hint: After resolving the conflicts, mark them with
hint: "git add/rm ", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
hint: Disable this message with "git config set advice.mergeConflict false"

apecloud-bot · 2025-12-03T09:34:39Z

🤖 says: ‼️ cherry pick action failed.
See: https://github.com/apecloud/kubeblocks/actions/runs/19889093924

leon-inf · 2025-12-03T14:25:00Z

/nopick

leon-ape added 2 commits October 21, 2025 15:19

init

432f88d

Merge branch 'main' into support/host-network-ports

e776d95

leon-inf added this to the Release 1.1.0 milestone Nov 25, 2025

github-actions bot added the size/XXL Denotes a PR that changes 1000+ lines. label Nov 25, 2025

leon-inf changed the title ~~feat: support to specify host ports by user when creating the cluster~~ feat: allows users to specify host ports when creating a cluster Nov 25, 2025

apecloud-bot added the pick-1.0 Auto cherry-pick to release-1.0 when PR merged label Nov 25, 2025

leon-inf force-pushed the support/host-network-ports branch 2 times, most recently from 225d524 to b7ab0ed Compare November 25, 2025 10:32

leon-inf marked this pull request as ready for review November 25, 2025 10:32

leon-inf requested a review from a team as a code owner November 25, 2025 10:32

dudizimber reviewed Nov 25, 2025

View reviewed changes

dudizimber mentioned this pull request Nov 25, 2025

feat: add hostPorts support to component network configuration #9820

Closed

update

03fd33c

leon-inf force-pushed the support/host-network-ports branch from b7ab0ed to 03fd33c Compare November 26, 2025 03:41

leon-inf force-pushed the support/host-network-ports branch from a5cbe4b to e6d6bde Compare December 1, 2025 02:36

update API

d0e11c6

leon-inf force-pushed the support/host-network-ports branch from e6d6bde to d0e11c6 Compare December 1, 2025 03:00

leon-ape added 2 commits December 1, 2025 11:09

map for container ports to host ports

511673d

update

dedf53f

leon-inf force-pushed the support/host-network-ports branch from 21ce06c to dedf53f Compare December 1, 2025 04:39

wangyelei approved these changes Dec 3, 2025

View reviewed changes

apecloud-bot added the approved PR Approved Test label Dec 3, 2025

test for port manager

5626c80

apecloud-bot removed the approved PR Approved Test label Dec 3, 2025

cjc7373 reviewed Dec 3, 2025

View reviewed changes

cjc7373 approved these changes Dec 3, 2025

View reviewed changes

apecloud-bot added the approved PR Approved Test label Dec 3, 2025

leon-inf merged commit d144cac into main Dec 3, 2025
55 checks passed

leon-inf deleted the support/host-network-ports branch December 3, 2025 09:34

apecloud-bot added nopick Not auto cherry-pick when PR merged and removed pick-1.0 Auto cherry-pick to release-1.0 when PR merged labels Dec 3, 2025

Conversation

leon-inf commented Nov 25, 2025

Uh oh!

apecloud-bot commented Nov 25, 2025

Uh oh!

leon-inf commented Nov 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leon-inf Nov 28, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cjc7373 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

apecloud-bot commented Dec 3, 2025

Uh oh!

apecloud-bot commented Dec 3, 2025

Uh oh!

apecloud-bot commented Dec 3, 2025

Uh oh!

leon-inf commented Dec 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

leon-inf Nov 28, 2025 •

edited

Loading

codecov bot commented Nov 26, 2025 •

edited

Loading