Skip to content

osdocs-21632:adds hostPrefix docs 5.0 - #118400

Open
JoeAldinger wants to merge 1 commit into
openshift:mainfrom
JoeAldinger:osdocs-21632-main
Open

osdocs-21632:adds hostPrefix docs 5.0#118400
JoeAldinger wants to merge 1 commit into
openshift:mainfrom
JoeAldinger:osdocs-21632-main

Conversation

@JoeAldinger

@JoeAldinger JoeAldinger commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Version(s):
4.18

Issue:
https://redhat.atlassian.net/browse/OSDOCS-21632

Link to docs preview:

QE review:

  • QE has approved this change.
  • SME has approved this change.
  • DPM has approved this change.

Additional information:
Update to existing docs for xrefs, etc: #118396

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 19, 2026
@openshift-ci-robot

openshift-ci-robot commented Aug 19, 2026

Copy link
Copy Markdown

@JoeAldinger: This pull request references osdocs-21632 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 epic to target either version "5.1.0." or "openshift-5.1.0.", but it targets "openshift-5.0" instead.

Details

In response to this:

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 19, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Aug 19, 2026

Copy link
Copy Markdown

.. Verify node readiness across the cluster.
.. Verify critical workloads and pod scheduling behavior.

[NOTE]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.TaskStep: Content other than a single list cannot be mapped to DITA steps.

Comment thread modules/nw-hostprefix-increase-procedure.adoc

@knobunc knobunc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great stuff! A few minor suggestions, none required.

Comment thread modules/nw-hostprefix-about.adoc

The `hostPrefix` value determines the subnet size assigned to each node from the `spec.clusterNetwork[].cidr` range. For example, with a cluster network CIDR of `172.28.0.0/16`, changing `hostPrefix` from `23` to `20` changes each node allocation from a `/23` subnet to a `/20` subnet. The `/20` subnet provides a larger per-node subnet than the `/23` subnet, and therefore provides more pod IP addresses per node.

By default, a `/23` per-node subnet provides 512 addresses, with approximately 510 pod IP addresses available per node. Increasing the subnet size can provide more addresses per node; however, node-level pod density remains dependent on cluster scalability limits, node resources, workload behavior, and operational constraints.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does it make sense to explain the math? A /23 allows the node to allocate 2 ^ (32 - 23) addresses, so 2 ^ 9 or 512.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I don't think explaining the math is going to clarify the concept. Ok to skip, imo.

Comment thread modules/nw-hostprefix-drain-reference.adoc Outdated
Comment thread modules/nw-hostprefix-increase-procedure.adoc Outdated
Comment thread modules/nw-hostprefix-planning.adoc Outdated
= Planning for a cluster network hostPrefix increase

[role="_abstract"]
Before you increase `hostPrefix`, verify address capacity, workload disruption tolerance, and operational sequencing requirements. Increasing the per-node subnet size reduces the total number of node subnets available from the cluster CIDR.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"Increasing the per-node subnet size reduces the total number of node subnets available from the cluster CIDR."

Maybe:

"Increasing the per-node subnet size reduces the total number of nodes that can be part of the cluster."

Not sure if it helps to explain the math here too. If your clusternetwork is a /16 CIDR and you have a hostPrefix of 23 then you have allocated 32 - 16 bits (16) to the cluster to use. Of those 16 bits it can use, the hostPrefix of 23 leaves 32-23 (9) bits for the nodes to use and 23-16 (7) to address the nodes themselves. So with that configuration you get 128 nodes with a max of 512 pods per node. 128 * 512 = 65536 = 2^16.

Maybe a picture would make it clear too?

32 bit IP address
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | 17 18 19 20 21 22 23 | 24 25 26 27 28 29 30 31 32 |
| Part to identify the cluster (16 bits) | Part to identify the node (7 bits) | Part to identify the pod (9 bits |

@JoeAldinger JoeAldinger Sep 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I don't think an image is inside scope for this work and here again I'm not sure showing the math will help either. Your rephrasing suggestion is good, thank you.

@JoeAldinger
JoeAldinger force-pushed the osdocs-21632-main branch 2 times, most recently from 95d6291 to 055db25 Compare September 8, 2026 19:47

[IMPORTANT]
====
* Changing the `hostPrefix` value does not change the support for increased pod density or the number of pods that can be supported per node. Red{nbsp}Hat supports tested cluster maximums rather than absolute cluster maximums.You must still adhere to the cluster scalability limits, node resources, workload behavior, and operational constraints. See "Planning your environment according to object maximums".

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] RedHat.Spacing: Keep one space between words in 'maximums.You'. For more information, see RedHat.Spacing.

@openshift-ci

openshift-ci Bot commented Sep 8, 2026

Copy link
Copy Markdown

@JoeAldinger: all tests passed!

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.

@mcurry-rh

Copy link
Copy Markdown

LGTM

1 similar comment
@CFields651

Copy link
Copy Markdown

LGTM

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

Labels

branch/enterprise-4.18 branch/enterprise-4.19 branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 branch/enterprise-5.0 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants