Skip to content

Latest commit

 

History

History
87 lines (73 loc) · 2.94 KB

customization.md

File metadata and controls

87 lines (73 loc) · 2.94 KB
Raw

AWS Platform Customization

Beyond the platform-agnostic install-config.yaml properties, 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.
  • 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 which applies to 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. This is only valid for type io1.
    • size (optional integer): Size of the root volume in gibibytes (GiB).
    • type (optional string): The type of volume.
  • type (optional string): The EC2 instance type.
  • zones (optional array of strings): The availability zones used for machines in the pool.

Examples

Some example install-config.yaml are shown below. For examples of platform-agnostic configuration fragments, see here.

Minimal

An example minimal AWS install config is:

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:

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:
      rootVolume:
        iops: 4000
        size: 500
        type: io1
      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...