Skip to content

Commit 8425a18

Browse files
authored
Merge pull request #45186 from bmcelvee/OSDOCS-3253
OSDOCS-3253: add firewall prereqs to standard STS prereqs doc
2 parents 5c9a70f + 67a9f9c commit 8425a18

File tree

3 files changed

+16
-13
lines changed

3 files changed

+16
-13
lines changed

modules/osd-aws-privatelink-firewall-prerequisites.adoc

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
// Module included in the following assemblies:
22
//
3-
// * rosa_getting_started/rosa-aws-prereqs.adoc
3+
// * rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc
4+
// * rosa_planning/rosa-sts-aws-prereqs.adoc
45

56
:_content-type: PROCEDURE
6-
[id="osd-aws-privatelink-firewall-prerequisites"]
7+
[id="osd-aws-privatelink-firewall-prerequisites_{context}"]
78
= AWS firewall prerequisites
89

910
[IMPORTANT]
1011
====
11-
Only ROSA clusters deployed with PrivateLink may use a firewall to control egress traffic.
12+
Only ROSA clusters deployed with PrivateLink can use a firewall to control egress traffic.
1213
====
1314

1415
This section provides the necessary details that enable you to control egress traffic from your {product-title} cluster. If you are using a firewall to control egress traffic, you must configure your firewall to grant access to the domain and port combinations below. {product-title} requires this access to provide a fully managed OpenShift service.
@@ -54,7 +55,7 @@ This section provides the necessary details that enable you to control egress tr
5455

5556
|`registry.access.redhat.com`
5657
|443
57-
|Provides access to the odo CLI tool that helps developers build on OpenShift and Kubernetes.
58+
|Provides access to the `odo` CLI tool that helps developers build on OpenShift and Kubernetes.
5859

5960
|`console.redhat.com`
6061
|443, 80
@@ -72,11 +73,10 @@ This section provides the necessary details that enable you to control egress tr
7273
|443
7374
|Provides core container images as a fallback when quay.io is not available.
7475
|===
75-
+
76-
[NOTE]
77-
====
78-
Creating a firewall with a ROSA private cluster (non-PrivateLink) is not supported.
79-
====
76+
//[NOTE]
77+
//====
78+
//Creating a firewall with a ROSA private cluster (non-PrivateLink) is not supported.
79+
//====
8080
+
8181
When you add a site such as `quay.io` to your allowlist, do not add a wildcard entry such as `*.quay.io` to your denylist. In most cases, image registries use a content delivery network (CDN) to serve images. If a firewall blocks access, then image downloads are denied when the initial download request is redirected to a host name such as `cdn01.quay.io`.
8282
+
@@ -123,7 +123,7 @@ See link:https://docs.openshift.com/container-platform/4.9/support/remote_health
123123
|Required to access AWS services and resources.
124124
|===
125125
+
126-
Alternatively, if you wish to not use a wildcard for Amazon Web Services (AWS) APIs, you must allowlist the following URLs:
126+
Alternatively, if you choose to not use a wildcard for Amazon Web Services (AWS) APIs, you must allowlist the following URLs:
127127
+
128128
[cols="6,1,6",options="header"]
129129
|===
@@ -202,14 +202,16 @@ Alternatively, if you wish to not use a wildcard for Amazon Web Services (AWS) A
202202
|443
203203
|This alerting service is used by the in-cluster alertmanager to send alerts notifying Red Hat SRE of an event to take action on.
204204

205+
ifdef::openshift-dedicated[]
206+
205207
|`api.deadmanssnitch.com`
206208
|443
207209
|Alerting service used by OpenShift Dedicated to send periodic pings that indicate whether the cluster is available and running.
208210

209211
|`nosnch.in`
210212
|443
211213
|Alerting service used by OpenShift Dedicated to send periodic pings that indicate whether the cluster is available and running.
212-
214+
endif::[]
213215
|`*.osdsecuritylogs.splunkcloud.com`
214216
OR
215217
`inputs1.osdsecuritylogs.splunkcloud.com`
@@ -238,7 +240,7 @@ OR
238240
|The SFTP server used by `must-gather-operator` to upload diagnostic logs to help troubleshoot issues with the cluster.
239241
|===
240242

241-
. If you did not allow a wildcard for Amazon Web Services (AWS) APIs, you will need to also allow the S3 bucket used for the internal OpenShift registry. To retrieve that endpoint, run the following command once the cluster has successfully been provisioned:
243+
. If you did not allow a wildcard for Amazon Web Services (AWS) APIs, you must also allow the S3 bucket used for the internal OpenShift registry. To retrieve that endpoint, run the following command after the cluster is successfully provisioned:
242244
+
243245
[source,terminal]
244246
----

rosa_install_access_delete_clusters/rosa-aws-privatelink-creating-cluster.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ xref:../rosa_install_access_delete_clusters/rosa-sts-config-identity-providers.a
1919
[role="_additional-resources"]
2020
== Additional resources
2121

22-
* xref:rosa_getting_started_iam/rosa-aws-prereqs.adoc#osd-aws-privatelink-firewall-prerequisites[AWS PrivateLink firewall prerequisites]
22+
* xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#osd-aws-privatelink-firewall-prerequisites_rosa-sts-aws-prereqs[AWS PrivateLink firewall prerequisites]
2323
* xref:../rosa_getting_started/rosa-sts-getting-started-workflow.adoc#rosa-sts-overview-of-the-deployment-workflow[Overview of the ROSA with STS deployment workflow]
2424
* xref:../rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc#rosa-sts-deleting-cluster[Deleting a ROSA cluster]
2525
* xref:../rosa_architecture/rosa_architecture_sub/rosa-architecture-models.adoc#rosa-architecture-models[ROSA architecture]

rosa_planning/rosa-sts-aws-prereqs.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ include::modules/rosa-requirements-deploying-in-opt-in-regions.adoc[leveloffset=
2525
include::modules/rosa-setting-the-aws-security-token-version.adoc[leveloffset=+2]
2626
include::modules/rosa-sts-aws-iam.adoc[leveloffset=+1]
2727
include::modules/rosa-aws-provisioned.adoc[leveloffset=+1]
28+
include::modules/osd-aws-privatelink-firewall-prerequisites.adoc[leveloffset=+1]
2829

2930
== Next steps
3031
xref:../rosa_planning/rosa-sts-required-aws-service-quotas.adoc#rosa-sts-required-aws-service-quotas[Review the required AWS service quotas]

0 commit comments

Comments
 (0)