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 5d3f1b3 doc: add document to explain how to run on GKE (#180)
5d3f1b3 is described below
commit 5d3f1b3e00d9e0284c046cb1f0599b17ddd2ce1e
Author: Alex Zhang <zchao1...@gmail.com>
AuthorDate: Wed Jan 20 14:27:28 2021 +0800
doc: add document to explain how to run on GKE (#180)
* doc: add document to explain how to run on GKE
* fix: add adminKey
* fix: small case
---
docs/deployments/aws.md | 2 +-
docs/deployments/azure.md | 2 +-
docs/deployments/{azure.md => gke.md} | 15 ++++++++-------
docs/deployments/k3s.md | 2 +-
docs/deployments/minikube.md | 2 +-
5 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/docs/deployments/aws.md b/docs/deployments/aws.md
index b633e6f..f6666e7 100644
--- a/docs/deployments/aws.md
+++ b/docs/deployments/aws.md
@@ -71,7 +71,7 @@ helm install ingress-apisix ./charts/ingress-apisix \
--namespace ingress-apisix
```
-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.
+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 open your [EKS console](https://console.aws.amazon.com/eks/home), choosing
your cluster and clicking the Workloads tag, you'll see all pods of Apache
APISIX, etcd and apisix-ingress-controller are ready.
diff --git a/docs/deployments/azure.md b/docs/deployments/azure.md
index 506c15e..da531f9 100644
--- a/docs/deployments/azure.md
+++ b/docs/deployments/azure.md
@@ -70,6 +70,6 @@ helm install ingress-apisix ./charts/ingress-apisix \
--namespace ingress-apisix
```
-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.
+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/deployments/azure.md b/docs/deployments/gke.md
similarity index 76%
copy from docs/deployments/azure.md
copy to docs/deployments/gke.md
index 506c15e..67d9827 100644
--- a/docs/deployments/azure.md
+++ b/docs/deployments/gke.md
@@ -17,14 +17,14 @@
#
-->
-# Install Ingress APISIX on Azure AKS
+# Install Ingress APISIX on Google Cloud GKE
-This document explains how to install Ingress APISIX on [Auzre
AKS](https://docs.microsoft.com/en-us/azure/aks/intro-kubernetes#:~:text=Azure%20Kubernetes%20Service%20(AKS)%20makes,managed%20Kubernetes%20cluster%20in%20Azure.&text=The%20Kubernetes%20masters%20are%20managed,clusters%2C%20not%20for%20the%20masters.).
+This document explains how to install Ingress APISIX on [Google Cloud
GKE](https://cloud.google.com/kubernetes-engine).
## Prerequisites
-* Create an Kubernetes Service on Azure.
-* Install [Azure
CLI](https://docs.microsoft.com/en-us/cli/azure/#:~:text=The%20Azure%20command%2Dline%20interface,with%20an%20emphasis%20on%20automation.)
and download the credentials by running `az aks get-credentials`.
+* Create an Kubernetes Service on GKE.
+* Install [Google Cloud SDK](https://cloud.google.com/sdk) and get the
credentials or you can just use the [Cloud
Shell](https://cloud.google.com/shell).
* 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).
@@ -47,13 +47,13 @@ kubectl get service --namespace ingress-apisix
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 `LoadBalancer`, so that clients can access
Apache APISIX through a load balancer IP. You can find the load balancer IP by
running:
+The gateway service type is set to `LoadBalancer`, so that clients can access
Apache APISIX through the [GKE Load
Balancer](https://cloud.google.com/kubernetes-engine/docs/concepts/service#services_of_type_loadbalancer)
. You can find the load balancer IP by running:
```shell
kubectl get service apisix-gateway --namespace ingress-apisix -o
jsonpath='{.status.loadBalancer.ingress[].ip}'
```
-Another thing should be concerned that the `allow.ipList` field should be
customized according to the [Pod CIRD configuration of
AKS](https://docs.microsoft.com/en-us/azure/aks/configure-azure-cni), so that
the apisix-ingress-controller instances can access the APISIX instances
(resources pushing).
+Another thing should be concerned that the `allow.ipList` field should be
customized according to the [Pod CIRD configuration of
GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/flexible-pod-cidr),
so that the apisix-ingress-controller instances can access the APISIX instances
(resources pushing).
## Install apisix-ingress-controller
@@ -67,9 +67,10 @@ helm install ingress-apisix-base -n ingress-apisix
./charts/base
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
```
-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.
+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/deployments/k3s.md b/docs/deployments/k3s.md
index 9adf841..38ef947 100644
--- a/docs/deployments/k3s.md
+++ b/docs/deployments/k3s.md
@@ -77,6 +77,6 @@ helm install ingress-apisix ./charts/ingress-apisix \
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.
+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/deployments/minikube.md b/docs/deployments/minikube.md
index b9b68a6..21e06cb 100644
--- a/docs/deployments/minikube.md
+++ b/docs/deployments/minikube.md
@@ -62,6 +62,6 @@ helm install ingress-apisix ./charts/ingress-apisix \
--namespace ingress-apisix
```
-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.
+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 of Ingress APISIX. 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.
