The module is configured automatically based on the chosen placement strategy (the AWSClusterConfiguration custom resource). In most cases, you do not have to configure the module manually.

You can configure the number and parameters of provisioning machines in the cloud via the NodeGroup custom resource of the node-manager module. Also, in this custom resource, you can specify the instance class’s name for the above group of nodes (the cloudInstances.ClassReference NodeGroup parameter). In the case of the AWS cloud provider, the instance class is the AWSInstanceClass custom resource that stores specific parameters of the machines.

The module automatically creates StorageClasses that are available in AWS: gp3, gp2, sc1, and st1. It lets you configure disks with the required IOPS. Also, it can filter out the unnecessary StorageClasses (you can do this via the exclude parameter).

The module is configured using the ModuleConfig custom resource named cloud-provider-aws (learn more about setting up Deckhouse…).

Example of the ModuleConfig/cloud-provider-aws resource for configuring the module:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: cloud-provider-aws
spec:
  version: 1
  enabled: true
  settings: # <-- Module parameters from the "Parameters" section below.

Parameters

Schema version: 1

  • storageClass
    object
    • storageClass.default
      string

      The name of StorageClass that will be used by default in the cluster:

      • If the parameter is omitted, the default StorageClass is either:
        • an arbitrary StorageClass present in the cluster that has the default annotation;
        • the first (in lexicographic order) StorageClass of those created by the module.

      Example:

      default: gp3
    • storageClass.exclude
      array of strings

      A list of StorageClass names (or regex expressions for names) to exclude from the creation in the cluster.

      Example:

      exclude:
- sc.*
- st1
    • storageClass.provision
      array of objects

      Defines additional StorageClasses or override the parameters of created by default.

      • storageClass.provision.iops
        string

        I/O operations per second for gp3 volume type:

        • Allowed values: from 3000 to 16000.
        • If empty, it will set to 3000 as documented here.
        • Changing doesn’t apply to existing volumes. You can modify them manually through AWS Console.
      • storageClass.provision.iopsPerGB
        string

        The number of I/O operations per second per GB for io1 and io2 volume types (this parameter is 3 for gp2 volumes):

        • Caution! If the iopsPerGB value multiplied by the target volume’s size is less than 100 or more than 64000, the creation of such a volume will fail.
        • You can find a detailed description of the volume types and their IOPS in the official documentation.
      • storageClass.provision.name
        string

        Required value

        The name of the class to create.

      • storageClass.provision.throughput
        string

        Throughput in MiB/s for gp3 volume type:

        • Allowed values: from 125 to 1000.
        • If empty, it will set to 125 as documented here.
        • Changing doesn’t apply to existing volumes. You can modify them manually through AWS Console.
      • storageClass.provision.type
        string

        Required value

        The volume type.

        Allowed values: gp3, gp2, sc1, st1, io1, io2