Skip to content

Commit 3828e47

Browse files
committed
OSDOCS-3467: Updated configuration-externalip.adoc for private cluster
1 parent a01c84c commit 3828e47

File tree

4 files changed

+29
-27
lines changed

4 files changed

+29
-27
lines changed

modules/cluster-cloud-controller-manager-operator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ The status of this Operator is General Availability for {aws-first}, {gcp-first}
4646
The Operator is available as a link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] for {ibm-power-server-name}.
4747
====
4848

49-
The Cloud Controller Manager Operator manages and updates the cloud controller managers deployed on top of {product-title}. The Operator is based on the Kubebuilder framework and `controller-runtime` libraries. It is installed via the Cluster Version Operator (CVO).
49+
The Cloud Controller Manager Operator manages and updates the cloud controller managers deployed on top of {product-title}. The Operator is based on the Kubebuilder framework and `controller-runtime` libraries. You can install the Cloud Controller Manager Operator by using the Cluster Version Operator (CVO).
5050

51-
It contains the following components:
51+
The Cloud Controller Manager Operator includes the following components:
5252

5353
* Operator
5454
* Cloud configuration observer

modules/configuration-externalip.adoc

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[id="configuration-externalip_{context}"]
77
= Configuration for ExternalIP
88

9-
Use of an external IP address in {product-title} is governed by the following parameters in the `Network.config.openshift.io` custom resource (CR) that is named `cluster`:
9+
The following parameters in the `Network.config.openshift.io` custom resource (CR) govern the use of an external IP address in {product-title}:
1010

11-
* `spec.externalIP.autoAssignCIDRs` defines an IP address block used by the load balancer when choosing an external IP address for the service. {product-title} supports only a single IP address block for automatic assignment. This configuration requires less steps than manually assigning ExternalIPs to services, which requires managing the port space of a limited number of shared IP addresses. If you enable automatic assignment, a `Service` object with `spec.type=LoadBalancer` is allocated an external IP address.
11+
* `spec.externalIP.autoAssignCIDRs` defines an IP address block used by the load balancer when choosing an external IP address for the service. {product-title} supports only a single IP address block for automatic assignment. This configuration requires less steps than manually assigning ExternalIPs to services, which requires managing the port space of a limited number of shared IP addresses. If you enable automatic assignment, the Cloud Controller Manager Operator allocates an external IP address to a `Service` object with `spec.type=LoadBalancer` defind in its configuration.
1212
1313
* `spec.externalIP.policy` defines the permissible IP address blocks when manually specifying an IP address. {product-title} does not apply policy rules to IP address blocks that you defined in the `spec.externalIP.autoAssignCIDRs` parameter.
1414
@@ -19,7 +19,7 @@ If routed correctly, external traffic from the configured external IP address bl
1919
As a cluster administrator, you must configure routing to externalIPs. You must also ensure that the IP address block you assign terminates at one or more nodes in your cluster. For more information, see link:https://kubernetes.io/docs/concepts/services-networking/service/#external-ips[Kubernetes External IPs].
2020
====
2121

22-
{product-title} supports both the automatic and manual assignment of IP addresses, where each address is guaranteed to be assigned to a maximum of one service. This configuration ensures that each service can expose its chosen ports regardless of the ports exposed by other services.
22+
{product-title} supports both automatic and manual IP address assignment. This support guarantees that each address gets assigned to a maximum of one service and that each service can expose its chosen ports regardless of the ports exposed by other services.
2323

2424
[NOTE]
2525
====
@@ -56,3 +56,12 @@ status:
5656
- ip: 192.168.132.253
5757
# ...
5858
----
59+
60+
If you run a private cluster on a cloud-provider platform, you can change the publishing scope to `internal` for the load balancer of the Ingress Controller by running the following `patch` command:
61+
62+
[source,terminal]
63+
----
64+
$ oc -n openshift-ingress-operator patch ingresscontrollers/ingress-controller-with-nlb --type=merge --patch='{"spec":{"endpointPublishingStrategy":{"loadBalancer":{"scope":"Internal"}}}}'
65+
----
66+
67+
After you run this command, the Ingress Controller restricts access to routes for {product-title} applications to internal networks only.

modules/installation-initializing-manual.adoc

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ ifdef::aws-china,aws-secret[]
9999
* You have uploaded a custom RHCOS AMI.
100100
endif::aws-china,aws-secret[]
101101
ifndef::ibm-cloud-restricted[]
102-
* You have an SSH public key on your local machine to provide to the installation program. The key will be used for SSH authentication onto your cluster nodes for debugging and disaster recovery.
102+
* You have an SSH public key on your local machine for use with the installation program. You can use the key for SSH authentication onto your cluster nodes for debugging and disaster recovery.
103103
endif::ibm-cloud-restricted[]
104104
* You have obtained the {product-title} installation program and the pull secret for your
105105
cluster.
@@ -124,16 +124,10 @@ $ mkdir <installation_directory>
124124
+
125125
[IMPORTANT]
126126
====
127-
You must create a directory. Some installation assets, like bootstrap X.509
128-
certificates have short expiration intervals, so you must not reuse an
129-
installation directory. If you want to reuse individual files from another
130-
cluster installation, you can copy them into your directory. However, the file
131-
names for the installation assets might change between releases. Use caution
132-
when copying installation files from an earlier {product-title} version.
127+
You must create a directory. Some installation assets, such as bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier {product-title} version.
133128
====
134129

135-
. Customize the sample `install-config.yaml` file template that is provided and save
136-
it in the `<installation_directory>`.
130+
. Customize the provided sample `install-config.yaml` file template and save the file in the `<installation_directory>`.
137131
ifdef::ibm-cloud-restricted[]
138132
+
139133
[NOTE]
@@ -142,18 +136,16 @@ You must name this configuration file `install-config.yaml`.
142136
====
143137
+
144138
When customizing the sample template, be sure to provide the information that is required for an installation in a restricted network:
145-
139+
+
146140
.. Update the `pullSecret` value to contain the authentication information for your registry:
147141
+
148142
[source,yaml]
149143
----
150144
pullSecret: '{"auths":{"<mirror_host_name>:5000": {"auth": "<credentials>","email": "[email protected]"}}}'
151145
----
152146
+
153-
For `<mirror_host_name>`, specify the registry domain name
154-
that you specified in the certificate for your mirror registry, and for
155-
`<credentials>`, specify the base64-encoded user name and password for
156-
your mirror registry.
147+
For `<mirror_host_name>`, specify the registry domain name that you specified in the certificate for your mirror registry, and for `<credentials>`, specify the base64-encoded user name and password for your mirror registry.
148+
+
157149
.. Add the `additionalTrustBundle` parameter and value.
158150
+
159151
[source,yaml]
@@ -165,6 +157,7 @@ additionalTrustBundle: |
165157
----
166158
+
167159
The value must be the contents of the certificate file that you used for your mirror registry. The certificate file can be an existing, trusted certificate authority, or the self-signed certificate that you generated for the mirror registry.
160+
+
168161
.. Define the network and subnets for the VPC to install the cluster in under the parent `platform.ibmcloud` field:
169162
+
170163
[source,yaml]
@@ -175,6 +168,7 @@ computeSubnets: <compute_subnet>
175168
----
176169
+
177170
For `platform.ibmcloud.vpcName`, specify the name for the existing {ibm-cloud-title} Virtual Private Cloud (VPC) network. For `platform.ibmcloud.controlPlaneSubnets` and `platform.ibmcloud.computeSubnets`, specify the existing subnets to deploy the control plane machines and compute machines, respectively.
171+
+
178172
.. Add the image content resources, which resemble the following YAML excerpt:
179173
+
180174
[source,yaml]
@@ -189,6 +183,7 @@ imageContentSources:
189183
----
190184
+
191185
For these values, use the `imageContentSourcePolicy.yaml` file that was created when you mirrored the registry.
186+
+
192187
.. If network restrictions limit the use of public endpoints to access the required {ibm-cloud-name} services, add the `serviceEndpoints` stanza to `platform.ibmcloud` to specify an alternate service endpoint.
193188
+
194189
[NOTE]
@@ -219,6 +214,7 @@ serviceEndpoints:
219214
url: <global_tagging_alternate_endpoint_url>
220215
# ...
221216
----
217+
+
222218
.. Optional: Set the publishing strategy to `Internal`:
223219
+
224220
[source,yaml]
@@ -244,10 +240,7 @@ endif::ibm-cloud-restricted[]
244240
245241
ifdef::restricted,restricted-upi[]
246242
247-
** Unless you use a registry that {op-system} trusts by default, such as
248-
`docker.io`, you must provide the contents of the certificate for your mirror
249-
repository in the `additionalTrustBundle` section. In most cases, you must
250-
provide the certificate for your mirror.
243+
** Unless you use a registry that {op-system} trusts by default, such as `docker.io`, you must provide the contents of the certificate for your mirror repository in the `additionalTrustBundle` section. In most cases, you must provide the certificate for your mirror.
251244
** You must include the `imageContentSources` section from the output of the command to
252245
mirror the repository.
253246
@@ -315,11 +308,11 @@ ifdef::vsphere-upi-vsphere[]
315308
. If you are installing a three-node cluster, modify the `install-config.yaml` file by setting the `compute.replicas` parameter to `0`. This ensures that the cluster's control planes are schedulable. For more information, see "Installing a three-node cluster on {platform}".
316309
endif::vsphere-upi-vsphere[]
317310
318-
. Back up the `install-config.yaml` file so that you can use it to install multiple clusters.
311+
. Back up the `install-config.yaml` file so that you can use it to install many clusters.
319312
+
320313
[IMPORTANT]
321314
====
322-
The `install-config.yaml` file is consumed during the next step of the installation process. You must back it up now.
315+
Back up the `install-config.yaml` file now, because the installation process consumes the file in the next step.
323316
====
324317
325318
ifeval::["{context}" == "installing-azure-government-region"]

networking/ingress_load_balancing/configuring_ingress_cluster_traffic/configuring-externalip.adoc

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

77
toc::[]
88

9-
As a cluster administrator, you can designate an IP address block that is external to the cluster that can send traffic to services in the cluster.
9+
As a cluster administrator, you can select an IP address block that is external to the cluster that can send traffic to services in the cluster.
1010

1111
This functionality is generally most useful for clusters installed on bare-metal hardware.
1212

@@ -17,7 +17,7 @@ This functionality is generally most useful for clusters installed on bare-metal
1717
// About ExternalIP
1818
include::modules/nw-externalip-about.adoc[leveloffset=+1]
1919

20-
[id="additional-resources_{context}"]
20+
[role="_additional-resources"]
2121
== Additional resources
2222

2323
* xref:../../../networking/configuring_network_settings/configuring-ipfailover.adoc#configuring-ipfailover[Configuring IP failover]

0 commit comments

Comments
 (0)