Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Optimize installation documentation #785

Merged
merged 7 commits into from
Dec 8, 2021
Merged

docs: Optimize installation documentation #785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fe9a6fe
docs: change FAQ.md title
Baoyuantop Jul 23, 2021
9f596d3
docs: change style
Baoyuantop Jul 23, 2021
b6fd619
fix: markdown lint
Baoyuantop Jul 24, 2021
6c3e0a5
Merge branch 'apache:master' into master
Baoyuantop Aug 13, 2021
9813fd5
Merge branch 'apache:master' into master
Baoyuantop Dec 4, 2021
aaf7901
docs: Optimize installation documentation
Baoyuantop Dec 4, 2021
d95ab70
fix: synchronously modify other installation documents
Baoyuantop Dec 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/en/latest/deployments/ack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```
Expand Down
3 changes: 1 addition & 2 deletions docs/en/latest/deployments/aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```
Expand Down
3 changes: 1 addition & 2 deletions docs/en/latest/deployments/azure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```
Expand Down
3 changes: 1 addition & 2 deletions docs/en/latest/deployments/gke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```
Expand Down
3 changes: 1 addition & 2 deletions docs/en/latest/deployments/k3s-rke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```
Expand Down
3 changes: 1 addition & 2 deletions docs/en/latest/deployments/kubesphere.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```
Expand Down
3 changes: 1 addition & 2 deletions docs/en/latest/deployments/minikube.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 \
tao12345666333 marked this conversation as resolved.
Show resolved Hide resolved
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
tao12345666333 marked this conversation as resolved.
Show resolved Hide resolved
kubectl get service --namespace ingress-apisix
```
Expand Down
3 changes: 1 addition & 2 deletions docs/en/latest/deployments/tke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```
Expand Down