Skip to content

Cluster

eksctl config file schema

eksctl create cluster -f cluster.yaml
cluster.yaml
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
apiVersion: eksctl.io/v1alpha5
kind: ClusterConfig

metadata:
  name: <cluster name>
  region: <region code>
  version: "1.25" # default is "1.25"
  # tags:
  #   <key1>: <value1>
  #   <key2>: <value2>

kubernetesNetworkConfig:
  ipFamily: IPv4  # IPv6

iam:
  serviceRoleARN: <eks cluster role arn>
  withOIDC: true
  serviceAccounts:
    - metadata: # aws load balancer controller
        name: aws-load-balancer-controller
        namespace: kube-system
      wellKnownPolicies:
        awsLoadBalancerController: true
      roleName: <eks elb controller role name>
      tags:
        Name: <eks elb controller role name>

    - metadata: # cluster autoscaler
        name: cluster-autoscaler
        namespace: kube-system
      wellKnownPolicies:
        autoScaler: true
      roleName: <cluster autoscaler role name>
      tags:
        Name: <cluster autoscaler role name>

    - metadata: # external dns
        name: external-dns
        namespace: kube-system
      wellKnownPolicies:
        externalDNS: true
      roleName: <external dns role name>
      tags:
        Name: <external dns role name>

    - metadata: # ebs csi controller
        name: ebs-csi-controller-sa
        namespace: kube-system
      wellKnownPolicies:
        ebsCSIController: true
      roleName: <ebs csi controller role name>
      tags:
        Name: <ebs csi controller role name>

    - metadata: # efs csi controller
        name: efs-csi-controller-sa
        namespace: kube-system
      wellKnownPolicies:
        efsCSIController: true
      roleName: <efs csi controller role name>
      tags:
        Name: <efs csi controller role name>

iamIdentityMappings:
  - arn: <custom iam resources arn>
    groups:
      - system:masters
    username: <identity mapping user name>

vpc:
  id: "<vpc id>"  # ex. vpc-0dd338ecf29863c55
  securityGroup: "<security group id>"  # ex. sg-074e7b913be56b86d
  subnets:
    private:
      <az code>:  # ex. eu-north-1a
        id: "<subnet id>" # ex. subnet-0b2512f8c6ae9bf30
      <az code>:  # ex. eu-north-1b
        id: "<subnet id>" # ex. subnet-08cb9a2ed60394ce3
      <az code>:  # ex. eu-north-1c
        id: "<subnet id>" # ex. subnet-00f71956cdec8f1dc
  sharedNodeSecurityGroup: "<general nodegroup security group>" # ex. sg-013f261f9fb5855f7
  manageSharedNodeSecurityGroupRules: false
  # clusterEndpoints:
  #   publicAccess: true
  #   privateAccess: true
  # publicAccessCIDRs:
  #   - 0.0.0.0/0 # or my ip

addons:
  - name: vpc-cni
  - name: coredns
  - name: kube-proxy

privateCluster:
  enabled: true
  skipEndpointCreation: true

managedNodeGroups:
  - name: <node group name> # ex. ng-1
    amiFamily: AmazonLinux2 # Bottlerocket
    instanceType: m5.large  # (1)
    subnets:
      - "<subnet id>"
      - "<subnet id>"
      - "<subnet id>"
    desiredCapacity: 3
    minSize: 3
    maxSize: 6
    # labels:
    #   key1: value1
    privateNetworking: true
    # tags:
    #   key1: value1
    # taints:
    #   - key:
    #     value:
    #     effect:
    launchTemplate:
      id: <launch template id>
    iam:
      instanceRoleARN: "<node group role arn>"

cloudWatch:
    clusterLogging:
        enableTypes: ["api", "audit", "authenticator", "controllerManager", "scheduler"]

secretsEncryption:
  keyARN: "<kms key arn>" # ex. arn:aws:kms:us-east-1:123456789012:key/12345678-abcd-efgh-ijkl-123456789012
  1. If you use launch template, you should define instance type in launch template and do not use this object.

eksctl Config file schema