Skip to content

Commit 8744fe7

Browse files
authored
Merge pull request #79139 from mletalie/OSDOCS-11353
[OSDOCS-11353] Document the whitelist IPs required for the ingress access to the API server
2 parents b2e0d60 + da9023c commit 8744fe7

File tree

4 files changed

+53
-2
lines changed

4 files changed

+53
-2
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,8 @@ Distros: openshift-dedicated
375375
Topics:
376376
- Name: Viewing audit logs
377377
File: audit-log-view
378+
- Name: Required allowlist IP addresses for SRE cluster access
379+
File: rh-required-whitelisted-IP-addresses-for-sre-access
378380
---
379381
Name: Authentication and authorization
380382
Dir: authentication

modules/ccs-gcp-customer-requirements.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ This policy only provides Red Hat with permissions and capabilities to change re
6262

6363
* Volume snapshots will remain within the customer-provided GCP account and customer-specified region.
6464

65-
* Red Hat must have ingress access to the API server through white-listed Red Hat machines.
66-
65+
* Red Hat must have ingress access to the API server through allowlist IP addresses.
66+
+
67+
[NOTE]
68+
====
69+
For information about allowlist IP addresses, see Additional resources.
70+
====
71+
+
6772
* Red Hat must have egress allowed to forward system and audit logs to a Red Hat managed central logging stack.

osd_planning/gcp-ccs.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,8 @@ include::modules/ccs-gcp-customer-procedure.adoc[leveloffset=+1]
1515
include::modules/ccs-gcp-iam.adoc[leveloffset=+1]
1616
include::modules/ccs-gcp-provisioned.adoc[leveloffset=+1]
1717
include::modules/gcp-limits.adoc[leveloffset=+1]
18+
19+
[id="additional-resources_{context}"]
20+
== Additional resources
21+
22+
* xref:../security/rh-required-whitelisted-IP-addresses-for-sre-access.adoc#rh-required-whitelisted-IP-addresses-for-sre-access[Required allowlist IP addresses for SRE access]
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="rh-required-whitelisted-IP-addresses-for-sre-access_{context}"]
3+
include::_attributes/attributes-openshift-dedicated.adoc[]
4+
include::_attributes/common-attributes.adoc[]
5+
= Required allowlist IP addresses for SRE cluster access
6+
7+
:context: rh-required-whitelisted-IP-addresses-for-sre-access
8+
9+
toc::[]
10+
11+
[id="required-whitelisted-overview_{context}"]
12+
== Overview
13+
14+
For Red Hat SREs to troubleshoot any issues within {product-title} clusters, they must have ingress access to the API server through allowlist IP addresses.
15+
16+
[id="required-whitelisted-access_{context}"]
17+
== Obtaining allowlisted IP addresses
18+
{product-title} users can use an {cluster-manager} CLI command to obtain the most up-to-date allowlist IP addresses for the Red Hat machines that are necessary for SRE access to {product-title} clusters.
19+
20+
[NOTE]
21+
====
22+
These allowlist IP addresses are not permanent and are subject to change. You must continuously review the API output for the most current allowlist IP addresses.
23+
====
24+
.Prerequisites
25+
* You installed the link:https://console.redhat.com/openshift/downloads[OpenShift Cluster Manager API command-line interface (`ocm`)].
26+
* You are able to configure your firewall to include the allowlist IP addresses.
27+
28+
.Procedure
29+
. To get the current allowlist IP addresses needed for SRE access to your {product-title} cluster, run the following command:
30+
+
31+
[source,terminal]
32+
----
33+
$ ocm get /api/clusters_mgmt/v1/trusted_ip_addresses|jq -r '.items[].id'
34+
----
35+
. Configure your firewall to grant access to the allowlist IP addresses.
36+
37+
38+
39+

0 commit comments

Comments
 (0)