Skip to main content
Version: 1.7.0

TKE (Tencent)

This document explains how you can install APISIX ingress on Tencent TKE.

Prerequisites#

  • Create a TKE cluster on Tencent Cloud and make sure that the API server is accessible from your device.
  • Install Helm.
  • Update your kube config file with the credentials for your TKE cluster.

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 \
  --set etcd.persistence.size="10Gi" \
  --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
IMPORTANT

Make sure to configure the attribute etcd.persistence.size in multiples of 10Gi (limitation of TKE). Otherwise, the PersistentVolumeClaim creation will fail.

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.
  • apisix-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 TKE service management for more details on setting this up.

You can find the load balancer IP address by running:

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

Now, if you open your TKE console, choose your cluster and click the workloads tag, you will see all the APISIX. ingress controller, and etcd 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 gateway.tls.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.