This is an automated email from the ASF dual-hosted git repository.
zhangjintao 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 1b2bc34 docs: Optimize installation documentation (#785)
1b2bc34 is described below
commit 1b2bc3418bd2c7a2a085e55d7bf937b5c27f1ddb
Author: Baoyuan <[email protected]>
AuthorDate: Tue Dec 7 23:08:52 2021 -0600
docs: Optimize installation documentation (#785)
---
docs/en/latest/deployments/ack.md | 3 +--
docs/en/latest/deployments/aws.md | 3 +--
docs/en/latest/deployments/azure.md | 3 +--
docs/en/latest/deployments/gke.md | 3 +--
docs/en/latest/deployments/k3s-rke.md | 3 +--
docs/en/latest/deployments/kubesphere.md | 3 +--
docs/en/latest/deployments/minikube.md | 3 +--
docs/en/latest/deployments/tke.md | 3 +--
8 files changed, 8 insertions(+), 16 deletions(-)
diff --git a/docs/en/latest/deployments/ack.md
b/docs/en/latest/deployments/ack.md
index c06185c..3e0966f 100644
--- a/docs/en/latest/deployments/ack.md
+++ b/docs/en/latest/deployments/ack.md
@@ -28,7 +28,6 @@ This document explains how to install Ingress APISIX on
[ali-cloud ACK](https://
* Create an ACK Service on ali-cloud.
* Download the kube config for your ACK, follow the
[introduction](https://www.alibabacloud.com/help/zh/doc-detail/86378.html).
* Install [Helm](https://helm.sh/).
-* **Make sure your target namespace exists**, `kubectl` operations thorough
this document will be executed in namespace `ingress-apisix`.
## Install APISIX and apisix-ingress-controller
@@ -44,7 +43,7 @@ helm install apisix apisix/apisix \
--set ingress-controller.enabled=true \
--set etcd.persistence.storageClass="alicloud-disk-ssd" \
--set etcd.persistence.size="20Gi" \
- --namespace ingress-apisix
+ --namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
kubectl get service --namespace ingress-apisix
```
diff --git a/docs/en/latest/deployments/aws.md
b/docs/en/latest/deployments/aws.md
index 5b5660e..e717a3e 100644
--- a/docs/en/latest/deployments/aws.md
+++ b/docs/en/latest/deployments/aws.md
@@ -28,7 +28,6 @@ This document explains how to install Ingress APISIX on
[Amazon EKS](https://ama
* Create an EKS Service on AWS.
* Download the kube config for your EKS from [aws cli
interface](https://amazonaws-china.com/cli/).
* Install [Helm](https://helm.sh/).
-* Make sure your target namespace exists, kubectl operations thorough this
document will be executed in namespace `ingress-apisix`.
## Install APISIX and apisix-ingress-controller
@@ -42,7 +41,7 @@ kubectl create ns ingress-apisix
helm install apisix apisix/apisix \
--set gateway.type=LoadBalancer \
--set ingress-controller.enabled=true \
- --namespace ingress-apisix
+ --namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
kubectl get service --namespace ingress-apisix
```
diff --git a/docs/en/latest/deployments/azure.md
b/docs/en/latest/deployments/azure.md
index cd6bddc..d9ca438 100644
--- a/docs/en/latest/deployments/azure.md
+++ b/docs/en/latest/deployments/azure.md
@@ -28,7 +28,6 @@ This document explains how to install Ingress APISIX on
[Azure AKS](https://docs
* 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`.
* Install [Helm](https://helm.sh/).
-* Make sure your target namespace exists, kubectl operations thorough this
document will be executed in namespace `ingress-apisix`.
## Install APISIX and apisix-ingress-controller
@@ -42,7 +41,7 @@ kubectl create ns ingress-apisix
helm install apisix apisix/apisix \
--set gateway.type=LoadBalancer \
--set ingress-controller.enabled=true \
- --namespace ingress-apisix
+ --namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
kubectl get service --namespace ingress-apisix
```
diff --git a/docs/en/latest/deployments/gke.md
b/docs/en/latest/deployments/gke.md
index 52bb3c1..3a4662e 100644
--- a/docs/en/latest/deployments/gke.md
+++ b/docs/en/latest/deployments/gke.md
@@ -28,7 +28,6 @@ This document explains how to install Ingress APISIX on
[Google Cloud GKE](https
* 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/).
-* Make sure your target namespace exists, kubectl operations thorough this
document will be executed in namespace `ingress-apisix`.
## Install APISIX and apisix-ingress-controller
@@ -42,7 +41,7 @@ kubectl create ns ingress-apisix
helm install apisix apisix/apisix \
--set gateway.type=LoadBalancer \
--set ingress-controller.enabled=true \
- --namespace ingress-apisix
+ --namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
kubectl get service --namespace ingress-apisix
```
diff --git a/docs/en/latest/deployments/k3s-rke.md
b/docs/en/latest/deployments/k3s-rke.md
index ca213bf..799e68d 100644
--- a/docs/en/latest/deployments/k3s-rke.md
+++ b/docs/en/latest/deployments/k3s-rke.md
@@ -30,7 +30,6 @@ It's a good choice to use Ingress APISIX as the north-south
API gateway in K3S.
* Install [K3S](https://rancher.com/docs/k3s/latest/en/installation/) or
[Rancher RKE](https://rancher.com/docs/rke/latest/en/installation/).
* Install [Helm](https://helm.sh/).
-* Make sure your target namespace exists, kubectl operations through this
document will be executed in namespace `ingress-apisix`.
## Install APISIX and apisix-ingress-controller
@@ -45,7 +44,7 @@ helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set ingress-controller.enabled=true \
--namespace ingress-apisix \
- --set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
+ --set ingress-controller.config.apisix.serviceNamespace=ingress-apisix \
--kubeconfig /etc/rancher/k3s/k3s.yaml
kubectl get service --namespace ingress-apisix
```
diff --git a/docs/en/latest/deployments/kubesphere.md
b/docs/en/latest/deployments/kubesphere.md
index 5cf4722..49e8e74 100644
--- a/docs/en/latest/deployments/kubesphere.md
+++ b/docs/en/latest/deployments/kubesphere.md
@@ -29,7 +29,6 @@ KubeSphere is a distributed operating system managing cloud
native applications
* Install [KubeSphere](https://kubesphere.io/docs/quick-start/), you can
choose [All-in-one Installation on
Linux](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/) or [Minimal
KubeSphere on
Kubernetes](https://kubesphere.io/docs/quick-start/minimal-kubesphere-on-k8s/).
* Install [Helm](https://helm.sh/).
-* Make sure your target namespace exists, kubectl operations of this document
will be executed in namespace `ingress-apisix`.
## Install APISIX and apisix-ingress-controller
@@ -43,7 +42,7 @@ kubectl create ns ingress-apisix
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set ingress-controller.enabled=true \
- --namespace ingress-apisix
+ --namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
kubectl get service --namespace ingress-apisix
```
diff --git a/docs/en/latest/deployments/minikube.md
b/docs/en/latest/deployments/minikube.md
index 83cb3e2..6de3141 100644
--- a/docs/en/latest/deployments/minikube.md
+++ b/docs/en/latest/deployments/minikube.md
@@ -27,7 +27,6 @@ This document explains how to install Ingress APISIX on
[Minikube](https://minik
* Install [Minikube](https://minikube.sigs.k8s.io/docs/start/).
* Install [Helm](https://helm.sh/).
-* Make sure your target namespace exists, kubectl operations thorough this
document will be executed in namespace `ingress-apisix`.
## Install APISIX and apisix-ingress-controller
@@ -41,7 +40,7 @@ kubectl create ns ingress-apisix
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set ingress-controller.enabled=true \
- --namespace ingress-apisix
+ --namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
kubectl get service --namespace ingress-apisix
```
diff --git a/docs/en/latest/deployments/tke.md
b/docs/en/latest/deployments/tke.md
index 5ebddb9..b489a86 100644
--- a/docs/en/latest/deployments/tke.md
+++ b/docs/en/latest/deployments/tke.md
@@ -28,7 +28,6 @@ This document explains how to install Ingress APISIX on
[Tencent TKE](https://cl
* Create a TKE Service on Tencent Cloud and make sure the API Server is
accessible from your workspace.
* Install [Helm](https://helm.sh/).
* Download the kube config for your TKE Console.
-* Make sure your target namespace exists, kubectl operations thorough this
document will be executed in namespace `ingress-apisix`.
## Install APISIX and apisix-ingress-controller
@@ -43,7 +42,7 @@ helm install apisix apisix/apisix \
--set gateway.type=LoadBalancer \
--set ingress-controller.enabled=true \
--set etcd.persistence.size="10Gi" \
- --namespace ingress-apisix
+ --namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
kubectl get service --namespace ingress-apisix
```
