Skip to content

Commit a8df17c

Browse files
authored
Merge pull request #113694 from jc-berger/jcberger-osd-cluster-admin-CQA.2
OSDOCS 17887: CQA for OSD Cluster Admin and merge review updates
2 parents 328ec9a + 44cbefd commit a8df17c

38 files changed

Lines changed: 332 additions & 393 deletions

modules/aws-direct-connect.adoc

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,20 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="aws-direct-connect_{context}"]
7-
= Configuring AWS Direct Connect
7+
= Configure AWS Direct Connect
88

9+
[role="_abstract"]
10+
Configure AWS Direct Connect to establish a dedicated network connection between your remote network and your {product-title} cluster Virtual Private Cloud (VPC).
911

10-
{AWS} Direct Connect requires a hosted Virtual Interface (VIF) connected to a Direct Connect Gateway (DXGateway), which is in turn associated to a Virtual Gateway (VGW) or a Transit Gateway in order to access a remote Virtual Private Cloud (VPC) in the same or another account.
11-
12-
If you do not have an existing DXGateway, the typical process involves creating the hosted VIF, with the DXGateway and VGW being created in your AWS account.
13-
14-
If you have an existing DXGateway connected to one or more existing VGWs, the process involves your AWS account sending an Association Proposal to the DXGateway owner. The DXGateway owner must ensure that the proposed CIDR will not conflict with any other VGWs they have associated.
12+
{AWS} Direct Connect requires a hosted Virtual Interface (VIF) connected to a Direct Connect Gateway (DXGateway), which is in turn associated to a Virtual Gateway (VGW) or a Transit Gateway. This allows you to access a remote VPC in the same or another account.
1513

1614
.Prerequisites
1715

18-
* Confirm the CIDR range of the {product-title} VPC will not conflict with any other VGWs you have associated.
16+
* The Classless Inter-Domain Routing (CIDR) range of the {product-title} VPC does not conflict with any other associated VGWs.
1917
* Gather the following information:
2018
** The Direct Connect Gateway ID.
2119
** The AWS Account ID associated with the virtual interface.
22-
** The BGP ASN assigned for the DXGateway. Optional: the Amazon default ASN may also be used.
20+
** The Border Gateway Protocol (BGP) Autonomous System Number (ASN) assigned for the DXGateway. Optional: the Amazon default ASN may also be used.
2321
2422
.Procedure
2523

@@ -34,9 +32,4 @@ If you have an existing DXGateway connected to one or more existing VGWs, the pr
3432
[WARNING]
3533
====
3634
When connecting to an existing DXGateway, you are responsible for the link:https://aws.amazon.com/directconnect/pricing/[costs].
37-
====
38-
39-
[role="_additional-resources"]
40-
.Additional resources
41-
42-
* For more information and troubleshooting help, see the link:https://docs.aws.amazon.com/directconnect/latest/UserGuide/Welcome.html[AWS Direct Connect] guide.
35+
====

modules/aws-vpc.adoc

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,19 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="aws-vpc_{context}"]
7-
= Configuring AWS VPC peering
7+
= Configure AWS Virtual Private Cloud peering
88

9+
[role="_abstract"]
10+
Configure an {AWS} Virtual Private Cloud (VPC) peering connection to route traffic between two VPCs using private IPv4 or IPv6 addresses.
911

10-
A Virtual Private Cloud (VPC) peering connection is a networking connection between two VPCs that enables you to route traffic between them using private IPv4 addresses or IPv6 addresses. You can configure an {AWS} VPC containing an {product-title} cluster to peer with another AWS VPC network.
11-
12-
[WARNING]
12+
[IMPORTANT]
1313
====
1414
Before you attempt to uninstall a cluster, you must remove any VPC peering connections from the cluster's VPC. Failure to do so might result in a cluster not completing the uninstall process.
15+
====
1516

16-
AWS supports inter-region VPC peering between all commercial regions link:https://aws.amazon.com/vpc/faqs/#Peering_Connections[excluding China].
17+
[NOTE]
18+
====
19+
AWS supports inter-region VPC peering between all commercial regions excluding China. For more information, see link:https://aws.amazon.com/vpc/faqs/#Peering_Connections[AWS VPC FAQs].
1720
====
1821

1922
.Prerequisites
@@ -22,8 +25,8 @@ AWS supports inter-region VPC peering between all commercial regions link:https:
2225
** Customer AWS account number
2326
** Customer VPC ID
2427
** Customer VPC Region
25-
** Customer VPC CIDR
26-
* Check the CIDR block used by the {product-title} Cluster VPC. If it overlaps or matches the CIDR block for the Customer VPC, then peering between these two VPCs is not possible; see the Amazon VPC link:https://docs.aws.amazon.com/vpc/latest/peering/invalid-peering-configurations.html[Unsupported VPC peering configurations] documentation for details. If the CIDR blocks do not overlap, you can proceed with the procedure.
28+
** Customer VPC Classless Inter-Domain Routing (CIDR)
29+
* The CIDR block of the {product-title} Cluster VPC does not overlap or match the Customer VPC CIDR block. See the Amazon VPC link:https://docs.aws.amazon.com/vpc/latest/peering/invalid-peering-configurations.html[Unsupported VPC peering configurations] documentation for details on invalid configurations.
2730
2831
.Procedure
2932

@@ -36,4 +39,4 @@ AWS supports inter-region VPC peering between all commercial regions link:https:
3639
[role="_additional-resources"]
3740
.Additional resources
3841

39-
* For more information and troubleshooting help, see the link:https://docs.aws.amazon.com/vpc/latest/peering/what-is-vpc-peering.html[AWS VPC] guide.
42+
* link:https://docs.aws.amazon.com/vpc/latest/peering/what-is-vpc-peering.html[AWS VPC guide]

modules/aws-vpn.adoc

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,24 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="aws-vpn_{context}"]
7-
= Configuring an AWS VPN
7+
= Configure an AWS Virtual Private Network
88

9-
10-
You can configure an {AWS} {product-title} cluster to use a customer’s on-site hardware Virtual Private Network (VPN) device. By default, instances that you launch into an AWS Virtual Private Cloud (VPC) cannot communicate with your own (remote) network. You can enable access to your remote network from your VPC by creating an AWS Site-to-Site VPN connection, and configuring routing to pass traffic through the connection.
9+
[role="_abstract"]
10+
Configure an AWS Site-to-Site Virtual Private Network (VPN) connection to enable secure communication between your {product-title} cluster Virtual Private Cloud (VPC) and your remote on-site network.
1111

1212
[NOTE]
1313
====
14-
AWS VPN does not currently provide a managed option to apply NAT to VPN traffic. See the link:https://aws.amazon.com/premiumsupport/knowledge-center/configure-nat-for-vpn-traffic/[AWS Knowledge Center] for more details.
14+
AWS VPN does not currently provide a managed option to apply Network Address Translation (NAT) to VPN traffic. See the link:https://aws.amazon.com/premiumsupport/knowledge-center/configure-nat-for-vpn-traffic/[AWS Knowledge Center] for more details.
1515
1616
Routing all traffic, for example `0.0.0.0/0`, through a private connection is not supported. This requires deleting the internet gateway, which disables SRE management traffic.
1717
====
1818

1919
.Prerequisites
2020

21-
* Hardware VPN gateway device model and software version, for example Cisco ASA running version 8.3. See the link:https://docs.aws.amazon.com/vpc/latest/adminguide/Introduction.html#DevicesTested[AWS documentation] to confirm whether your gateway device is supported by AWS.
21+
* Hardware VPN gateway device model and software version, for example Cisco Adaptive Security Appliance (ASA) running version 8.3. See the link:https://docs.aws.amazon.com/vpc/latest/adminguide/Introduction.html#DevicesTested[AWS documentation] to confirm whether your gateway device is supported by AWS.
2222
* Public, static IP address for the VPN gateway device.
23-
* BGP or static routing: if BGP, the ASN is required. If static routing, you must
24-
configure at least one static route.
25-
* Optional: IP and port/protocol of a reachable service to test the VPN connection.
23+
* Border Gateway Protocol (BGP) or static routing: if BGP, the Autonomous System Number (ASN) is available. If static routing, at least one static route is configured.
24+
* Optional: Internet Protocol (IP) address and port/protocol of a reachable service to test the VPN connection.
2625
2726
.Procedure
2827

@@ -44,4 +43,4 @@ Note the VPC subnet information, which you must add to your configuration as the
4443
[role="_additional-resources"]
4544
.Additional resources
4645

47-
* For more information and troubleshooting help, see the link:https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html[AWS VPN] guide.
46+
* link:https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html[AWS VPN guide]

modules/cloud-experts-deploying-application-scaling-node-autoscaling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[role="_abstract"]
1010
{product-title} allows you to use node autoscaling. In this scenario, you will create a new project with a job that has a large workload that the cluster cannot handle. With autoscaling enabled, when the load is larger than your current capacity, the cluster will automatically create new nodes to handle the load.
1111

12-
{product-title} allows you to use link:https://docs.openshift.com/rosa/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.html[node autoscaling]. In this scenario, you will create a new project with a job that has a large workload that the cluster cannot handle. With autoscaling enabled, when the load is larger than your current capacity, the cluster will automatically create new nodes to handle the load.
12+
{product-title} allows you to use link:https://docs.openshift.com/rosa/rosa_cluster_admin/rosa-nodes-about-autoscaling-nodes.html[node autoscaling]. In this scenario, you will create a new project with a job that has a large workload that the cluster cannot handle. With autoscaling enabled, when the load is larger than your current capacity, the cluster will automatically create new nodes to handle the load.
1313

1414
.Prerequisites
1515

modules/cluster-autoscaler-about.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010

1111
:_mod-docs-content-type: CONCEPT
1212
[id="cluster-autoscaler-about_{context}"]
13-
= About the cluster autoscaler
13+
= The cluster autoscaler
1414

1515
[role="_abstract"]
16-
The cluster autoscaler adjusts the size of an {product-title} cluster to meet its current deployment needs. It uses declarative, Kubernetes-style arguments to provide infrastructure management that does not rely on objects of a specific cloud provider. The cluster autoscaler has a cluster scope, and is not associated with a particular namespace.
16+
The cluster autoscaler adjusts the size of an {product-title} cluster to meet its current deployment needs. It uses declarative, Kubernetes-style arguments to provide infrastructure management that does not rely on objects of a specific cloud provider.
1717
ifdef::openshift-rosa-hcp[]
1818
In {product-title}, the Cluster Autoscaler is fully managed, which means it is hosted along with the control plane.
1919
endif::openshift-rosa-hcp[]

modules/config-aws-access.adoc

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="config-aws-access_{context}"]
7+
= Configure AWS infrastructure access
78

8-
= Configuring AWS infrastructure access
9-
10-
// TODO: I see {AWS} and {GCP} only used a handful of time, but their written out form much more. Should all hardcoded instances be updated to use the attributes?
11-
{AWS} infrastructure access allows link:https://access.redhat.com/node/3610411[Customer Portal Organization Administrators] and cluster owners to enable AWS Identity and Access Management (IAM) users to have federated access to the AWS Management Console for their {product-title} cluster. Administrators can select between `Network Management` or `Read-only` access options.
9+
[role="_abstract"]
10+
Configure AWS infrastructure access to enable AWS Identity and Access Management (IAM) users to have federated access to the AWS Management Console for your {product-title} cluster.
1211

1312
.Prerequisites
1413

@@ -54,7 +53,7 @@ It is not recommended to set a permissions boundary.
5453

5554
.. Click *Next: Tags*, then click *Next: Review*. Confirm the configuration is correct.
5655
.. Click *Create user*, a success page appears.
57-
.. Gather the IAM user’s Amazon Resource Name (ARN). The ARN will have the following format: `arn:aws:iam::000111222333:user/username`. Click *Close*.
56+
.. Gather the IAM user’s Amazon Resource Name (ARN). The ARN has the following format: `arn:aws:iam::000111222333:user/username`. Click *Close*.
5857

5958
. Open {cluster-manager-url} in your browser and select the cluster you want to allow AWS infrastructure access.
6059

@@ -66,10 +65,6 @@ It is not recommended to set a permissions boundary.
6665

6766
. Sign in to your AWS account with your Account ID or alias, IAM user name, and password.
6867

69-
. In a new browser tab, paste the AWS OSD Console URL that will be used to route to the AWS Switch Role page.
70-
71-
. Your account number and role will be filled in already. Choose a display name if necessary, then click *Switch Role*.
72-
73-
.Verification
68+
. In a new browser tab, paste the AWS OSD Console URL that routes to the AWS Switch Role page.
7469

75-
* You now see *VPC* under *Recently visited services*.
70+
. Your account number and role are filled in already. Choose a display name if necessary, then click *Switch Role*.

0 commit comments

Comments
 (0)