| --- |
| title: kind |
| keywords: |
| - APISIX ingress |
| - Apache APISIX |
| - Kubernetes ingress |
| - kind |
| description: Guide to install APISIX ingress controller on kind. |
| --- |
| <!-- |
| # |
| # Licensed to the Apache Software Foundation (ASF) under one or more |
| # contributor license agreements. See the NOTICE file distributed with |
| # this work for additional information regarding copyright ownership. |
| # The ASF licenses this file to You under the Apache License, Version 2.0 |
| # (the "License"); you may not use this file except in compliance with |
| # the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| # |
| --> |
| |
| This document explains how you can install APISIX ingress locally on [kind](https://kind.sigs.k8s.io/). |
| |
| ## Prerequisites |
| |
| * Install [kind](https://kind.sigs.k8s.io/docs/user/quick-start/). |
| * Install [Helm](https://helm.sh/). |
| * Install [kubectl](https://kubernetes.io/docs/tasks/tools/). |
| |
| :::tip |
| |
| If you encounter issues, check the version you are using. This document uses kind v0.12.0, Helm v3.8.1, and kubectl v1.23.5. |
| |
| ::: |
| |
| ## Create a kind cluster |
| |
| Ensure you have Docker running and start the kind cluster: |
| |
| ```shell |
| kind create cluster |
| ``` |
| |
| See [Ingress](https://kind.sigs.k8s.io/docs/user/ingress/#create-cluster) to learn more about setting up ingress on a kind cluster. |
| |
| ## Install APISIX and ingress controller |
| |
| The script below installs APISIX and the ingress controller: |
| |
| ```shell |
| 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=NodePort \ |
| --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 |
| ``` |
| |
| 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. |
| |
| You should now be able to use APISIX ingress controller. You can try running this [minimal example](../tutorials/proxy-the-httpbin-service.md) to see if everything is working perfectly. |