mirror of
https://github.com/openshift/installer.git
synced 2026-02-05 06:46:36 +01:00
d93d030520
GP3 volumes have the ability to configure throughput from 125 MiB/s to 2000 MiB/s. This allows the ability to set this at install time in the install-config. https://issues.redhat.com/browse/CORS-4212
126 lines
4.9 KiB
Markdown
126 lines
4.9 KiB
Markdown
# AWS Platform Customization
|
|
|
|
Beyond the [platform-agnostic `install-config.yaml` properties](../customization.md#platform-customization), the installer supports additional, AWS-specific properties.
|
|
|
|
## Cluster-scoped properties
|
|
|
|
* `amiID` (optional string): The AMI that should be used to boot machines for the cluster.
|
|
If set, the AMI should belong to the same region as the cluster. This field is now deprecated and `defaultMachinePlatform` should be used instead.
|
|
* `region` (required string): The AWS region where the cluster will be created.
|
|
* `subnets` (optional array of strings): Existing subnets (by ID) where cluster resources will be created.
|
|
Leave unset to have the installer create subnets in a new VPC on your behalf.
|
|
* `userTags` (optional object): Additional keys and values that the installer will add as tags to all resources that it creates.
|
|
Resources created by the cluster itself may not include these tags.
|
|
* `defaultMachinePlatform` (optional object): Default [AWS-specific machine pool properties](#machine-pools) which applies to [machine pools](../customization.md#machine-pools) that do not define their own AWS-specific properties.
|
|
|
|
## Machine pools
|
|
|
|
* `rootVolume` (optional object): Defines the root volume for EC2 instances in the machine pool.
|
|
* `iops` (optional integer): The amount of provisioned [IOPS][volume-iops].
|
|
This is only valid for `type` `io1`.
|
|
* `throughput` (optional integer): The amount of throughput in MiB/s [Throughput Performance][volume-throughput].
|
|
This is only valid for `type` `gp3`.
|
|
* `size` (optional integer): Size of the root volume in gibibytes (GiB).
|
|
* `type` (optional string): The [type of volume][volume-type].
|
|
* `kmsKeyARN` (optional string): The [ARN of KMS key][kms-key] that should be used to encrypt the EBS volume.
|
|
When no key is specified by user, the account's [default KMS Key][kms-key-default] for the region will be used.
|
|
Example ARN values are: `arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` or `arn:aws:kms:us-east-1:111122223333:alias/my-key`
|
|
* `type` (optional string): The [EC2 instance type][instance-type].
|
|
* `zones` (optional array of strings): The availability zones used for machines in the pool.
|
|
* `amiID` (optional string): The AMI that should be used to boot machines.
|
|
If set, the AMI should belong to the same region as the cluster.
|
|
|
|
## Installing to Existing VPC & Subnetworks
|
|
|
|
The installer can use an existing VPC and subnets when provisioning an OpenShift cluster. A VPC will be inferred from the provided subnets. For a standard installation, a private and public subnet should be specified. ([see example below](#pre-existing-vpc--subnets)). Both of the subnets must be within the IP range specified in `networking.machineNetwork`.
|
|
|
|
## Examples
|
|
|
|
Some example `install-config.yaml` are shown below.
|
|
For examples of platform-agnostic configuration fragments, see [here](../customization.md#examples).
|
|
|
|
### Minimal
|
|
|
|
An example minimal AWS install config is:
|
|
|
|
```yaml
|
|
apiVersion: v1
|
|
baseDomain: example.com
|
|
metadata:
|
|
name: test-cluster
|
|
platform:
|
|
aws:
|
|
region: us-west-2
|
|
pullSecret: '{"auths": ...}'
|
|
sshKey: ssh-ed25519 AAAA...
|
|
```
|
|
|
|
### Custom machine pools
|
|
|
|
An example AWS install config with custom machine pools:
|
|
|
|
```yaml
|
|
apiVersion: v1
|
|
baseDomain: example.com
|
|
controlPlane:
|
|
name: master
|
|
platform:
|
|
aws:
|
|
zones:
|
|
- us-west-2a
|
|
- us-west-2b
|
|
type: m5.xlarge
|
|
replicas: 3
|
|
compute:
|
|
- name: worker
|
|
platform:
|
|
aws:
|
|
amiID: ami-123456
|
|
rootVolume:
|
|
iops: 4000
|
|
size: 500
|
|
type: io1
|
|
kmsKeyARN: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
|
|
type: c5.9xlarge
|
|
zones:
|
|
- us-west-2c
|
|
replicas: 5
|
|
metadata:
|
|
name: test-cluster
|
|
platform:
|
|
aws:
|
|
region: us-west-2
|
|
pullSecret: '{"auths": ...}'
|
|
sshKey: ssh-ed25519 AAAA...
|
|
```
|
|
|
|
### Pre-existing VPC & Subnets
|
|
|
|
An example install config for installing to an existing VPC and subnets is:
|
|
|
|
```yaml
|
|
apiVersion: v1
|
|
baseDomain: example.com
|
|
metadata:
|
|
name: test-cluster
|
|
networking:
|
|
machineNetwork:
|
|
- cidr: 10.190.0.0/16
|
|
platform:
|
|
aws:
|
|
region: us-west-2
|
|
subnets:
|
|
- subnet-0e953079d31ec4c74
|
|
- subnet-05e6864f66a954c27
|
|
pullSecret: '{"auths": ...}'
|
|
sshKey: ssh-ed25519 AAAA...
|
|
```
|
|
|
|
[availablity-zones]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html
|
|
[instance-type]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
|
[kms-key-default]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetEbsDefaultKmsKeyId.html
|
|
[kms-key]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html
|
|
[volume-iops]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-io-characteristics.html
|
|
[volume-throughput]: https://docs.aws.amazon.com/ebs/latest/userguide/general-purpose.html#gp3-ebs-volume-type
|
|
[volume-type]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
|