Skip to content

Commit 4d926b5

Browse files
authored
Merge pull request #32226 from skrthomas/OSDOCS2143
OSDOCS2143: Added topic about configuring GCP Internal Ingress Load Balancer Global Access Option
2 parents 3c42fe1 + ac109e0 commit 4d926b5

File tree

5 files changed

+65
-2
lines changed

5 files changed

+65
-2
lines changed

installing/installing_gcp/installing-gcp-user-infra.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,3 +104,4 @@ include::modules/installation-gcp-user-infra-completing.adoc[leveloffset=+1]
104104

105105
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
106106
* If necessary, you can xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
107+
* xref:../../networking/ingress-operator.adoc#nw-ingress-controller-configuration-gcp-global-access_configuring-ingress[Configure Global Access for an Ingress Controller on GCP].
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * ingress/configure-ingress-operator.adoc
4+
5+
[id="nw-ingress-controller-configuration-gcp-global-access_{context}"]
6+
= Configuring global access for an Ingress Controller on GCP
7+
8+
An Ingress Controller created on GCP with an internal load balancer generates an internal IP address for the service. A cluster administrator can specify the global access option, which enables clients in any region within the same VPC network and compute region as the load balancer, to reach the workloads running on your cluster.
9+
10+
For more information, see the GCP documentation for link:https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#global_access[global access].
11+
12+
.Prerequisites
13+
14+
* You deployed an {product-title} cluster on GCP infrastructure.
15+
* You configured an Ingress Controller to use an internal load balancer.
16+
* You installed the OpenShift CLI (`oc`).
17+
18+
.Procedure
19+
20+
. Configure the Ingress Controller resource to allow global access.
21+
+
22+
[NOTE]
23+
====
24+
You can also create an Ingress Controller and specify the global access option.
25+
====
26+
+
27+
.. Configure the Ingress Controller resource:
28+
+
29+
[source,terminal]
30+
----
31+
$ oc -n openshift-ingress-operator edit ingresscontroller/default
32+
----
33+
+
34+
.. Edit the YAML file:
35+
+
36+
.Sample `clientAccess` configuration to `Global`
37+
[source,yaml]
38+
----
39+
spec:
40+
endpointPublishingStrategy:
41+
loadBalancer:
42+
providerParameters:
43+
gcp:
44+
clientAccess: Global <1>
45+
type: GCP
46+
scope: Internal
47+
type: LoadBalancerService
48+
----
49+
<1> Set `gcp.clientAccess` to `Global`.
50+
51+
.. Save the file to apply the changes.
52+
+
53+
. Run the following command to verify that the service allows global access:
54+
+
55+
[source,terminal]
56+
----
57+
$ oc -n openshift-ingress operator edit svc/router-default -o yaml
58+
----
59+
+
60+
The output shows that global access is enabled for GCP with the annotation, `networking.gke.io/internal-load-balancer-allow-global-access`.

modules/nw-ingress-controller-configuration-parameters.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ If not set, the default value is based on `infrastructure.config.openshift.io/cl
4242
* Bare metal: `NodePortService`
4343
* Other: `HostNetwork`
4444

45-
The `endpointPublishingStrategy` value cannot be updated.
45+
For most platforms, the `endpointPublishingStrategy` value cannot be updated. However, on GCP, you can configure the `loadbalancer.providerParameters.gcp.clientAccess` subfield.
4646

4747
|`defaultCertificate`
4848
|The `defaultCertificate` value is a reference to a secret that contains the default certificate that is served by the Ingress controller. When Routes do not specify their own certificate, `defaultCertificate` is used.

networking/ingress-operator.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ include::modules/nw-ingress-sharding-namespace-labels.adoc[leveloffset=+3]
4848

4949
include::modules/nw-ingress-setting-internal-lb.adoc[leveloffset=+2]
5050

51+
include::modules/nw-ingress-controller-configuration-gcp-global-access.adoc[leveloffset=+2]
52+
5153
include::modules/nw-ingress-default-internal.adoc[leveloffset=+2]
5254

5355
include::modules/nw-route-admission-policy.adoc[leveloffset=+2]

nodes/clusters/nodes-cluster-overcommit.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ include::modules/nodes-cluster-overcommit-project-disable.adoc[leveloffset=+2]
7474
== Additional resources
7575

7676
For information setting per-project resource limits, see
77-
xref:../../applications/deployments/managing-deployment-processes.adoc#deployments-setting-resources_deployment-operations[Setting deployment resources].
77+
xref:../../applications/deployments/managing-deployment-processes.adoc#deployments-triggers_deployment-operations[Setting deployment resources].

0 commit comments

Comments
 (0)