Skip to content

Latest commit

 

History

History
150 lines (109 loc) · 5.98 KB

aws.md

File metadata and controls

150 lines (109 loc) · 5.98 KB
Raw
title keywords description
EKS (Amazon)
APISIX ingress
Apache APISIX
Kubernetes ingress
Amazon EKS
Guide to install APISIX ingress controller on Amazon Elastic Kubernetes Service (EKS).

This guide explains how you can install APISIX ingress on Amazon EKS.

Prerequisites

Before installing APISIX, you need to:

  • Create an EKS cluster on AWS.
  • Enable kubectl to communicate with your cluster by adding the credentials to your kube config file.
  • Install Helm.

Install APISIX and ingress controller

The script below installs APISIX and the ingress controller:

helm repo add apisix https://charts.apiseven.com
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update
#  We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
  --set gateway.type=LoadBalancer \
  --set ingress-controller.enabled=true \
  --create-namespace \
  --namespace ingress-apisix \
  --set ingress-controller.config.apisix.serviceNamespace=ingress-apisix \
  --set ingress-controller.config.apisix.adminAPIVersion=$ADMIN_API_VERSION
kubectl get service --namespace ingress-apisix

:::tip

By default AWS provisions a Classic LoadBalancer. If you want to use a Network LoadBalancer you can set the annotation, service.beta.kubernetes.io/aws-load-balancer-type: nlb. The install command would now be:

#  We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
  --set gateway.type=LoadBalancer \
  --set ingress-controller.enabled=true \
  --create-namespace \
  --namespace ingress-apisix \
  --set ingress-controller.config.apisix.serviceNamespace=ingress-apisix \
  --set ingress-controller.config.apisix.adminAPIVersion=$ADMIN_API_VERSION \
  --set apisix.ssl.enabled=true \
  --set gateway.annotations."service\.beta\.kubernetes\.io/aws-load-balancer-type"=nlb

:::

:::note

By default, APISIX ingress controller will watch the apiVersion of networking.k8s.io/v1.

If the target Kubernetes version is under v1.19, add the flag --set ingress-controller.config.kubernetes.ingressVersion=networking/v1beta1.

Else, if your Kubernetes cluster version is under v1.16, set the flag --set ingress-controller.config.kubernetes.ingressVersion=extensions/v1beta1.

:::

:::tip

APISIX Ingress also supports (beta) the new Kubernetes Gateway API.

If the Gateway API CRDs are not installed in your cluster by default, you can install it by running:

kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.5.0/standard-install.yaml

You should also enable APISIX Ingress controller to work with the Gateway API. You can do this by adding the flag --set ingress-controller.config.kubernetes.enableGatewayAPI=true while installing through Helm.

See this tutorial for more info.

:::

This will create the five resources mentioned below:

  • apisix-gateway: dataplane the process the traffic.
  • apisix-admin: control plane that processes all configuration changes.
  • api7-ingress-controller: ingress controller which exposes APISIX.
  • apisix-etcd and apisix-etcd-headless: stores configuration and handles internal communication.

The gateway service type will be set to LoadBalancer. See Network Load Balancers for more details on using it in AWS.

You can find the load balancer IP address by running:

kubectl get service apisix-gateway --namespace ingress-apisix -o jsonpath='{.status.loadBalancer.ingress[].hostname}'

Now, if you open your EKS console, select your cluster, and click the workloads tag, you will be able to see all APISIX, etcd, and ingress controller pods.

You should now be able to use APISIX ingress controller. You can try running this minimal example to see if everything is working perfectly.

Next steps

Enable SSL

SSL is disabled by default. You can enable it by adding the flag --set apisix.ssl.enabled=true.

Change default keys

It is recommended to change the default keys for security:

--set ingress-controller.config.apisix.adminKey=ADMIN_KEY_GENERATED_BY_YOURSELF
--set admin.credentials.admin=ADMIN_KEY_GENERATED_BY_YOURSELF
--set admin.credentials.viewer=VIEWER_KEY_GENERATED_BY_YOURSELF

:::note

The ingress-controller.config.apisix.adminKey and admin.credentials.admin must be the same. It is better if these are not same as admin.credentials.viewer.

:::