Skip to content

Commit 619dcc7

Browse files
OSDOCS-13277: 4.17.2 Security Group Update for ROSA HCP
1 parent e2ecbaf commit 619dcc7

File tree

3 files changed

+28
-11
lines changed

3 files changed

+28
-11
lines changed

_unused_topics/rosa-hcp-aws-private-security-groups.adoc renamed to modules/rosa-hcp-aws-private-security-groups.adoc

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
// Module included in the following assemblies:
22
//
3+
// * rosa_hcp/rosa-hcp-aws-private-creating-cluster.adoc
34

45
[id="rosa-hcp-aws-private-security-groups_{context}"]
56
:_mod-docs-content-type: PROCEDURE
6-
= Configuring AWS security groups to access the API
7+
= Adding additional AWS security groups to the AWS PrivateLink endpoint
78

8-
With {hcp-title} private clusters, the AWS PrivateLink endpoint exposed in the customer's VPC has a default security group. This security group has access to the PrivateLink endpoint that is limited to only those resources that exist within the VPC or resources that are present with an IP address associated with the VPC CIDR range. In order to grant access to any entities outside of the VPC, through VPC peering and transit gateway, you must create and attach another security group to the PrivateLink endpoint to grant the necessary access.
9+
With {hcp-title} clusters, the AWS PrivateLink endpoint exposed in the customer's VPC has a security group that limits access to requests that originate from within the cluster's Machine CIDR range. In order to grant access to the cluster's API to any entities outside of the VPC, through VPC peering, transit gateways, or other network connectivity, you must create and attach another security group to the PrivateLink endpoint to grant the necessary access.
10+
11+
[IMPORTANT]
12+
====
13+
Adding additional AWS security groups to the AWS PrivateLink endpoint is only supported on {hcp-title} version 4.17.2 and later.
14+
====
915

1016
.Prerequisites
1117

@@ -41,20 +47,26 @@ hcp-private
4147
----
4248
$ read -r VPCE_ID VPC_ID <<< $(aws ec2 describe-vpc-endpoints --filters "Name=tag:api.openshift.com/id,Values=$(rosa describe cluster -c ${CLUSTER_NAME} -o yaml | grep '^id: ' | cut -d' ' -f2)" --query 'VpcEndpoints[].[VpcEndpointId,VpcId]' --output text)
4349
----
44-
45-
. Create your security group by running the following command:
50+
+
51+
[WARNING]
52+
====
53+
Modifying or removing the default AWS PrivateLink endpoint security group is not supported and might result in unexpected behavior.
54+
====
55+
+
56+
. Create an additional security group by running the following command:
4657
+
4758
[source,terminal]
4859
----
4960
$ export SG_ID=$(aws ec2 create-security-group --description "Granting API access to ${CLUSTER_NAME} from outside of VPC" --group-name "${CLUSTER_NAME}-api-sg" --vpc-id $VPC_ID --output text)
5061
----
5162

52-
. Add an ingress rule to the security group by running the following command:
63+
. Add an inbound (ingress) rule to the security group by running the following command:
5364
+
5465
[source,terminal]
5566
----
56-
$ aws ec2 authorize-security-group-ingress --group-id $SG_ID --ip-permissions FromPort=443,ToPort=443,IpProtocol=tcp,IpRanges=[{CidrIp=0.0.0.0/0}]
67+
$ aws ec2 authorize-security-group-ingress --group-id $SG_ID --ip-permissions FromPort=443,ToPort=443,IpProtocol=tcp,IpRanges=[{CidrIp=<cidr-to-allow>}] <.>
5768
----
69+
<.> Specify the CIDR block you want to allow access from.
5870

5971
. Add the new security group to the VPCE by running the following command:
6072
+
@@ -63,4 +75,4 @@ $ aws ec2 authorize-security-group-ingress --group-id $SG_ID --ip-permissions Fr
6375
$ aws ec2 modify-vpc-endpoint --vpc-endpoint-id $VPCE_ID --add-security-group-ids $SG_ID
6476
----
6577

66-
You now can access the API with your {hcp-title} private cluster.
78+
You now can access the API of your {hcp-title} private cluster from the specified CIDR block.

rosa_hcp/rosa-hcp-aws-private-creating-cluster.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ For {hcp-title-first} workloads that do not require public internet access, you
1111
//include::modules/osd-aws-privatelink-about.adoc[leveloffset=+1]
1212
//include::modules/osd-aws-privatelink-required-resources.adoc[leveloffset=+1]
1313
include::modules/rosa-hcp-aws-private-create-cluster.adoc[leveloffset=+1]
14+
include::modules/rosa-hcp-aws-private-security-groups.adoc[leveloffset=+1]
1415
include::modules/rosa-additional-principals-overview.adoc[leveloffset=+1]
1516
include::modules/rosa-additional-principals-create.adoc[leveloffset=+2]
1617
include::modules/rosa-additional-principals-edit.adoc[leveloffset=+2]

rosa_release_notes/rosa-release-notes.adoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,26 @@ endif::openshift-rosa-hcp[]
2323
// These notes need to be duplicated until the ROSA with HCP split out is completed.
2424
ifdef::openshift-rosa[]
2525
* **{rosa-classic} cluster node limit update.** {rosa-classic} clusters versions 4.14.14 and greater can now scale to 249 worker nodes. This is an increase from the previous limit of 180 nodes. For more information, see xref:../rosa_planning/rosa-limits-scalability.adoc#rosa-limits-scalability[Limits and scalability].
26-
26+
+
2727
[IMPORTANT]
2828
====
2929
Egress lockdown is a Technology Preview feature.
3030
====
31-
31+
+
3232
* **Egress lockdown is now available as a Technology Preview on {product-title} clusters.** You can create a fully operational cluster that does not require a public egress by configuring a virtual private cloud (VPC) and using the `--properties zero_egress:true` flag when creating your cluster. For more information, see xref:../rosa_hcp/rosa-hcp-egress-lockdown-install.adoc#rosa-hcp-egress-lockdown-install[Creating a {product-title} cluster with egress lockdown].
3333

34-
* **Red{nbsp}Hat SRE log-based alerting endpoints have been updated.** {product-title} customers who are using a firewall to control egress traffic can now remove all references to `*.osdsecuritylogs.splunkcloud.com:9997` from your firewall allowlist. {product-title} clusters still require the `http-inputs-osdsecuritylogs.splunkcloud.com:443` log-based alerting endpoint to be accessible from the cluster. This is applicable only to Red{nbsp}Hat OpenShift Service on AWS (classic architecture).
34+
* **ROSA with HCP now creates independent security groups for the AWS PrivateLink endpoint and worker nodes.** {hcp-title} clusters version 4.17.2 and greater can now add additional AWS security groups to the AWS PrivateLink endpoint to allow additional ingress traffic to the cluster's API. For more information, see xref:../rosa_hcp/rosa-hcp-aws-private-creating-cluster.adoc#rosa-hcp-aws-private-security-groups_rosa-hcp-aws-private-creating-cluster[Adding additional AWS security groups to the AWS PrivateLink endpoint].
35+
36+
* **Red{nbsp}Hat SRE log-based alerting endpoints have been updated.** {rosa-classic} customers who are using a firewall to control egress traffic can now remove all references to `*.osdsecuritylogs.splunkcloud.com:9997` from your firewall allowlist. {rosa-classic} clusters still require the `http-inputs-osdsecuritylogs.splunkcloud.com:443` log-based alerting endpoint to be accessible from the cluster.
3537
endif::openshift-rosa[]
3638
ifdef::openshift-rosa-hcp[]
39+
* **ROSA with HCP now creates independent security groups for the AWS PrivateLink endpoint and worker nodes.** {hcp-title} clusters version 4.17.2 and greater can now add additional AWS security groups to the AWS PrivateLink endpoint to allow additional ingress traffic to the cluster's API. For more information, see xref:../rosa_hcp/rosa-hcp-aws-private-creating-cluster.adoc#rosa-hcp-aws-private-security-groups_rosa-hcp-aws-private-creating-cluster[Adding additional AWS security groups to the AWS PrivateLink endpoint].
40+
+
3741
[IMPORTANT]
3842
====
3943
Egress lockdown is a Technology Preview feature.
4044
====
41-
45+
+
4246
* **Egress lockdown is now available as a Technology Preview on {product-title} clusters.** You can create a fully operational cluster that does not require a public egress by configuring a virtual private cloud (VPC) and using the `--properties zero_egress:true` flag when creating your cluster. For more information, see xref:../rosa_hcp/rosa-hcp-egress-lockdown-install.adoc#rosa-hcp-egress-lockdown-install[Creating a {product-title} cluster with egress lockdown].
4347
endif::openshift-rosa-hcp[]
4448
ifdef::openshift-rosa[]

0 commit comments

Comments
 (0)