The information in this documentation is geared towards users that want to use Gloo Gateway proxies with the Kubernetes Gateway API. If you want to use the Gloo Edge API instead, see the Gloo Gateway (Gloo Edge API) documentation.
Amazon EKS add-on
Install Gloo Gateway with the Amazon Elastic Kubernetes Service (EKS) add-on.
The Gloo Gateway add-on for Amazon EKS streamlines the installation, configuration, and updates of Gloo Gateway on your EKS clusters. This add-on installs Gloo Gateway in a mode that fully supports the Kubernetes Gateway API, with all required Custom Resource Definitions (CRDs), including the Kubernetes Gateway API CRDs, packaged and deployed automatically. No additional setup is needed. Amazon ensures compatibility with EKS, delivering a secure and reliable release. Leveraging this add-on can help your organization meet internal compliance requirements and manage account spending effectively. For more details, refer to the AWS documentation.
info
The EKS add-on functions without a license key, just like the OSS version of Gloo Gateway. For enterprise users, you can add a license key after installation, as described later in this guide.
Scroll down to the AWS Marketplace add-ons section. In the search box, enter gateway into the search field to filter the results for the Gloo Gateway add-on.
Figure: Find the Gloo Gateway add-on for EKS
Figure: Find the Gloo Gateway add-on for EKS
Click the checkbox for the add-on, and then click Next.
If the Status field shows Requires subscription, click the View subscribtion options button and follow the AWS Marketplace prompts to subscribe to the add-on.
Figure: Required subscription status
Figure: Required subscription status
When the Status displays Ready to install, select the desired version to install.
Figure: Configure the Gloo Gateway add-on for EKS
Figure: Configure the Gloo Gateway add-on for EKS
To proceed to the next page, click Next.
Review the add-on details, and then click Create.
Figure: Review and create the Gloo Gateway add-on for EKS
Figure: Review and create the Gloo Gateway add-on for EKS
From the cluster details page, click the Add-ons tab and verify that the status is Active. If the installation takes more than a few minutes, review the add-on status. Common issues include a lack of compute resources to run the deployment, such as no nodes.
Figure: Active status for Solo add-on for EKS
Figure: Active status for Solo add-on for EKS
Install the EKS add-on by using the eksctl command line tool. For complete EKS add-on instructions, see the AWS docs (eksctl Tab).
Get the name and region of the cluster that you want to install the add-on in. If you do not have an $AWS_REGION environment variable set, replace the variable with any region in the following command.
eksctl get clusters -A --region $AWS_REGION
Set the name and region of the cluster that you want to install the add-on in. Replace <your-cluster-region> and <name-of-your-EKS-cluster> with the values that you got in the previous step.
# Set your cluster region (for example, us-west-2)
export REGION=<your-cluster-region>
# Set the name of your EKS cluster
export CLUSTER=<name-of-your-EKS-cluster>
Install the add-on, replacing the cluster and region with the values that you got in the previous step. For more options, such as specific version of the add-on, run eksctl create addon --help.
Check that the status of the addon is ACTIVE with null issues. If the installation takes more than a few minutes, review the add-on status. Common issues include a lack of compute resources to run the deployment, such as no nodes.
eksctl get addon --name solo-io_gloo-gateway --cluster $CLUSTER --region $REGION -oyaml
Install the EKS add-on by using the aws command line tool. For complete AWS command line tool add-on instructions, see the AWS docs (AWS CLI tab).
Specify the region of the cluster and confirm the cluster name where you want to install the add-on. Replace <your-cluster-region> with the EKS clusters region.
# Set your cluster region (for example, us-west-2)
export REGION=<your-cluster-region>
aws eks list-clusters --region $REGION
Set the name of the cluster that you want to install the add-on in. Replace <name-of-your-EKS-cluster> with the value that you got in the previous step.
# Set the name of your EKS cluster
export CLUSTER=<name-of-your-EKS-cluster>
Install the add-on. For more options, such as to set a specific version of the add-on, run eksctl create addon --help.
Check that the status of the addon is ACTIVE with empty [] in Issues section. If the installation takes more than a few minutes, review the add-on status. Common issues include a lack of compute resources to run the deployment, such as no nodes.
Install the EKS add-on by using Terraform, such as for a GitOps pipeline.
Get the cluster name, cluster region, and EKS add-on version that you want to install.
Use the following example inside of your Terraform project, or directly by saving the example as main.tf. Replace the region, cluster_name and addon_version with the values that you previously got. (The configuration_values sub-section is provided as an example. Decide on the values that you want to customize or remove the section entirely if the default values are sufficient.)
provider "aws" {
region = local.region
}
terraform {
required_version = ">= 1.0.0"
required_providers {
aws = {
source = "hashicorp/aws"
version = ">= 4.47"
}
}
}
locals {
region = "<your-cluster-region>" # Replace with your cluster region (for example, us-west-2)
cluster_name = "<name-of-your-EKS-cluster>" # Replace with the name of your EKS cluster
addon_version = "v1.18.2-eksbuild.1" # Replace with your desired addon version; for Ambient add extra '0' *(for example, v1.21.20-eksbuild.1)
}
resource "aws_eks_addon" "solo-io_gloo-gateway" {
cluster_name = local.cluster_name
addon_name = "solo-io_gloo-gateway"
resolve_conflicts_on_update = "OVERWRITE"
addon_version = local.addon_version
}
From the directory of the main.tf file, run the Terraform commands to build the EKS add-on infrastructure.
In the search box, enter gateway to filter the results for the Gloo Gateway add-on.
Figure: Find the Solo add-on for EKS
Figure: Find the Solo add-on for EKS
Click the add-on, and then click Remove.
In the pop-up window, type the add-on name and click Remove. You can keep Istio running in your cluster but disable EKS add-on management by toggling Preserve on cluster.