Creating an EKS Cluster

Amazon EKS provides a managed control plane for your Kubernetes cluster. Amazon EKS runs the Kubernetes control plane instances across multiple Availability Zones to ensure high availability. Rancher provides an intuitive user interface for managing and deploying the Kubernetes clusters you run in Amazon EKS. With this guide, you will use Rancher to quickly and easily launch an Amazon EKS Kubernetes cluster in your AWS account. For more information on Amazon EKS, see this documentation.

Prerequisites in Amazon Web Services

Creating an EKS Cluster - 图1caution

Deploying to Amazon AWS will incur charges. For more information, refer to the EKS pricing page.

To set up a cluster on EKS, you will need to set up an Amazon VPC (Virtual Private Cloud). You will also need to make sure that the account you will be using to create the EKS cluster has the appropriate permissions. For details, refer to the official guide on Amazon EKS Prerequisites.

Amazon VPC

An Amazon VPC is required to launch the EKS cluster. The VPC enables you to launch AWS resources into a virtual network that you’ve defined. You can set one up yourself and provide it during cluster creation in Rancher. If you do not provide one during creation, Rancher will create one. For more information, refer to the Tutorial: Creating a VPC with Public and Private Subnets for Your Amazon EKS Cluster.

IAM Policies

Rancher needs access to your AWS account in order to provision and administer your Kubernetes clusters in Amazon EKS. You’ll need to create a user for Rancher in your AWS account and define what that user can access.

  1. Create a user with programmatic access by following the steps here.

  2. Next, create an IAM policy that defines what this user has access to in your AWS account. It’s important to only grant this user minimal access within your account. The minimum permissions required for an EKS cluster are listed here. Follow the steps here to create an IAM policy and attach it to your user.

  3. Finally, follow the steps here to create an access key and secret key for this user.

Creating an EKS Cluster - 图2Important:

It’s important to regularly rotate your access and secret keys. See this documentation for more information.

For more detailed information on IAM policies for EKS, refer to the official documentation on Amazon EKS IAM Policies, Roles, and Permissions.

Create the EKS Cluster

Use Rancher to set up and configure your Kubernetes cluster.

  1. Click ☰ > Cluster Management.
  2. On the Clusters page, click Create.
  3. Choose Amazon EKS.
  4. Enter a Cluster Name.
  5. Use Member Roles to configure user authorization for the cluster. Click Add Member to add users that can access the cluster. Use the Role drop-down to set permissions for each user.
  6. Fill out the rest of the form. For help, refer to the configuration reference.
  7. Click Create.

Result:

Your cluster is created and assigned a state of Provisioning. Rancher is standing up your cluster.

You can access your cluster after its state is updated to Active.

Active clusters are assigned two Projects:

  • Default, containing the default namespace
  • System, containing the cattle-system, ingress-nginx, kube-public, and kube-system namespaces

EKS Cluster Configuration Reference

For the full list of EKS cluster configuration options, see this page.

Architecture

The figure below illustrates the high-level architecture of Rancher 2.x. The figure depicts a Rancher Server installation that manages two Kubernetes clusters: one created by RKE and another created by EKS.

Managing Kubernetes Clusters through Rancher’s Authentication Proxy

Architecture

AWS Service Events

To find information on any AWS Service events, please see this page.

Security and Compliance

By default only the IAM user or role that created a cluster has access to it. Attempting to access the cluster with any other user or role without additional configuration will lead to an error. In Rancher, this means using a credential that maps to a user or role that was not used to create the cluster will cause an unauthorized error. For example, an EKSCtl cluster will not register in Rancher unless the credentials used to register the cluster match the role or user used by EKSCtl. Additional users and roles can be authorized to access a cluster by being added to the aws-auth configmap in the kube-system namespace. For a more in-depth explanation and detailed instructions, please see this documentation.

For more information on security and compliance with your Amazon EKS Kubernetes cluster, please see this documentation.

Tutorial

This tutorial on the AWS Open Source Blog will walk you through how to set up an EKS cluster with Rancher, deploy a publicly accessible app to test the cluster, and deploy a sample project to track real-time geospatial data using a combination of other open-source software such as Grafana and InfluxDB.

Minimum EKS Permissions

These are the minimum set of permissions necessary to access the full functionality of Rancher’s EKS driver. You’ll need additional permissions for Rancher to provision the Service Role and VPC resources. If you create these resources before you create the cluster, they’ll be available when you configure the cluster.

Creating an EKS Cluster - 图4note

In EKS v1.23 and above, you must use the out-of-tree drivers for EBS-backed volumes. You need specific permissions to enable this add-on.

ResourceDescription
Service RoleProvides permissions that allow Kubernetes to manage resources on your behalf. Rancher can create the service role with the following Service Role Permissions.
VPCProvides isolated network resources utilised by EKS and worker nodes. Rancher can create the VPC resources with the following VPC Permissions.
EBS CSI Driver add-onProvides permissions that allow Kubernetes to interact with EBS and configure the cluster to enable the add-on (required for EKS v1.23 and above). Rancher can install the add-on with the following EBS CSI Driver addon Permissions.

Resource targeting uses * as the ARN of many of the resources created cannot be known before creating the EKS cluster in Rancher.

  1. {
  2.     "Version": "2012-10-17",
  3.     "Statement": [
  4.         {
  5.             "Sid": "EC2Permissions",
  6.             "Effect": "Allow",
  7.             "Action": [
  8.                 "ec2:RunInstances",
  9.                 "ec2:RevokeSecurityGroupIngress",
  10.                 "ec2:RevokeSecurityGroupEgress",
  11.                 "ec2:DescribeInstanceTypes",
  12.                 "ec2:DescribeRegions",
  13.                 "ec2:DescribeVpcs",
  14.                 "ec2:DescribeTags",
  15.                 "ec2:DescribeSubnets",
  16.                 "ec2:DescribeSecurityGroups",
  17.                 "ec2:DescribeRouteTables",
  18.                 "ec2:DescribeLaunchTemplateVersions",
  19.                 "ec2:DescribeLaunchTemplates",
  20.                 "ec2:DescribeKeyPairs",
  21.                 "ec2:DescribeInternetGateways",
  22.                 "ec2:DescribeImages",
  23.                 "ec2:DescribeAvailabilityZones",
  24.                 "ec2:DescribeAccountAttributes",
  25.                 "ec2:DeleteTags",
  26.                 "ec2:DeleteLaunchTemplateVersions",
  27.                 "ec2:DeleteLaunchTemplate",
  28.                 "ec2:DeleteSecurityGroup",
  29.                 "ec2:DeleteKeyPair",
  30.                 "ec2:CreateTags",
  31.                 "ec2:CreateSecurityGroup",
  32.                 "ec2:CreateLaunchTemplateVersion",
  33.                 "ec2:CreateLaunchTemplate",
  34.                 "ec2:CreateKeyPair",
  35.                 "ec2:AuthorizeSecurityGroupIngress",
  36.                 "ec2:AuthorizeSecurityGroupEgress"
  37.             ],
  38.             "Resource": "*"
  39.         },
  40.         {
  41.             "Sid": "CloudFormationPermissions",
  42.             "Effect": "Allow",
  43.             "Action": [
  44.                 "cloudformation:ListStacks",
  45.                 "cloudformation:ListStackResources",
  46.                 "cloudformation:DescribeStacks",
  47.                 "cloudformation:DescribeStackResources",
  48.                 "cloudformation:DescribeStackResource",
  49.                 "cloudformation:DeleteStack",
  50.                 "cloudformation:CreateStackSet",
  51.                 "cloudformation:CreateStack"
  52.             ],
  53.             "Resource": "*"
  54.         },
  55.         {
  56.             "Sid": "IAMPermissions",
  57.             "Effect": "Allow",
  58.             "Action": [
  59.                 "iam:PassRole",
  60.                 "iam:ListRoles",
  61.                 "iam:ListRoleTags",
  62.                 "iam:ListInstanceProfilesForRole",
  63.                 "iam:ListInstanceProfiles",
  64.                 "iam:ListAttachedRolePolicies",
  65.                 "iam:GetRole",
  66.                 "iam:GetInstanceProfile",
  67.                 "iam:DetachRolePolicy",
  68.                 "iam:DeleteRole",
  69.                 "iam:CreateRole",
  70.                 "iam:AttachRolePolicy"
  71.             ],
  72.             "Resource": "*"
  73.         },
  74.         {
  75.             "Sid": "KMSPermissions",
  76.             "Effect": "Allow",
  77.             "Action": "kms:ListKeys",
  78.             "Resource": "*"
  79.         },
  80.         {
  81.             "Sid": "EKSPermissions",
  82.             "Effect": "Allow",
  83.             "Action": [
  84.                 "eks:UpdateNodegroupVersion",
  85.                 "eks:UpdateNodegroupConfig",
  86.                 "eks:UpdateClusterVersion",
  87.                 "eks:UpdateClusterConfig",
  88.                 "eks:UntagResource",
  89.                 "eks:TagResource",
  90.                 "eks:ListUpdates",
  91.                 "eks:ListTagsForResource",
  92.                 "eks:ListNodegroups",
  93.                 "eks:ListFargateProfiles",
  94.                 "eks:ListClusters",
  95.                 "eks:DescribeUpdate",
  96.                 "eks:DescribeNodegroup",
  97.                 "eks:DescribeFargateProfile",
  98.                 "eks:DescribeCluster",
  99.                 "eks:DeleteNodegroup",
  100.                 "eks:DeleteFargateProfile",
  101.                 "eks:DeleteCluster",
  102.                 "eks:CreateNodegroup",
  103.                 "eks:CreateFargateProfile",
  104.                 "eks:CreateCluster"
  105.             ],
  106.             "Resource": "*"
  107.         }
  108.     ]
  109. }

Service Role Permissions

These are permissions that are needed during EKS cluster creation, so Rancher can create a service role on the users’ behalf.

  1. {
  2.   "Version": "2012-10-17",
  3.   "Statement": [
  4.     {
  5.       "Sid": "IAMPermissions",
  6.       "Effect": "Allow",
  7.       "Action": [
  8.         "iam:AddRoleToInstanceProfile",
  9.         "iam:AttachRolePolicy",
  10.         "iam:CreateInstanceProfile",
  11.         "iam:CreateRole",
  12.         "iam:CreateServiceLinkedRole",
  13.         "iam:DeleteInstanceProfile",
  14.         "iam:DeleteRole",
  15.         "iam:DetachRolePolicy",
  16.         "iam:GetInstanceProfile",
  17.         "iam:GetRole",
  18.         "iam:ListAttachedRolePolicies",
  19.         "iam:ListInstanceProfiles",
  20.         "iam:ListInstanceProfilesForRole",
  21.         "iam:ListRoles",
  22.         "iam:ListRoleTags",
  23.         "iam:PassRole",
  24.         "iam:RemoveRoleFromInstanceProfile"
  25.       ],
  26.       "Resource": "*"
  27.     }
  28.   ]
  29. }

When you create an EKS cluster, Rancher creates a service role with the following trust policy:

  1. {
  2.   "Version": "2012-10-17",
  3.   "Statement": [
  4.     {
  5.       "Action": "sts:AssumeRole",
  6.       "Principal": {
  7.         "Service": "eks.amazonaws.com"
  8.       },
  9.       "Effect": "Allow",
  10.       "Sid": ""
  11.     }
  12.   ]
  13. }

This role also has two role policy attachments with the following policies’ ARNs:

  1. arn:aws:iam::aws:policy/AmazonEKSClusterPolicy
  2. arn:aws:iam::aws:policy/AmazonEKSServicePolicy

VPC Permissions

These are permissions that are needed by Rancher to create a Virtual Private Cloud (VPC) and associated resources.

  1. {
  2.   "Version": "2012-10-17",
  3.   "Statement": [
  4.     {
  5.       "Sid": "VPCPermissions",
  6.       "Effect": "Allow",
  7.       "Action": [
  8.         "ec2:ReplaceRoute",
  9.         "ec2:ModifyVpcAttribute",
  10.         "ec2:ModifySubnetAttribute",
  11.         "ec2:DisassociateRouteTable",
  12.         "ec2:DetachInternetGateway",
  13.         "ec2:DescribeVpcs",
  14.         "ec2:DeleteVpc",
  15.         "ec2:DeleteTags",
  16.         "ec2:DeleteSubnet",
  17.         "ec2:DeleteRouteTable",
  18.         "ec2:DeleteRoute",
  19.         "ec2:DeleteInternetGateway",
  20.         "ec2:CreateVpc",
  21.         "ec2:CreateSubnet",
  22.         "ec2:CreateSecurityGroup",
  23.         "ec2:CreateRouteTable",
  24.         "ec2:CreateRoute",
  25.         "ec2:CreateInternetGateway",
  26.         "ec2:AttachInternetGateway",
  27.         "ec2:AssociateRouteTable"
  28.       ],
  29.       "Resource": "*"
  30.     }
  31.   ]
  32. }

EBS CSI Driver addon Permissions

The following are the required permissions for installing the Amazon EBS CSI Driver add-on.

  1. {
  2.     "Version": "2012-10-17",
  3.     "Statement": [
  4.         {
  5.             "Effect": "Allow",
  6.             "Action": [
  7.                 "iam:GetRole",
  8.                 "eks:DescribeAddonConfiguration",
  9.                 "eks:UpdateAddon",
  10.                 "eks:ListAddons",
  11.                 "iam:CreateRole",
  12.                 "iam:AttachRolePolicy",
  13.                 "eks:DescribeAddon",
  14.                 "iam:CreateOpenIDConnectProvider",
  15.                 "iam:PassRole",
  16.                 "eks:DescribeIdentityProviderConfig",
  17.                 "eks:DeleteAddon",
  18.                 "iam:ListOpenIDConnectProviders",
  19.                 "iam:ListAttachedRolePolicies",
  20.                 "eks:CreateAddon",
  21.                 "eks:DescribeCluster",
  22.                 "eks:DescribeAddonVersions",
  23.                 "sts:AssumeRoleWithWebIdentity",
  24.                 "eks:AssociateIdentityProviderConfig",
  25.                 "eks:ListIdentityProviderConfigs"
  26.             ],
  27.             "Resource": "*"
  28.         }
  29.     ]
  30. }

Syncing

The EKS provisioner can synchronize the state of an EKS cluster between Rancher and the provider. For an in-depth technical explanation of how this works, see Syncing.

For information on configuring the refresh interval, refer to this section.

Troubleshooting

If your changes were overwritten, it could be due to the way the cluster data is synced with EKS. Changes shouldn’t be made to the cluster from another source, such as in the EKS console, and in Rancher within a five-minute span. For information on how this works and how to configure the refresh interval, refer to Syncing.

If an unauthorized error is returned while attempting to modify or register the cluster and the cluster was not created with the role or user that your credentials belong to, refer to Security and Compliance.

For any issues or troubleshooting details for your Amazon EKS Kubernetes cluster, please see this documentation.

Programmatically Creating EKS Clusters

The most common way to programmatically deploy EKS clusters through Rancher is by using the Rancher2 Terraform provider. The documentation for creating clusters with Terraform is here.