This document outlines the installation steps for Amazon Elastic Kubernetes Service (EKS).
Launch an EKS cluster
Make sure Amazon EKS CLI (
eksctl) is installed before proceeding.
We recommend launching a cluster with 2
m5.xlarge nodes to start, with autoscaling and network policy enabled. You can add additional CPU/GPU node pools as needed later.
Here are sample
eksctl commands to create a bare minimum cluster:
To enable auto scaling see Enable Auto Scaling
To enable network policy see Installing Calico on Amazon EKS
To enable logging see Enabling CloudWatch logging
You can optionally skip the logging configuration above and add
opctl command below.
eksctl command above will automatically retrieve your cluster's access credentials but you can also get them by running:
If you are not the person that created the cluster, you will need to be added to the cluster before you can use
kubectl with these credentials.
- Download the latest
opctlfor your operating system from our release page.
- Run the following command to initialize a
params.yamltemplate for EKS:
--enable-https flag is optional and requires a TLS certificate, but it is highly recommended. You can optionally set the
--dns-provider flags, so TLS certificates are automatically created and renewed via Let's Encrypt. If you do not set this flag and your DNS provider isn't one of the supported DNS providers, then you have to create a wildcard certificate and manually manage it.
If you have GPU nodes, you need to set the
--gpu-device-plugins flag. Valid values are
amd or a comma separated combination of both
params.yamlby following the instructions in the template, you can also refer to configuration files for more detailed information.
- Finally, run the following command to deploy to your cluster:
If the command completes but it indicates that your cluster is not ready, you can check status again by running
opctl app status. If you're still seeing issues, visit our Troubleshooting page.
- Once the deployment completes, the CLI will display the IP and wildcard domain you need to use to setup your DNS. You can also get this information again by running:
- Create a
CNAMErecord in your DNS provider based on the instructions above.
You should use a wildcard
CNAME record, for example:
If you're waiting for your DNS record to propogate, you can set up a hosts file to quickly test the deployment.
- Wait a few minutes and check the URL mentioned in the instructions above. Your applications should load with a screen prompting you to enter a token.
- Use the following command to get your auth token to log into Onepanel: