Help improve this page
Want to contribute to this user guide? Scroll to the bottom of this page and select Edit this page on GitHub. Your contributions will help make our user guide better for everyone.
Create self-managed Bottlerocket nodes
Note
Managed node groups might offer some advantages for your use case. For more information, see Simplify node lifecycle with managed node groups.
This topic describes how to launch Auto Scaling groups of Bottlerocketeksctl
documentation.
For information about in-place upgrades, see Bottlerocket
Update Operator
Important
Amazon EKS nodes are standard Amazon EC2 instances, and you are billed for them based on normal Amazon EC2 instance prices. For more information, see Amazon EC2 pricing
. -
You can launch Bottlerocket nodes in Amazon EKS extended clusters on AWS Outposts, but you can't launch them in local clusters on AWS Outposts. For more information, see Deploy Amazon EKS on-premises with AWS Outposts.
-
You can deploy to Amazon EC2 instances with
x86
or Arm processors. However, you can't deploy to instances that have Inferentia chips. -
Bottlerocket is compatible with AWS CloudFormation. However, there is no official CloudFormation template that can be copied to deploy Bottlerocket nodes for Amazon EKS.
-
Bottlerocket images don't come with an SSH server or a shell. You can use out-of-band access methods to allow SSH enabling the admin container and to pass some bootstrapping configuration steps with user data. For more information, see these sections in the bottlerocket README.md
on GitHub:
To launch Bottlerocket nodes using eksctl
This procedure requires eksctl
version
0.189.0
or later. You can check your version with the following
command:
eksctl version
For instructions on how to install or upgrade eksctl
, see
Installationeksctl
documentation.
Note
This procedure only works for clusters that were created with
eksctl
.
-
Copy the following contents to your device. Replace
with the name of your cluster. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the AWS Region and AWS account that you're creating the cluster in. Replacemy-cluster
with a name for your node group. The node group name can't be longer than 63 characters. It must start with letter or digit, but can also include hyphens and underscores for the remaining characters. To deploy on Arm instances, replaceng-bottlerocket
with an Arm instance type. Replacem5.large
with the name of an Amazon EC2 SSH key pair that you can use to connect using SSH into your nodes with after they launch. If you don't already have an Amazon EC2 key pair, you can create one in the AWS Management Console. For more information, see Amazon EC2 key pairs in the Amazon EC2 User Guide. Replace all remainingmy-ec2-keypair-name
with your own values. Once you've made the replacements, run the modified command to create theexample values
bottlerocket.yaml
file.If specifying an Arm Amazon EC2 instance type, then review the considerations in Amazon EKS optimized Arm Amazon Linux AMIs before deploying. For instructions on how to deploy using a custom AMI, see Building Bottlerocket
on GitHub and Custom AMI support in the eksctl
documentation. To deploy a managed node group, deploy a custom AMI using a launch template. For more information, see Customize managed nodes with launch templates.Important
To deploy a node group to AWS Outposts, AWS Wavelength, or AWS Local Zone subnets, don't pass AWS Outposts, AWS Wavelength, or AWS Local Zone subnets when you create the cluster. You must specify the subnets in the following example. For more information see Create a nodegroup from a config file
and Config file schema in the eksctl
documentation. Replace
with the AWS Region that your cluster is in.region-code
cat >bottlerocket.yaml <<EOF --- apiVersion: eksctl.io/v1alpha5 kind: ClusterConfig metadata: name:
my-cluster
region:region-code
version:'1.30'
iam: withOIDC: true nodeGroups: - name:ng-bottlerocket
instanceType:m5.large
desiredCapacity:3
amiFamily:Bottlerocket
ami: auto-ssm iam: attachPolicyARNs: - arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy - arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly - arn:aws:iam::aws:policy/AmazonSSMManagedInstanceCore - arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy ssh: allow: true publicKeyName:my-ec2-keypair-name
EOF -
Deploy your nodes with the following command.
eksctl create nodegroup --config-file=bottlerocket.yaml
An example output is as follows.
Several lines are output while the nodes are created. One of the last lines of output is the following example line.
[✔] created 1 nodegroup(s) in cluster "
my-cluster
" -
(Optional) Create a Kubernetes persistent volume
on a Bottlerocket node using the Amazon EBS CSI Plugin . The default Amazon EBS driver relies on file system tools that aren't included with Bottlerocket. For more information about creating a storage class using the driver, see Store Kubernetes volumes with Amazon EBS. -
(Optional) By default,
kube-proxy
sets thenf_conntrack_max
kernel parameter to a default value that may differ from what Bottlerocket originally sets at boot. To keep Bottlerocket's default setting, edit the kube-proxy
configuration with the following command.kubectl edit -n kube-system daemonset kube-proxy
Add
--conntrack-max-per-core
and--conntrack-min
to thekube-proxy
arguments that are in the following example. A setting of0
implies no change.containers: - command: - kube-proxy - --v=2 - --config=/var/lib/kube-proxy-config/config
- --conntrack-max-per-core=0 - --conntrack-min=0
-
(Optional) Deploy a sample application to test your Bottlerocket nodes.
We recommend blocking Pod access to IMDS if the following conditions are true:
You plan to assign IAM roles to all of your Kubernetes service accounts so that Pods only have the minimum permissions that they need.
No Pods in the cluster require access to the Amazon EC2 instance metadata service (IMDS) for other reasons, such as retrieving the current AWS Region.
For more information, see Restrict access to the instance profile assigned to the worker node
.