AWSInstanceClass

Scope: Cluster

Parameters of the AWS instance used by machine-controller-manager (the node-manager modile).

The CloudInstanceClass resource of the node-manager module refers to this resource.

  • spec (object)

    Required value.

    • additionalSecurityGroups (array of strings)

      The additional security groups to add to provisioned instances of the specific InstanceClass.

    • additionalTags (object)

      Extra AWS tags for instances in addition to AWSClusterConfiguration.tags.

    • ami (string)

      The Amazon Machine Image (AMI ID) to use in provisioned instances.

      Here is how you can find the required AMI (each region has its own set of AMIs):

      aws ec2 --region <REGION> describe-images \
      --filters 'Name=name,Values=ubuntu/images/hvm-ssd/ubuntu-bionic-18.04-amd64-server-2020*' | \
      jq '.Images[].ImageId'
      

      Example: "ami-040a1551f9c9d11ad"

    • diskSizeGb (integer)

      Instance root disk size in gigabytes.

      Default: 20

      Example: 20

    • diskType (string)

      Instance EBS disk type.

      Default: "gp2"

      Example: "gp2"

    • instanceType (string)

      Instance type of AWS instance.

      Caution! Ensure that this type is present in all zones specified in the zones parameter.

      Example: "t3.large"

      Required value.

    • iops (string)

      IOPS rate for io1 diskType

      Example: "500"

    • spot (boolean)

      Whether to create Spot Instances with minimum hourly price with which Instances will run.

Parameters of the AWS instance used by machine-controller-manager (the node-manager modile).

The CloudInstanceClass resource of the node-manager module refers to this resource.

  • spec (object)

    Required value.

    • additionalSecurityGroups (array of strings)

      The additional security groups to add to provisioned instances of the specific InstanceClass.

    • additionalTags (object)

      Extra AWS tags for instances in addition to AWSClusterConfiguration.tags.

    • ami (string)

      The Amazon Machine Image (AMI ID) to use in provisioned instances.

      Here is how you can find the required AMI (each region has its own set of AMIs):

      aws ec2 --region <REGION> describe-images \
      --filters 'Name=name,Values=ubuntu/images/hvm-ssd/ubuntu-bionic-18.04-amd64-server-2020*' | \
      jq '.Images[].ImageId'
      

      Example: "ami-040a1551f9c9d11ad"

    • diskSizeGb (integer)

      Instance root disk size in gigabytes.

      Default: 20

      Example: 20

    • diskType (string)

      Instance EBS disk type.

      Default: "gp2"

      Example: "gp2"

    • instanceType (string)

      Instance type of AWS instance.

      Caution! Ensure that this type is present in all zones specified in the zones parameter.

      Example: "t3.large"

      Required value.

    • iops (string)

      IOPS rate for io1 diskType

      Example: "500"

    • spot (boolean)

      Whether to create Spot Instances with minimum hourly price with which Instances will run.