Skip to content

Commit 6fd3b60

Browse files
authored
Merge pull request #39614 from mjpytlak/osdocs-2647-gov
OSDOCS2647: Adding AWS GovCloud-specific installation topic
2 parents 33ac65e + 373bd2d commit 6fd3b60

11 files changed

+169
-73
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Topics:
120120
File: installing-aws-vpc
121121
- Name: Installing a private cluster on AWS
122122
File: installing-aws-private
123-
- Name: Installing a cluster on AWS into a government or secret region
123+
- Name: Installing a cluster on AWS into a government region
124124
File: installing-aws-government-region
125125
- Name: Installing a cluster on AWS into a China region
126126
File: installing-aws-china

installing/installing_aws/installing-aws-government-region.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[id="installing-aws-government-region"]
2-
= Installing a cluster on AWS into a government or secret region
2+
= Installing a cluster on AWS into a government region
33
include::modules/common-attributes.adoc[]
44
:context: installing-aws-government-region
55

66
toc::[]
77

88
In {product-title} version {product-version}, you can install a cluster on
9-
Amazon Web Services (AWS) into a government or secret region. To configure the
9+
Amazon Web Services (AWS) into a government region. To configure the
1010
region, modify parameters in the `install-config.yaml` file before you
1111
install the cluster.
1212

@@ -24,7 +24,7 @@ If you have an AWS profile stored on your computer, it must not use a temporary
2424
* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../installing/installing_aws/manually-creating-iam.adoc#manually-creating-iam-aws[manually create and maintain IAM credentials].
2525

2626
include::modules/installation-aws-about-government-region.adoc[leveloffset=+1]
27-
include::modules/installation-aws-regions-with-no-ami.adoc[leveloffset=+1]
27+
include::modules/installation-prereq-aws-private-cluster.adoc[leveloffset=+1]
2828

2929
include::modules/private-clusters-default.adoc[leveloffset=+1]
3030
include::modules/private-clusters-about-aws.adoc[leveloffset=+2]
@@ -35,8 +35,6 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
3535

3636
include::modules/ssh-agent-using.adoc[leveloffset=+1]
3737

38-
include::modules/installation-aws-upload-custom-rhcos-ami.adoc[leveloffset=+1]
39-
4038
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
4139

4240
include::modules/installation-initializing-manual.adoc[leveloffset=+1]

modules/installation-aws-about-government-region.adoc

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,50 @@
22
//
33
// * installing/installing_aws/installing-aws-government-region.adoc
44

5-
[id="installation-aws-about-government-region_{context}"]
6-
= AWS government and secret regions
5+
ifeval::["{context}" == "installing-aws-government-region"]
6+
:aws-gov:
7+
endif::[]
8+
ifeval::["{context}" == "installing-aws-secret-region"]
9+
:aws-secret:
10+
endif::[]
711

8-
{product-title} supports deploying a cluster to
9-
link:https://aws.amazon.com/govcloud-us[AWS GovCloud (US)] regions and the link:https://aws.amazon.com/federal/us-intelligence-community/[AWS Commercial Cloud Services (C2S) Secret Region]. These regions are specifically designed for US government agencies at the federal, state, and
10-
local level, as well as contractors, educational institutions, and other US
11-
customers that must run sensitive workloads in the cloud.
12+
[id="installation-aws-about-gov-secret-region_{context}"]
13+
ifdef::aws-gov[]
14+
= AWS government regions
15+
endif::aws-gov[]
16+
ifdef::aws-secret[]
17+
= AWS secret region
18+
endif::aws-secret[]
1219

13-
These regions do not have published {op-system-first} Amazon Machine Images (AMI) to select, so you
20+
ifdef::aws-gov[]
21+
{product-title} supports deploying a cluster to an link:https://aws.amazon.com/govcloud-us[AWS GovCloud (US)] region.
22+
endif::aws-gov[]
23+
24+
ifdef::aws-secret[]
25+
{product-title} supports deploying a cluster to an link:https://aws.amazon.com/federal/us-intelligence-community/[AWS Commercial Cloud Services (C2S) Secret Region].
26+
endif::aws-secret[]
27+
28+
ifdef::aws-secret[]
29+
The C2S Secret Region does not have a published {op-system-first} Amazon Machine Images (AMI) to select, so you
1430
must upload a custom AMI that belongs to that region.
31+
endif::aws-secret[]
1532

33+
ifdef::aws-gov[]
1634
The following AWS GovCloud partitions are supported:
1735

18-
* `us-gov-west-1`
1936
* `us-gov-east-1`
37+
* `us-gov-west-1`
38+
endif::aws-gov[]
2039
40+
ifdef::aws-secret[]
2141
The following AWS Secret Region partition is supported:
2242

2343
* `us-iso-east-1`
44+
endif::aws-secret[]
45+
46+
ifeval::["{context}" == "installing-aws-government-region"]
47+
:!aws-gov:
48+
endif::[]
49+
ifeval::["{context}" == "installing-aws-secret-region"]
50+
:!aws-secret:
51+
endif::[]

modules/installation-aws-config-yaml.adoc

Lines changed: 45 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ ifeval::["{context}" == "installing-aws-government-region"]
2525
:private:
2626
:gov:
2727
endif::[]
28+
ifeval::["{context}" == "installing-aws-secret-region"]
29+
:vpc:
30+
:private:
31+
:secret:
32+
endif::[]
2833
ifeval::["{context}" == "installing-aws-china-region"]
2934
:vpc:
3035
:private:
@@ -41,20 +46,20 @@ You can customize the installation configuration file (`install-config.yaml`) to
4146
your {product-title} cluster's platform or modify the values of the required
4247
parameters.
4348

44-
ifndef::china,gov[]
49+
ifndef::china,gov,secret[]
4550
[IMPORTANT]
4651
====
4752
This sample YAML file is provided for reference only. You must obtain your
4853
`install-config.yaml` file by using the installation program and modify it.
4954
====
50-
endif::china,gov[]
55+
endif::china,gov,secret[]
5156

52-
ifdef::china,gov[]
57+
ifdef::china,gov,secret[]
5358
[IMPORTANT]
5459
====
5560
This sample YAML file is provided for reference only. Use it as a resource to enter parameter values into the installation configuration file that you created manually.
5661
====
57-
endif::china,gov[]
62+
endif::china,gov,secret[]
5863

5964
[source,yaml]
6065
----
@@ -75,10 +80,14 @@ ifdef::gov[]
7580
- us-gov-west-1a
7681
- us-gov-west-1b
7782
endif::gov[]
78-
ifndef::gov,china[]
83+
ifdef::secret[]
84+
- us-iso-east-1a
85+
- us-iso-east-1b
86+
endif::secret[]
87+
ifndef::gov,china,secret[]
7988
- us-west-2a
8089
- us-west-2b
81-
endif::gov,china[]
90+
endif::gov,china,secret[]
8291
rootVolume:
8392
iops: 4000
8493
size: 500
@@ -102,9 +111,12 @@ endif::china[]
102111
ifdef::gov[]
103112
- us-gov-west-1c
104113
endif::gov[]
105-
ifndef::gov,china[]
114+
ifdef::secret[]
115+
- us-iso-east-1a
116+
endif::secret[]
117+
ifndef::gov,china,secret[]
106118
- us-west-2c
107-
endif::gov,china[]
119+
endif::gov,china,secret[]
108120
replicas: 3
109121
metadata:
110122
name: test-cluster <1>
@@ -129,15 +141,18 @@ endif::openshift-origin[]
129141
- 172.30.0.0/16
130142
platform:
131143
aws:
132-
ifndef::gov,china[]
144+
ifndef::gov,china,secret[]
133145
region: us-west-2 <1>
134-
endif::gov,china[]
146+
endif::gov,china,secret[]
135147
ifdef::china[]
136148
region: cn-north-1 <1>
137149
endif::china[]
138150
ifdef::gov[]
139151
region: us-gov-west-1 <1>
140152
endif::gov[]
153+
ifdef::secret[]
154+
region: us-iso-east-1 <1>
155+
endif::secret[]
141156
userTags:
142157
adminContact: jdoe
143158
costCenter: 7536
@@ -146,12 +161,12 @@ ifdef::vpc,restricted[]
146161
- subnet-1
147162
- subnet-2
148163
- subnet-3
149-
ifndef::gov,china[]
164+
ifndef::secret,china[]
150165
amiID: ami-96c6f8f7 <8>
151-
endif::gov,china[]
152-
ifdef::gov,china[]
166+
endif::secret,china[]
167+
ifdef::secret,china[]
153168
amiID: ami-96c6f8f7 <1> <8>
154-
endif::gov,china[]
169+
endif::secret,china[]
155170
serviceEndpoints: <9>
156171
- name: ec2
157172
ifndef::china[]
@@ -202,27 +217,27 @@ ifdef::openshift-origin[]
202217
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <12>
203218
endif::openshift-origin[]
204219
endif::restricted[]
205-
ifdef::gov[]
220+
ifdef::secret[]
206221
ifndef::openshift-origin[]
207222
additionalTrustBundle: | <14>
208223
-----BEGIN CERTIFICATE-----
209224
<MY_TRUSTED_CA_CERT>
210225
-----END CERTIFICATE-----
211226
endif::openshift-origin[]
212-
endif::gov[]
227+
endif::secret[]
213228
ifdef::private[]
214229
ifdef::openshift-origin[]
215230
publish: Internal <12>
216231
endif::openshift-origin[]
217232
endif::private[]
218-
ifdef::gov[]
233+
ifdef::secret[]
219234
ifdef::openshift-origin[]
220235
additionalTrustBundle: | <13>
221236
-----BEGIN CERTIFICATE-----
222237
<MY_TRUSTED_CA_CERT>
223238
-----END CERTIFICATE-----
224239
endif::openshift-origin[]
225-
endif::gov[]
240+
endif::secret[]
226241
ifdef::restricted[]
227242
ifndef::openshift-origin[]
228243
additionalTrustBundle: | <14>
@@ -254,13 +269,13 @@ endif::restricted[]
254269
255270
256271
----
257-
ifndef::gov,china[]
272+
ifndef::gov,secret,china[]
258273
<1> Required. The installation program prompts you for this value.
259-
endif::gov,china[]
260-
ifdef::gov,china[]
274+
endif::gov,secret,china[]
275+
ifdef::gov,secret,china[]
261276
<1> Required.
262-
endif::gov,china[]
263-
<2> Optional: Add this parameter to force the Cloud Credential Operator (CCO) to use the specified mode, instead of having the CCO dynamically try to determine the capabilities of the credentials. For details about CCO modes, see the _Cloud Credential Operator_ entry in the _Platform Operators reference_ content.
277+
endif::gov,secret,china[]
278+
<2> Optional: Add this parameter to force the Cloud Credential Operator (CCO) to use the specified mode, instead of having the CCO dynamically try to determine the capabilities of the credentials. For details about CCO modes, see the _Cloud Credential Operator_ entry in the _Red Hat Operators reference_ content.
264279
<3> If you do not provide these parameters and values, the installation program
265280
provides the default value.
266281
<4> The `controlPlane` section is a single mapping, but the compute section is a
@@ -343,14 +358,14 @@ ifdef::openshift-origin[]
343358
<12> How to publish the user-facing endpoints of your cluster. Set `publish` to `Internal` to deploy a private cluster, which cannot be accessed from the internet. The default value is `External`.
344359
endif::openshift-origin[]
345360
endif::private[]
346-
ifdef::gov[]
361+
ifdef::secret[]
347362
ifndef::openshift-origin[]
348363
<14> The custom CA certificate. This is required when deploying to the AWS C2S Secret Region because the AWS API requires a custom CA trust bundle.
349364
endif::openshift-origin[]
350365
ifdef::openshift-origin[]
351366
<13> The custom CA certificate. This is required when deploying to the AWS C2S Secret Region because the AWS API requires a custom CA trust bundle.
352367
endif::openshift-origin[]
353-
endif::gov[]
368+
endif::secret[]
354369
ifdef::restricted[]
355370
ifndef::openshift-origin[]
356371
<13> For `<local_registry>`, specify the registry domain name, and optionally the
@@ -388,6 +403,11 @@ ifeval::["{context}" == "installing-aws-government-region"]
388403
:!private:
389404
:!gov:
390405
endif::[]
406+
ifeval::["{context}" == "installing-aws-secret-region"]
407+
:!vpc:
408+
:!private:
409+
:!secret:
410+
endif::[]
391411
ifeval::["{context}" == "installing-aws-china-region"]
392412
:!vpc:
393413
:!private:
Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing_aws/installing-aws-china.adoc
4-
// * installing/installing_aws/installing-aws-government-region.adoc
54
// * installing/installing_aws/installing-aws-user-infra.adoc
5+
// * installing/installing_aws/installing-aws-secret.adoc
66

77
ifeval::["{context}" == "installing-aws-china-region"]
88
:aws-china:
99
endif::[]
10-
ifeval::["{context}" == "installing-aws-government-region"]
11-
:aws-gov:
10+
ifeval::["{context}" == "installing-aws-secret-region"]
11+
:aws-secret:
1212
endif::[]
13+
// ifeval::["{context}" == "installing-aws-government-region"]
14+
// :aws-gov:
15+
// endif::[]
1316

1417
[id="installation-aws-regions-with-no-ami_{context}"]
15-
ifndef::aws-china,aws-gov[]
18+
ifndef::aws-china,aws-secret[]
1619
= AWS regions without a published {op-system} AMI
17-
endif::aws-china,aws-gov[]
20+
endif::aws-china,aws-secret[]
1821

19-
ifdef::aws-china,aws-gov[]
20-
= Installation requirments
21-
endif::aws-china,aws-gov[]
22+
ifdef::aws-china,aws-secret[]
23+
= Installation requirements
24+
endif::aws-china,aws-secret[]
2225

23-
ifndef::aws-china,aws-gov[]
26+
ifndef::aws-china,aws-secret[]
2427
You can deploy an {product-title} cluster to Amazon Web Services (AWS) regions
2528
without native support for a {op-system-first} Amazon Machine Image (AMI) or the
2629
AWS software development kit (SDK). If a
@@ -39,11 +42,11 @@ A region without native support for an {op-system} AMI is not available to
3942
select from the terminal during cluster creation because it is not published.
4043
However, you can install to this region by configuring the custom AMI in the
4144
`install-config.yaml` file.
42-
endif::aws-china,aws-gov[]
45+
endif::aws-china,aws-secret[]
4346

44-
ifdef::aws-china,aws-gov[]
47+
ifdef::aws-china,aws-secret[]
4548
ifdef::aws-china[Red Hat does not publish a {op-system-first} Amazon Machine Image (AMI) for the AWS China regions.]
46-
ifdef::aws-gov[Red Hat does not publish a {op-system-first} Amzaon Machine Image for the AWS government or secret regions.]
49+
ifdef::aws-secret[Red Hat does not publish a {op-system-first} Amzaon Machine Image for the AWS secret region.]
4750

4851
Before you can install the cluster, you must:
4952

@@ -53,18 +56,21 @@ Before you can install the cluster, you must:
5356
5457
You cannot use the {product-title} installation program to create the installation configuration file. The installer does not list an AWS region without native support for an {op-system} AMI.
5558

56-
ifdef::aws-gov[]
59+
ifdef::aws-secret[]
5760
[IMPORTANT]
5861
====
5962
If you are deploying to the C2S Secret Region, you must also define a custom CA certificate in the `additionalTrustBundle` field of the `install-config.yaml` file because the AWS API requires a custom CA trust bundle. To allow the installation program to access the AWS API, the CA certificates must also be defined on the machine that runs the installation program. You must add the CA bundle to the trust store on the machine, use the `AWS_CA_BUNDLE` environment variable, or define the CA bundle in the link:https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-ca_bundle.html[`ca_bundle`] field of the AWS config file.
6063
====
61-
endif::aws-gov[]
64+
endif::aws-secret[]
6265

63-
endif::aws-china,aws-gov[]
66+
endif::aws-china,aws-secret[]
6467

6568
ifeval::["{context}" == "installing-aws-china-region"]
6669
:!aws-china:
6770
endif::[]
68-
ifeval::["{context}" == "installing-aws-government-region"]
69-
:!aws-gov:
71+
ifeval::["{context}" == "installing-aws-secret-region"]
72+
:!aws-secret:
7073
endif::[]
74+
// ifeval::["{context}" == "installing-aws-government-region"]
75+
// :!aws-gov:
76+
// endif::[]

modules/installation-configuration-parameters.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ endif::[]
4848
ifeval::["{context}" == "installing-aws-government-region"]
4949
:aws:
5050
endif::[]
51+
ifeval::["{context}" == "installing-aws-secret-region"]
52+
:aws:
53+
endif::[]
5154
ifeval::["{context}" == "installing-aws-network-customizations"]
5255
:aws:
5356
endif::[]
@@ -1280,6 +1283,9 @@ endif::[]
12801283
ifeval::["{context}" == "installing-aws-government-region"]
12811284
:!aws:
12821285
endif::[]
1286+
ifeval::["{context}" == "installing-aws-secret-region"]
1287+
:!aws:
1288+
endif::[]
12831289
ifeval::["{context}" == "installing-aws-network-customizations"]
12841290
:!aws:
12851291
endif::[]
@@ -1392,4 +1398,3 @@ endif::[]
13921398
ifeval::["{context}" == "installing-restricted-networks-ibm-power"]
13931399
:!ibm-power:
13941400
endif::[]
1395-

0 commit comments

Comments
 (0)