This is an automated email from the ASF dual-hosted git repository.
kvn pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/master by this push:
new f72d75d doc: add document about running ingress apisix on k3s (#178)
f72d75d is described below
commit f72d75d40b416e57525e86b940747f2433f2a59c
Author: Alex Zhang <[email protected]>
AuthorDate: Mon Jan 18 18:26:13 2021 +0800
doc: add document about running ingress apisix on k3s (#178)
---
docs/deployments/k3s.md | 82 +++++++++++++++++++++++++++++++
docs/install.md | 1 +
docs/samples/proxy-the-httpbin-service.md | 6 +--
3 files changed, 86 insertions(+), 3 deletions(-)
diff --git a/docs/deployments/k3s.md b/docs/deployments/k3s.md
new file mode 100644
index 0000000..9adf841
--- /dev/null
+++ b/docs/deployments/k3s.md
@@ -0,0 +1,82 @@
+<!--
+#
+# 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.
+#
+-->
+
+# Install Ingress APISIX on K3S
+
+This document explains how to install Ingress APISIX on [k3S](https://k3s.io/).
+
+K3S is a certified Kubernetes distribution built for IoT and Edge computing,
whilst [Apache APISIX](https://apisix.apache.org) is also good at IoT (See
[MQTT
plugin](https://github.com/apache/apisix/blob/master/doc/plugins/mqtt-proxy.md))
and runs well on ARM architecture.
+It's a good choice to use Ingress APISIX as the north-south API gateway in K3S.
+
+## Prerequisites
+
+* Install [K3S](https://rancher.com/docs/k3s/latest/en/installation/).
+* Install [Helm](https://helm.sh/).
+* Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
+* Clone
[apisix-ingress-controller](https://github.com/apache/apisix-ingress-controller).
+* Make sure your target namespace exists, kubectl operations thorough this
document will be executed in namespace `ingress-apisix`.
+
+## Install APISIX
+
+[Apache APISIX](http://apisix.apache.org/) as the proxy plane of
apisix-ingress-controller, should be deployed in advance.
+
+```shell
+cd /path/to/apisix-helm-chart
+helm repo add bitnami https://charts.bitnami.com/bitnami
+helm dependency update ./chart/apisix
+helm install apisix ./chart/apisix \
+ --set gateway.type=NodePort \
+ --set allow.ipList="{0.0.0.0/0}" \
+ --namespace ingress-apisix \
+ --kubeconfig /etc/rancher/k3s/k3s.yaml
+kubectl get service --namespace ingress-apisix
+```
+
+*Note root permission may required to run above commands.*
+
+Two Service resources were created, one is `apisix-gateway`, which processes
the real traffic; another is `apisix-admin`, which acts as the control plane to
process all the configuration changes.
+
+The gateway service type is set to `NodePort`, so that clients can access
Apache APISIX through the Node IPs and the assigned port. If you want to expose
a `LoadBalancer` service, try to use
[Klipper](https://github.com/k3s-io/klipper-lb).
+
+Another thing should be concerned that the `allow.ipList` field should be
customized according to the [K3S Networking
Settings](https://rancher.com/docs/k3s/latest/en/installation/install-options/server-config/#networking),
so that the apisix-ingress-controller instances can access the APISIX
instances (resources pushing).
+
+## Install apisix-ingress-controller
+
+You can also install apisix-ingress-controller by Helm Charts, it's
recommended to install it in the same namespace with Apache APISIX.
+
+```shell
+cd /path/to/apisix-ingress-controller
+# install base resources, e.g. ServiceAccount.
+helm install ingress-apisix-base -n ingress-apisix ./charts/base --kubeconfig
/etc/rancher/k3s/k3s.yaml
+# install apisix-ingress-controller
+helm install ingress-apisix ./charts/ingress-apisix \
+ --set ingressController.image.tag=dev \
+ --set
ingressController.config.apisix.baseURL=http://apisix-admin:9180/apisix/admin \
+ --set
ingressController.config.apisix.adminKey=edd1c9f034335f136f87ad84b625c8f1 \
+ --namespace ingress-apisix \
+ --kubeconfig /etc/rancher/k3s/k3s.yaml
+```
+
+*Note root permission may required to run above commands.*
+
+The admin key used in abovementioned commands is the default one, if you
change the admin key configuration when you deployed APISIX, please remember to
change it here.
+
+Change the `ingressController.image.tag` to the Apache APISIX version that you
desire. You have to Wait for while until the correspdoning pods are running.
+
+Now try to create some [resources](../CRD-specification.md) to verify the
running status. As a minimalist example, see
[proxy-the-httpbin-service](../samples/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
diff --git a/docs/install.md b/docs/install.md
index a2463a1..3975795 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -22,6 +22,7 @@
This is an index page about installing Ingress APISIX in several environments.
Click the following links on demands.
* [Install Ingress APISIX on Minikube](deployments/minikube.md)
+* [Install Ingress APISIX on K3S](deployments/k3s.md)
* [Install Ingress APISIX on Azure AKS](deployments/azure.md)
* [Install Ingress APISIX on AWS EKS](deployments/aws.md)
diff --git a/docs/samples/proxy-the-httpbin-service.md
b/docs/samples/proxy-the-httpbin-service.md
index 5c63b9e..a9e143b 100644
--- a/docs/samples/proxy-the-httpbin-service.md
+++ b/docs/samples/proxy-the-httpbin-service.md
@@ -55,8 +55,8 @@ spec:
paths:
- backend:
serviceName: httpbin
- servicePort: 8080
- path: /hello*
+ servicePort: 80
+ path: /*
```
The YAML snippet shows a simple `ApisixRoute` configuration, which tells
Apache APISIX to route all requests with Host `local.httpbin.org` to the
`httpbin` service.
@@ -71,7 +71,7 @@ kubectl apply -f httpbin-route.yaml
Run curl call in one of Apache APISIX Pods to check whether the resource was
delivered to it. Note you should replace the value of `--apisix-admin-key` to
the real `admin_key` value in your Apache APISIX cluster.
```shell
-kubectl exec -it -n ${namespace of Apache APISIX} ${Pod name of Apache APISIX}
-- curl http://127.0.0.1:9180/apisix/admin/routes --apisix-admin-key
edd1c9f034335f136f87ad84b625c8f1
+kubectl exec -it -n ${namespace of Apache APISIX} ${Pod name of Apache APISIX}
-- curl http://127.0.0.1:9180/apisix/admin/routes -H 'X-API-Key:
edd1c9f034335f136f87ad84b625c8f1'
```
And request to Apache APISIX to verify the route.
