Skip to content

Commit 3118227

Browse files
authored
Merge pull request #82695 from dfitzmau/OCPBUGS-34995-FIZX
OCPBUGS-34995-FIZX: Updated the Expanding the node port range doc for…
2 parents 1e722de + e41354d commit 3118227

File tree

2 files changed

+27
-18
lines changed

2 files changed

+27
-18
lines changed

modules/nw-nodeport-service-range-edit.adoc

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,36 @@
66
[id="nw-nodeport-service-range-edit_{context}"]
77
= Expanding the node port range
88

9-
You can expand the node port range for the cluster.
9+
You can expand the node port range for your cluster. However, after you install your {product-title} cluster, you cannot contract the node port range on either side.
1010

1111
[IMPORTANT]
1212
====
13-
You can expand the node port range into the protected port range, which is between 0 and 32767. However, after expansion, you cannot change the range. Attempting to change the range returns the following error:
14-
`The Network "cluster" is invalid: spec.serviceNodePortRange: Invalid value: "30000-32767": new service node port range 30000-32767 does not completely cover the previous range 0-32767`.
15-
16-
Before making changes, ensure that the new range you set is appropriate for your cluster.
13+
Before you expand a node port range, consider that Red{nbsp}Hat has not performed testing outside the default port range of `30000-32768`. For ranges outside the default port range, ensure that you test to verify the expanding node port range does not impact your cluster. If you expanded the range and a port allocation issue occurs, create a new cluster and set the required range for it.
1714
====
1815

1916
.Prerequisites
2017

21-
* Install the OpenShift CLI (`oc`).
22-
* Log in to the cluster with a user with `cluster-admin` privileges.
18+
* Installed the {oc-first}.
19+
* Logged in to the cluster as a user with `cluster-admin` privileges.
20+
* You ensured that your cluster infrastructure allows access to the ports that exist in the extended range. For example, if you expand the node port range to `30000-32900`, your firewall or packet filtering configuration must allow the inclusive port range of `30000-32900`.
2321
2422
.Procedure
2523

26-
. To expand the node port range, enter the following command. Replace `<port>` with the largest port number in the new range.
24+
* Expand the range for the `serviceNodePortRange` parameter in the `network.config.openshift.io` object that your cluster uses to manage traffic for pods by entering the following command in your command-line interface (CLI):
2725
+
2826
[source,terminal]
2927
----
3028
$ oc patch network.config.openshift.io cluster --type=merge -p \
3129
'{
3230
"spec":
33-
{ "serviceNodePortRange": "30000-<port>" }
31+
{ "serviceNodePortRange": "<port_range>" } <1>
3432
}'
3533
----
34+
<1> Where `<port_range>` is your expanded range, such as `30000-32900`.
3635
+
3736
[TIP]
3837
====
39-
You can alternatively apply the following YAML to update the node port range:
38+
You can also apply the following YAML to update the node port range:
4039
4140
[source,yaml]
4241
----
@@ -45,7 +44,8 @@ kind: Network
4544
metadata:
4645
name: cluster
4746
spec:
48-
serviceNodePortRange: "30000-<port>"
47+
serviceNodePortRange: "<port_range>"
48+
# ...
4949
----
5050
====
5151
+
@@ -55,7 +55,9 @@ spec:
5555
network.config.openshift.io/cluster patched
5656
----
5757
58-
. To confirm that the configuration is active, enter the following command. It can take several minutes for the update to apply.
58+
.Verification
59+
60+
* To confirm a successful configuration, enter the following command. The update can take several minutes to apply.
5961
+
6062
[source,terminal]
6163
----
@@ -67,5 +69,5 @@ $ oc get configmaps -n openshift-kube-apiserver config \
6769
.Example output
6870
[source,terminal]
6971
----
70-
"service-node-port-range":["30000-33000"]
72+
"service-node-port-range":["30000-32900"]
7173
----

networking/configuring-node-port-service-range.adoc

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,22 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
As a cluster administrator, you can expand the available node port range. If your cluster uses of a large number of node ports, you might need to increase the number of available ports.
9+
During cluster installation, you can configure the node port range to meet the requirements of your cluster. After cluster installation, only a cluster administrator can expand the range as a postinstallation task. If your cluster uses a large number of node ports, consider increasing the available port range according to the requirements of your cluster.
1010

11-
The default port range is `30000-32767`. You can never reduce the port range, even if you first expand it beyond the default range.
11+
[IMPORTANT]
12+
====
13+
Before you expand a node port range, consider that Red{nbsp}Hat has not performed testing outside the default port range of `30000-32768`. For ranges outside the default port range, ensure that you test to verify the expanding node port range does not impact your cluster. If you expanded the range and a port allocation issue occurs, create a new cluster and set the required range for it.
14+
====
1215

13-
[id="configuring-node-port-service-range-prerequisites"]
14-
== Prerequisites
16+
If you do not set a node port range during cluster installation, the default range of `30000-32768` applies to your cluster. In this situation, you can expand the range on either side, but you must preserve `30000-32768` within your new port range.
1517

16-
- Your cluster infrastructure must allow access to the ports that you specify within the expanded range. For example, if you expand the node port range to `30000-32900`, the inclusive port range of `32768-32900` must be allowed by your firewall or packet filtering configuration.
18+
[IMPORTANT]
19+
====
20+
If you expand the node port range and {oc-first} stops working because of a port conflict with the OpenShift API server, you must create a new cluster.
21+
Ensure that the new node port range does not overlap with any ports already in use by host processes or pods that are configured with host networking.
22+
====
1723

24+
// Expanding the node port range
1825
include::modules/nw-nodeport-service-range-edit.adoc[leveloffset=+1]
1926

2027
[role="_additional-resources"]

0 commit comments

Comments
 (0)