Skip to content

Commit 40ce16e

Browse files
mjpytlakmjpytlak
authored
Merge pull request #48413 from mjpytlak/osdocs-3030
OSDOCS-3030: Added AWS Marketplace install content
2 parents 65829c9 + 5f14980 commit 40ce16e

7 files changed

+105
-7
lines changed

‎installing/installing_aws/installing-aws-account.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ include::modules/installation-aws-iam-user.adoc[leveloffset=+1]
2626
2727
include::modules/installation-aws-permissions-iam-roles.adoc[leveloffset=+1]
2828

29+
include::modules/installation-aws-marketplace.adoc[leveloffset=+1]
30+
2931
include::modules/installation-aws-regions.adoc[leveloffset=+1]
3032

3133
== Next steps

‎installing/installing_aws/installing-aws-customizations.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
3333

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

36+
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
37+
3638
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
3739

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
3737

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

40+
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
41+
4042
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
4143

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

‎installing/installing_aws/installing-aws-user-infra.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The steps for performing a user-provisioned infrastructure installation are prov
2525
====
2626
If you have an AWS profile stored on your computer, it must not use a temporary session token that you generated while using a multi-factor authentication device. The cluster continues to use your current AWS credentials to create AWS resources for the entire life of the cluster, so you must use key-based, long-lived credentials. To generate appropriate keys, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html[Managing Access Keys for IAM Users] in the AWS documentation. You can supply the keys when you run the installation program.
2727
====
28-
* You downloaded the AWS CLI and installed it on your computer. See link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or Unix)] in the AWS documentation.
28+
* You downloaded the AWS CLI and installed it on your computer. See link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or UNIX)] in the AWS documentation.
2929
* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.
3030
+
3131
[NOTE]
@@ -56,6 +56,8 @@ include::modules/installation-aws-user-infra-requirements.adoc[leveloffset=+1]
5656

5757
include::modules/installation-aws-permissions.adoc[leveloffset=+2]
5858

59+
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
60+
5961
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
6062

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

‎modules/installation-aws-marketplace-subscribe.adoc‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_aws/installing-aws-customizations.adoc
4+
// * installing/installing_aws/installing-aws-government-region.adoc
5+
// * installing/installing_aws/installing-aws-user-infra.adoc
6+
7+
ifeval::["{context}" == "installing-aws-customizations"]
8+
:ipi:
9+
endif::[]
10+
ifeval::["{context}" == "installing-aws-government-region"]
11+
:ipi:
12+
endif::[]
13+
ifeval::["{context}" == "installing-aws-user-infra"]
14+
:upi:
15+
endif::[]
16+
17+
:_content-type: PROCEDURE
18+
[id="installation-aws-marketplace-subscribe_{context}"]
19+
= Obtaining an AWS Marketplace image
20+
If you are deploying an {product-title} cluster using an AWS Marketplace image, you must first subscribe through AWS. Subscribing to the offer provides you with the AMI ID that the installation program uses to deploy worker nodes.
21+
22+
.Prerequisites
23+
24+
* You have an AWS account to purchase the offer. This account does not have to be the same account that is used to install the cluster.
25+
26+
.Procedure
27+
28+
. Complete the {product-title} subscription from the link:https://aws.amazon.com/marketplace/fulfillment?productId=59ead7de-2540-4653-a8b0-fa7926d5c845[AWS Marketplace].
29+
ifdef::ipi[]
30+
. Record the AMI ID for your specific region. As part of the installation process, you must update the `install-config.yaml` file with this value before deploying the cluster.
31+
endif::ipi[]
32+
ifdef::upi[]
33+
. Record the AMI ID for your specific region. If you use the CloudFormation template to deploy your worker nodes, you must update the `worker0.type.properties.ImageID` parameter with this value.
34+
endif::upi[]
35+
36+
ifdef::ipi[]
37+
.Sample `install-config.yaml` file with AWS Marketplace worker nodes
38+
39+
[source,yaml]
40+
----
41+
apiVersion: v1
42+
baseDomain: example.com
43+
compute:
44+
- hyperthreading: Enabled
45+
name: worker
46+
platform:
47+
aws:
48+
amiID: ami-06c4d345f7c207239 <1>
49+
type: m5.4xlarge
50+
replicas: 3
51+
metadata:
52+
name: test-cluster
53+
platform:
54+
aws:
55+
region: us-east-2 <2>
56+
sshKey: ssh-ed25519 AAAA...
57+
pullSecret: '{"auths": ...}'
58+
----
59+
<1> The AMI ID from your AWS Marketplace subscription.
60+
<2> Your AMI ID is associated with a specific AWS region. When creating the installation configuration file, ensure that you select the same AWS region that you specified when configuring your subscription.
61+
endif::ipi[]
62+
63+
ifeval::["{context}" == "installing-aws-customizations"]
64+
:!ipi:
65+
endif::[]
66+
ifeval::["{context}" == "installing-aws-government-region"]
67+
:!ipi:
68+
endif::[]
69+
ifeval::["{context}" == "installing-aws-user-infra"]
70+
:!upi:
71+
endif::[]

‎modules/installation-aws-marketplace.adoc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_aws/installing-aws-account.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="installation-aws-marketplace_{context}"]
7+
= Supported AWS Marketplace regions
8+
9+
Installing an {product-title} cluster using an AWS Marketplace image is available to customers who purchase the offer in North America.
10+
11+
While the offer must be purchased in North America, you can deploy the cluster to any of the following supported paritions:
12+
13+
* Public
14+
* GovCloud
15+
16+
[NOTE]
17+
====
18+
Deploying a {product-title} cluster using an AWS Marketplace image is not supported for the AWS secret regions or China regions.
19+
====

‎modules/installation-creating-aws-worker.adoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,13 @@ config files for the cluster.
8888
file metadata, which has the format `<cluster-name>-<random-string>`.
8989
<3> Current {op-system-first} AMI to use for the worker nodes based on your selected architecture.
9090
<4> Specify an `AWS::EC2::Image::Id` value.
91-
<5> A subnet, preferably private, to launch the worker nodes on.
91+
<5> A subnet, preferably private, to start the worker nodes on.
9292
<6> Specify a subnet from the `PrivateSubnets` value from the output of the
9393
CloudFormation template for DNS and load balancing.
9494
<7> The worker security group ID to associate with worker nodes.
9595
<8> Specify the `WorkerSecurityGroupId` value from the output of the
9696
CloudFormation template for the security group and roles.
97-
<9> The location to fetch bootstrap Ignition config file from.
97+
<9> The location to fetch the bootstrap Ignition config file from.
9898
<10> Specify the generated Ignition config location,
9999
`https://api-int.<cluster_name>.<domain_name>:22623/config/worker`.
100100
<11> Base64 encoded certificate authority string to use.
@@ -114,11 +114,11 @@ endif::openshift-origin[]
114114
section of this topic and save it as a YAML file on your computer. This template
115115
describes the networking objects and load balancers that your cluster requires.
116116

117-
. If you specified an `m5` instance type as the value for `WorkerInstanceType`,
118-
add that instance type to the `WorkerInstanceType.AllowedValues` parameter
119-
in the CloudFormation template.
117+
. Optional: If you specified an `m5` instance type as the value for `WorkerInstanceType`, add that instance type to the `WorkerInstanceType.AllowedValues` parameter in the CloudFormation template.
120118

121-
. Launch the CloudFormation template to create a stack of AWS resources that represent a worker node:
119+
. Optional: If you are deploying with an AWS Marketplace image, update the `Worker0.type.properties.ImageID` parameter with the AMI ID that you obtained from your subscription.
120+
121+
. Use the CloudFormation template to create a stack of AWS resources that represent a worker node:
122122
+
123123
[IMPORTANT]
124124
====

0 commit comments

Comments
 (0)