Skip to content

Commit 30a8e9c

Browse files
committed
CQA Work for GovCloud Book
1 parent 41f1efb commit 30a8e9c

8 files changed

Lines changed: 38 additions & 39 deletions

modules/rosa-govcloud-deploy-cluster.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[id="rosa-govcloud-deploy-cluster_{context}"]
66
= Preparing to deploy a {product-title} cluster in AWS GovCloud
77

8+
[role="_abstract"]
89
To deploy a {product-title} cluster in AWS GovCloud, you must be logged in to your Red{nbsp}Hat FedRAMP account.
910

1011
.Prerequisites
@@ -20,19 +21,19 @@ To deploy a {product-title} cluster in AWS GovCloud, you must be logged in to yo
2021
+
2122
. In your terminal:
2223
+
23-
.. Run `rosa login` and paste your copied token in order to log into the service.
24+
.. Run `rosa login` and paste your copied token to log in to the service.
2425
+
2526
[source,terminal]
2627
----
2728
$ rosa login --govcloud --token=<TOKEN>
2829
----
2930
+
30-
====
3131
[NOTE]
32-
Depending on your AWS CLI configuration, you may need to add a government region to the end of the command string like `--region us-gov-west-1`.
32+
====
33+
Depending on your AWS CLI configuration, you might need to add a government region to the end of the command string, such as `--region us-gov-west-1`.
3334
====
3435
+
35-
.. Run `rosa whoami` to confirm all information is correct ensuring that you are using the AWS Gov region and the OCM API is “https://api.openshiftusgov.com”..
36+
.. Run `rosa whoami` to confirm all information is correct ensuring that you are using the AWS Gov region and the {cluster-manager-first} API is “https://api.openshiftusgov.com”..
3637
+
3738
[source,terminal]
3839
----

modules/rosa-govcloud-fedramp-signup.adoc

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,30 @@
66
[id="rosa-govcloud-fedramp-signup_{context}"]
77
= Signing up for a Red Hat FedRAMP account
88

9+
[role="_abstract"]
910
To access {product-title} in AWS GovCloud, you must sign up for a Red{nbsp}Hat FedRAMP account.
1011

1112
.Procedure
12-
. Navigate to link:https://console.redhat.com/openshift/create/rosa/govcloud[].
13+
. Navigate to link:https://console.redhat.com/openshift/create/rosa/govcloud[the ROSA GovCloud access request form].
1314
. Complete the access request form.
14-
. Click *Submit* to sign up.
15+
. Click *Submit* to sign up. You will receive a _Submission confirmation_.
1516
+
16-
You will receive a _Submission confirmation_.
17-
1817
Red{nbsp}Hat's confirmed stateside support team will contact you through email for the following information:
19-
20-
* *Admin details* to include your _organization name_, _administrator first and last name_ and _administrator email_.
21-
18+
+
19+
* *Admin details* to include your _organization name_, _administrator first and surname_ and _administrator email_.
2220
* *User authentication* option to the FedRAMP {hybrid-console-second} from one of the following two options:
23-
24-
** _Local group in a Red{nbsp}Hat managed Keycloak instance_, where users will be required to setup multi-factor authentication (MFA) with an approved device.
21+
** _Local group in a Red{nbsp}Hat managed Keycloak instance_, where users will be required to setup multifactor authentication (MFA) with an approved device.
2522
+
26-
====
2723
[NOTE]
24+
====
2825
Only device link:https://www.yubico.com/product/yubikey-5c-nfc-fips[YubiKEY 5C NFC FIPS] currently accepted.
2926
====
27+
+
3028
** _Customer managed Identity Provider (IdP), integrated via OpenID Connect (OIDC)_, where you will need to provide the following:
3129
*** *Discovery Endpoint:* The IdP's OIDC discovery URL (typically ending in _/.well-known/openid-configuration_). This allows Keycloak to automatically fetch most of the IdP's settings.
3230
*** *Client ID and secret:* Credentials that allow Keycloak to authenticate with the customer's IdP.
3331
*** *Email domain(s):* A list of approved email domains. Only users with an email address from one of these domains will be allowed to log in.
34-
*** *Essential claim:* A specific key-value pair (e.g., _"rh-approved": "true"_) that must be present in a user's token from the IdP to grant them access.
35-
+
36-
In this configuration, the customer takes on the responsibility for implementing FIPS 140-2 validated MFA.
32+
*** *Essential claim:* A specific key-value pair (e.g., _"rh-approved": "true"_) that must be present in a user's token from the IdP to grant them access. In this configuration, the customer takes on the responsibility for implementing FIPS 140-2 validated MFA.
3733

3834

3935
// Following process with a sign up button will not be available until https://issues.redhat.com/browse/CRCPLAN-397 is complete.

modules/rosa-govcloud-manage-fedramp.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ To change your FedRAMP account password, you must have access to your Red{nbsp}H
1010

1111
.Procedure
1212

13-
. Navigate to link:https://sso.openshiftusgov.com/realms/redhat-external/account[].
13+
. Navigate to link:https://sso.openshiftusgov.com/realms/redhat-external/account[the Red Hat FedRAMP account management page].
1414
. Sign in with your current username and password.
1515
. Under the middle box called _Account Security_, click *Signing In*.
16-
. Under _Basic Authentication_, select *Password*.
16+
. Under _Basic authentication_, select *Password*.
1717
. Click *Update* and choose a password that meets the following requirements:
1818
+
1919
* Minimum of fifteen (15) characters
2020
* At least one (1) upper-case letter
2121
* At least one (1) lower-case letter
2222
* At least one (1) number
23-
* At least one (1) special character (e.g. ~ ! @ # $ % ^ & * ( ) _ + = - [ ] / ? > <)
23+
* At least one (1) special character (e.g. ~ ! @ # $ % ^ & * ( ) _ + = - ' [ ] / ? > <)
2424
. Confirm your password.
2525
. Click *Submit*.

modules/rosa-govcloud-privatelink-create-cluster.adoc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
[id="rosa-aws-privatelink-create-cluster_{context}"]
66
= Creating an AWS PrivateLink cluster
77

8-
You can create an AWS PrivateLink cluster using the {rosa-cli-first}.
8+
[role="_abstract"]
9+
You can create an AWS PrivateLink cluster by using the {rosa-cli-first}.
910

1011
[NOTE]
1112
====
@@ -28,9 +29,7 @@ endif::openshift-rosa-hcp[]
2829
2930
.Procedure
3031

31-
Creating a cluster can take up to 40 minutes.
32-
33-
. With AWS PrivateLink, you can create a cluster with a single availability zone (Single-AZ) or multiple availability zones (Multi-AZ). In either case, your machine's classless inter-domain routing (CIDR) must match your virtual private cloud's CIDR. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.14/html/installing_on_aws/installing-aws-vpc#installation-custom-aws-vpc-requirements_installing-aws-vpc[Requirements for using your own VPC] and link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.14/html/installing_on_aws/installing-aws-vpc#installation-custom-aws-vpc-validation_installing-aws-vpc[VPC validation] for more information.
32+
. With AWS PrivateLink, you can create a cluster with a single availability zone (Single-AZ) or many availability zones (Multi-AZ). In either case, your machine's classless inter-domain routing (CIDR) must match your virtual private cloud's CIDR. See link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.14/html/installing_on_aws/installing-aws-vpc#installation-custom-aws-vpc-requirements_installing-aws-vpc[Requirements for using your own VPC] and link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.14/html/installing_on_aws/installing-aws-vpc#installation-custom-aws-vpc-validation_installing-aws-vpc[VPC validation] for more information.
3433
+
3534
[IMPORTANT]
3635
====
@@ -39,9 +38,12 @@ If you use a firewall, you must configure it so that {product-title} can access
3938
For more information, see the AWS PrivateLink firewall prerequisites section.
4039
====
4140
+
42-
--
43-
include::snippets/rosa-long-cluster-name.adoc[]
44-
--
41+
[NOTE]
42+
====
43+
If your cluster name is longer than 15 characters, it will contain an automatically generated domain prefix as a sub-domain for your provisioned cluster on `*.openshiftapps.com`.
44+
45+
To customize the subdomain, use the `--domain-prefix` flag. The domain prefix cannot be longer than 15 characters, must be unique, and cannot be changed after cluster creation.
46+
====
4547
+
4648
** To create a Single-AZ cluster:
4749
+
@@ -56,7 +58,7 @@ $ rosa create cluster --private-link --cluster-name=<cluster-name> [--machine-ci
5658
$ rosa create cluster --private-link --multi-az --cluster-name=<cluster-name> [--machine-cidr=<VPC CIDR>/16] --subnet-ids=<private-subnet-id1>,<private-subnet-id2>,<private-subnet-id3>
5759
----
5860

59-
. Enter the following command to check the status of your cluster. During cluster creation, the `State` field from the output will transition from `pending` to `installing`, and finally to `ready`.
61+
. Enter the following command to check the status of your cluster. During cluster creation, the `State` field from the output will change from `pending` to `installing`, and finally to `ready`.
6062
+
6163
[source,terminal]
6264
----

modules/rosa-govcloud-support-ticket.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55
[id="rosa-govcloud-support-ticket_{context}"]
66
= Opening a support ticket
77

8-
To get access to open a support ticket please complete the following.
8+
[role="_abstract"]
9+
To get access to open a support ticket, complete the following steps.
910

1011
.Procedure
1112

12-
. If you need to create an account, please contact fedramp-css@openshiftusgov.com.
13-
. Once access is granted, navigate to link:https://redhatgov.servicenowservices.com/css[].
13+
. If you need to create an account, contact fedramp-css@openshiftusgov.com.
14+
. After you receive access, navigate to link:https://redhatgov.servicenowservices.com/css[the Red Hat GovCloud support portal].
1415
. Click *Create Case* and complete the required information.
1516
. Click *Submit*.

rosa_govcloud/rosa-govcloud-account-management.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77
toc::[]
88

99
[role="_abstract"]
10-
Once you have access to the FedRAMP accounts, you can manage the credentials as needed.
10+
When you have access to the FedRAMP accounts, you can manage the credentials according to your needs.
1111

1212
include::modules/rosa-govcloud-manage-fedramp.adoc[leveloffset=+1]
1313

rosa_govcloud/rosa-govcloud-getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ toc::[]
1616
//Federal and government agencies can be granted access to the {product-title} in AWS GovCloud environment without further verification. However, commercial organizations and Federal Information Security Modernization Act (FISMA) R&D Universities must provide documentation to show that they are supporting a government contract or in the process of bidding on a government contract such as a request for proposal (RFP) or request for information (RFI) pre-bid stage. The customers who are in the government support verification process can review a subset of the FedRAMP Authority to Operate (ATO) documentation, but cannot gain access to the {product-title} in AWS GovCloud environment until verification is complete.
1717

1818
[role="_abstract"]
19-
This service is for use by federal and government agencies, or by commercial organizations and Federal Information Security Modernization Act (FISMA) R&D Universities supporting a government contract or in the process of bidding on a government contract such as a request for proposal (RFP) or request for information (RFI) pre-bid stage.
19+
This service is for use by federal and government agencies, or by commercial organizations and Federal Information Security Modernization Act (FISMA) research and development universities supporting a government contract or in the process of bidding on a government contract such as a request for proposal (RFP) or request for information (RFI) pre-bid stage.
2020

2121
//Snippet for accessing ROSA in AWS GovCloud
2222
include::snippets/rosa-access-govcloud.adoc[]

rosa_govcloud/rosa-install-govcloud-cluster.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77
toc::[]
88

99
[role="_abstract"]
10-
To install a {product-title} cluster in AWS GovCloud you must:
11-
12-
* Meet the requirements to access AWS GovCloud.
13-
* Complete the steps in xref:../rosa_govcloud/rosa-govcloud-getting-started.adoc#rosa-govcloud-getting-started[Getting started with {product-title} in AWS GovCloud]:
14-
** Preparing to access {product-title} in AWS GovCloud.
15-
** Signing up for a Red{nbsp}Hat FedRAMP account following.
10+
You can install a {product-title} cluster in AWS GovCloud with or without AWS PrivateLink. Before you begin, ensure that you meet the requirements to access AWS GovCloud, you have prepared to access {product-title} in AWS GovCloud, and you have signed up for a Red{nbsp}Hat FedRAMP account.
1611

1712
include::modules/rosa-govcloud-deploy-cluster.adoc[leveloffset=+1]
1813

1914
include::modules/rosa-govcloud-privatelink-create-cluster.adoc[leveloffset=+1]
15+
16+
[role="_additional-resources"]
17+
.Additional resources
18+
* xref:../rosa_govcloud/rosa-govcloud-getting-started.adoc#rosa-govcloud-getting-started[Getting started with {product-title} in AWS GovCloud]

0 commit comments

Comments
 (0)