Skip to content

Commit

Permalink
fix: Tutorial to deploy ubuntu EKS Cluster
Browse files Browse the repository at this point in the history
Create tutorial about how to deploy ubuntu EKS
cluster and modify index to include tutorial
with similar topic.
  • Loading branch information
JessicaJang committed Nov 12, 2024
1 parent cf3faa5 commit 9baa8df
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 11 deletions.
7 changes: 4 additions & 3 deletions aws/aws-how-to/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ While using Ubuntu on AWS, you'll need to perform tasks such as launching an ins
EKS - Using Ubuntu Pro and GPUs on EKS
--------------------------------------

If you want to use Ubuntu Pro and enable GPUs on Amazon's EKS service, you can refer to these instructions.
If you want to use Ubuntu and enable GPUs on Amazon's EKS service, you can refer to these instructions.

* :doc:`Deploy a Pro cluster using AMI <kubernetes/deploy-ubuntu-pro-cluster-with-eks-pro-ami>`
* :doc:`Deploy a Pro FIPS cluster using AMI <kubernetes/deploy-ubuntu-pro-fips-cluster>`
* :doc:`Deploy an Ubuntu EKS cluster <kubernetes/deploy-ubuntu-cluster-with-eks-ami>`
* :doc:`Deploy an Ubuntu Pro cluster <kubernetes/deploy-ubuntu-pro-cluster-with-eks-pro-ami>`
* :doc:`Deploy an Ubuntu Pro FIPS cluster <kubernetes/deploy-ubuntu-pro-fips-cluster>`
* :doc:`Deploy a Pro cluster (with / without FIPS) using tokens <kubernetes/deploy-ubuntu-pro-cluster>`
* :doc:`Enable GPUs on EKS worker nodes <kubernetes/enable-gpus-on-eks>`

Expand Down
65 changes: 65 additions & 0 deletions aws/aws-how-to/kubernetes/deploy-ubuntu-cluster-with-eks-ami.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
Deploy an Ubuntu EKS cluster
============================

This guide shows how to deploy an Ubuntu EKS cluster using an EKS AMI.

Prerequisites
-------------

You need:

- ``eksctl`` (version 0.190 or newer): Check the instructions to `install eksctl`_
- ``kubectl``: Check the instructions to `install kubectl`_


Create the ``eksctl`` config file
---------------------------------

Create a ``config.yaml`` with the following content:

.. code-block:: yaml
apiVersion: eksctl.io/v1alpha5
kind: ClusterConfig
metadata:
name: your-cluster
region: us-east-1
nodeGroups:
- name: ng-cluster
instanceType: m5.large
amiFamily: Ubuntu2204
ami: ami-ubuntu
overrideBootstrapCommand: |
#!/bin/bash
/etc/eks/bootstrap.sh your-cluster
To use an Ubuntu specific AMI, set ``amiFamily`` to ``Ubuntu2004`` (for EKS version <= 1.29) or to ``Ubuntu2204`` (for EKS version >= 1.29). For Ubuntu nodes, the ``overrideBootstrapCommand`` is required for both managed and self-managed groups.

For further cluster customisation, check out the `config file schema for eksctl`_


Deploy the EKS cluster
----------------------

To deploy the EKS cluster, run:

.. code::
eksctl create cluster -f config.yaml
You might need to specify the ``--profile`` option if you have multiple profiles.

You can confirm the status of the nodes on your cluster using:

.. code-block:: bash
$ kubectl get nodes
NAME STATUS ROLES AGE VERSION
ip-xxx-xxx-xx-xxx.us-east-1.compute.internal Ready <none> 2m45s v1.30.x
ip-xxx-xxx-x-xx.us-east-1.compute.internal Ready <none> 2m45s v1.30.x
.. _`install eksctl`: https://eksctl.io/installation/
.. _`install kubectl`: https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html
.. _`config file schema for eksctl`: https://eksctl.io/usage/schema
18 changes: 10 additions & 8 deletions aws/aws-how-to/kubernetes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@ Using EKS
=========


**How-to guides for using Ubuntu Pro on EKS** - If you want Ubuntu Pro on your EKS worker nodes, you have two options:
**How-to guides for using Ubuntu on EKS** - If you want to use Ubuntu on your EKS worker nodes, choose from one of the following deployment options:

* Use Pro AMI - The Ubuntu Pro 22.04 LTS AMI is available through :doc:`AWS CLI<../../aws-how-to/instances/find-ubuntu-images>` or from the `AWS marketplace`_. Use that and follow the instructions from:
* :doc:`Deploy a Pro cluster using AMI <deploy-ubuntu-pro-cluster-with-eks-pro-ami>` or
* :doc:`Deploy a Pro FIPS cluster using AMI <deploy-ubuntu-pro-fips-cluster>`
* Use an Ubuntu AMI - Ubuntu EKS AMIs are available through :doc:`AWS CLI<../../aws-how-to/instances/find-ubuntu-images>` or from the `AWS marketplace`_. They can be used to:
* :doc:`Deploy an Ubuntu EKS cluster <deploy-ubuntu-cluster-with-eks-ami>`
* :doc:`Deploy an Ubuntu Pro cluster <deploy-ubuntu-pro-cluster-with-eks-pro-ami>`
* :doc:`Deploy an Ubuntu Pro FIPS cluster <deploy-ubuntu-pro-fips-cluster>`

* Use Pro token - For Ubuntu Pro 20.04 LTS, use your Pro token obtained from Canonical, and follow the instructions given in:
* Use a Pro token - If you want to create an EKS cluster using your Pro token obtained from Canonical, follow the instructions given in:
* :doc:`Deploy a Pro cluster (with / without FIPS) using tokens <deploy-ubuntu-pro-cluster>`

**Other EKS related how-to guides**
Expand All @@ -21,7 +22,8 @@ Using EKS
:hidden:
:maxdepth: 1

Deploy Pro cluster using AMI <deploy-ubuntu-pro-cluster-with-eks-pro-ami>
Deploy Pro FIPS cluster using AMI <deploy-ubuntu-pro-fips-cluster>
Deploy Pro cluster using tokens <deploy-ubuntu-pro-cluster>
Deploy an Ubuntu cluster <deploy-ubuntu-cluster-with-eks-ami>
Deploy an Ubuntu Pro cluster <deploy-ubuntu-pro-cluster-with-eks-pro-ami>
Deploy an Ubuntu Pro FIPS cluster <deploy-ubuntu-pro-fips-cluster>
Deploy an Ubuntu Pro cluster using tokens <deploy-ubuntu-pro-cluster>
Enable GPUs on EKS <enable-gpus-on-eks>

0 comments on commit 9baa8df

Please sign in to comment.