Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/awslabs/amazon-eks-ami

Packer configuration for building a custom EKS AMI
https://github.com/awslabs/amazon-eks-ami

Last synced: about 20 hours ago
JSON representation

Packer configuration for building a custom EKS AMI

Awesome Lists containing this project

README 

        
# Amazon EKS AMI Build Specification



This repository contains resources and configuration scripts for building a

custom Amazon EKS AMI with [HashiCorp Packer](https://www.packer.io/). This is

the same configuration that Amazon EKS uses to create the official Amazon

EKS-optimized AMI.



**Check out the [📖 documentation](https://awslabs.github.io/amazon-eks-ami/) to learn more.**



---



## 🚀 Getting started



If you are new to Amazon EKS, we recommend that you follow

our [Getting Started](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html)

chapter in the Amazon EKS User Guide. If you already have a cluster, and you

want to launch a node group with your new AMI, see [Launching Amazon EKS Worker

Nodes](https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html).



## 🔢 Pre-requisites



You must have [Packer](https://www.packer.io/) version 1.8.0 or later installed on your local system.

For more information, see [Installing Packer](https://www.packer.io/docs/install/index.html)

in the Packer documentation. You must also have AWS account credentials

configured so that Packer can make calls to AWS API operations on your behalf.

For more information, see [Authentication](https://www.packer.io/docs/builders/amazon.html#specifying-amazon-credentials)

in the Packer documentation.



## 👷 Building the AMI



A Makefile is provided to build the Amazon EKS Worker AMI, but it is just a small wrapper around

invoking Packer directly. You can initiate the build process by running the

following command in the root of this repository:



```bash

# build an AMI with the latest Kubernetes version and the default OS distro

make



# build an AMI with a specific Kubernetes version and the default OS distro

make k8s=1.29



# build an AMI with a specific Kubernetes version and a specific OS distro

make k8s=1.29 os_distro=al2023



# check default value and options in help doc

make help

```



The Makefile chooses a particular kubelet binary to use per Kubernetes version which you can [view here](https://github.com/awslabs/amazon-eks-ami/blob/main/Makefile).



> **Note**

> The default instance type to build this AMI does not qualify for the AWS free tier.

> You are charged for any instances created when building this AMI.



## 🔒 Security



For security issues or concerns, please do not open an issue or pull request on GitHub. Please report any suspected or confirmed security issues to [AWS Security](https://aws.amazon.com/security/vulnerability-reporting/).



## ⚖️ License Summary



This sample code is made available under a MIT-0 license. See the LICENSE file.



Although this repository is released under the MIT license, when using NVIDIA accelerated AMIs you agree to the NVIDIA Cloud End User License Agreement: https://s3.amazonaws.com/EULA/NVidiaEULAforAWS.pdf.



Although this repository is released under the MIT license, NVIDIA accelerated AMIs

use the third party [open-gpu-kernel-modules](https://github.com/NVIDIA/open-gpu-kernel-modules). The open-gpu-kernel-modules project's licensing includes the dual MIT/GPLv2 license.



Although this repository is released under the MIT license, NVIDIA accelerated AMIs

use the third party [nvidia-container-toolkit](https://github.com/NVIDIA/nvidia-container-toolkit). The nvidia-container-toolkit project's licensing includes the Apache-2.0 license.



Although this repository is released under the MIT license, Neuron accelerated AMIs

use the third party [Neuron Driver](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/runtime/aws-neuronx-dkms/index.html). The Neuron Driver project's licensing includes the GPLv2 license.



Although this repository is released under the MIT license, accelerated AMIs

use the third party [Elastic Fabric Adapter Driver](https://github.com/amzn/amzn-drivers/tree/master/kernel/linux/efa). The Elastic Fabric Adapter Driver project's licensing includes the GPLv2 license.