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 26d5c5c Docs: add more config example (#777)
26d5c5c is described below
commit 26d5c5cf96d7e5ece89aed62dcc557bad8fe61bf
Author: LXM <[email protected]>
AuthorDate: Fri Dec 3 12:24:32 2021 +0800
Docs: add more config example (#777)
---
docs/en/latest/deployments/ack.md | 12 ++++++++++++
docs/en/latest/deployments/aws.md | 12 ++++++++++++
docs/en/latest/deployments/azure.md | 12 ++++++++++++
docs/en/latest/deployments/gke.md | 12 ++++++++++++
docs/en/latest/deployments/kubesphere.md | 12 ++++++++++++
docs/en/latest/deployments/tke.md | 12 ++++++++++++
6 files changed, 72 insertions(+)
diff --git a/docs/en/latest/deployments/ack.md
b/docs/en/latest/deployments/ack.md
index e95179b..c06185c 100644
--- a/docs/en/latest/deployments/ack.md
+++ b/docs/en/latest/deployments/ack.md
@@ -72,3 +72,15 @@ etcd:
```
Try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+
+### Specify The Ingress Version
+
+apisix-ingress-controller will watch apiVersion of `networking.k8s.io/v1` by
default. If the target kubernetes version is under `v1.19`, add `--set
ingress-controller.config.kubernetes.ingressVersion=networking/v1beta1` or
`--set ingress-controller.config.kubernetes.ingressVersion=extensions/v1beta1`
if your kubernetes cluster is under `v1.16`
+
+### Enable SSL
+
+The ssl config is disabled by default, add `--set gateway.tls.enabled=true` to
enable tls support.
+
+### Change default apikey
+
+It's Recommended to change the default key by add `--set
ingress-controller.config.apisix.adminKey=ADMIN_KEY_GENERATED_BY_YOURSELF`,
`--set admin.credentials.admin=ADMIN_KEY_GENERATED_BY_YOURSELF`, `--set
admin.credentials.viewer=VIEWER_KEY_GENERATED_BY_YOURSELF`, notice that
`ingress-controller.config.apisix.adminKey` and `admin.credentials.admin` must
be the same, and should better not same as `admin.credentials.viewer`.
diff --git a/docs/en/latest/deployments/aws.md
b/docs/en/latest/deployments/aws.md
index 9e01462..5b5660e 100644
--- a/docs/en/latest/deployments/aws.md
+++ b/docs/en/latest/deployments/aws.md
@@ -63,3 +63,15 @@ kubectl get service apisix-gateway --namespace
ingress-apisix -o jsonpath='{.sta
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.
Try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+
+### Specify The Ingress Version
+
+apisix-ingress-controller will watch apiVersion of `networking.k8s.io/v1` by
default. If the target kubernetes version is under `v1.19`, add `--set
ingress-controller.config.kubernetes.ingressVersion=networking/v1beta1` or
`--set ingress-controller.config.kubernetes.ingressVersion=extensions/v1beta1`
if your kubernetes cluster is under `v1.16`
+
+### Enable SSL
+
+The ssl config is disabled by default, add `--set gateway.tls.enabled=true` to
enable tls support.
+
+### Change default apikey
+
+It's Recommended to change the default key by add `--set
ingress-controller.config.apisix.adminKey=ADMIN_KEY_GENERATED_BY_YOURSELF`,
`--set admin.credentials.admin=ADMIN_KEY_GENERATED_BY_YOURSELF`, `--set
admin.credentials.viewer=VIEWER_KEY_GENERATED_BY_YOURSELF`, notice that
`ingress-controller.config.apisix.adminKey` and `admin.credentials.admin` must
be the same, and should better not same as `admin.credentials.viewer`.
diff --git a/docs/en/latest/deployments/azure.md
b/docs/en/latest/deployments/azure.md
index 0ed4134..cd6bddc 100644
--- a/docs/en/latest/deployments/azure.md
+++ b/docs/en/latest/deployments/azure.md
@@ -61,3 +61,15 @@ kubectl get service apisix-gateway --namespace
ingress-apisix -o jsonpath='{.sta
```
Now try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+
+### Specify The Ingress Version
+
+apisix-ingress-controller will watch apiVersion of `networking.k8s.io/v1` by
default. If the target kubernetes version is under `v1.19`, add `--set
ingress-controller.config.kubernetes.ingressVersion=networking/v1beta1` or
`--set ingress-controller.config.kubernetes.ingressVersion=extensions/v1beta1`
if your kubernetes cluster is under `v1.16`
+
+### Enable SSL
+
+The ssl config is disabled by default, add `--set gateway.tls.enabled=true` to
enable tls support.
+
+### Change default apikey
+
+It's Recommended to change the default key by add `--set
ingress-controller.config.apisix.adminKey=ADMIN_KEY_GENERATED_BY_YOURSELF`,
`--set admin.credentials.admin=ADMIN_KEY_GENERATED_BY_YOURSELF`, `--set
admin.credentials.viewer=VIEWER_KEY_GENERATED_BY_YOURSELF`, notice that
`ingress-controller.config.apisix.adminKey` and `admin.credentials.admin` must
be the same, and should better not same as `admin.credentials.viewer`.
diff --git a/docs/en/latest/deployments/gke.md
b/docs/en/latest/deployments/gke.md
index bcfa284..52bb3c1 100644
--- a/docs/en/latest/deployments/gke.md
+++ b/docs/en/latest/deployments/gke.md
@@ -61,3 +61,15 @@ kubectl get service apisix-gateway --namespace
ingress-apisix -o jsonpath='{.sta
```
Now try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+
+### Specify The Ingress Version
+
+apisix-ingress-controller will watch apiVersion of `networking.k8s.io/v1` by
default. If the target kubernetes version is under `v1.19`, add `--set
ingress-controller.config.kubernetes.ingressVersion=networking/v1beta1` or
`--set ingress-controller.config.kubernetes.ingressVersion=extensions/v1beta1`
if your kubernetes cluster is under `v1.16`
+
+### Enable SSL
+
+The ssl config is disabled by default, add `--set gateway.tls.enabled=true` to
enable tls support.
+
+### Change default apikey
+
+It's Recommended to change the default key by add `--set
ingress-controller.config.apisix.adminKey=ADMIN_KEY_GENERATED_BY_YOURSELF`,
`--set admin.credentials.admin=ADMIN_KEY_GENERATED_BY_YOURSELF`, `--set
admin.credentials.viewer=VIEWER_KEY_GENERATED_BY_YOURSELF`, notice that
`ingress-controller.config.apisix.adminKey` and `admin.credentials.admin` must
be the same, and should better not same as `admin.credentials.viewer`.
diff --git a/docs/en/latest/deployments/kubesphere.md
b/docs/en/latest/deployments/kubesphere.md
index 556f751..5cf4722 100644
--- a/docs/en/latest/deployments/kubesphere.md
+++ b/docs/en/latest/deployments/kubesphere.md
@@ -59,3 +59,15 @@ The gateway service type is set to `NodePort`, so that
clients can access Apache
If you want to expose a `LoadBalancer` service, try to use
[Porter](https://github.com/kubesphere/porter).
Now try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+
+### Specify The Ingress Version
+
+apisix-ingress-controller will watch apiVersion of `networking.k8s.io/v1` by
default. If the target kubernetes version is under `v1.19`, add `--set
ingress-controller.config.kubernetes.ingressVersion=networking/v1beta1` or
`--set ingress-controller.config.kubernetes.ingressVersion=extensions/v1beta1`
if your kubernetes cluster is under `v1.16`
+
+### Enable SSL
+
+The ssl config is disabled by default, add `--set gateway.tls.enabled=true` to
enable tls support.
+
+### Change default apikey
+
+It's Recommended to change the default key by add `--set
ingress-controller.config.apisix.adminKey=ADMIN_KEY_GENERATED_BY_YOURSELF`,
`--set admin.credentials.admin=ADMIN_KEY_GENERATED_BY_YOURSELF`, `--set
admin.credentials.viewer=VIEWER_KEY_GENERATED_BY_YOURSELF`, notice that
`ingress-controller.config.apisix.adminKey` and `admin.credentials.admin` must
be the same, and should better not same as `admin.credentials.viewer`.
diff --git a/docs/en/latest/deployments/tke.md
b/docs/en/latest/deployments/tke.md
index 86c0f07..5ebddb9 100644
--- a/docs/en/latest/deployments/tke.md
+++ b/docs/en/latest/deployments/tke.md
@@ -68,3 +68,15 @@ kubectl get service apisix-gateway --namespace
ingress-apisix -o jsonpath='{.sta
Now open your [TKE console](https://console.cloud.tencent.com/tke2/overview),
choosing your cluster and clicking the Workloads tag, you'll see all pods of
Apache APISIX, etcd and apisix-ingress-controller are ready.
Try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+
+### Specify The Ingress Version
+
+apisix-ingress-controller will watch apiVersion of `networking.k8s.io/v1` by
default. If the target kubernetes version is under `v1.19`, add `--set
ingress-controller.config.kubernetes.ingressVersion=networking/v1beta1` or
`--set ingress-controller.config.kubernetes.ingressVersion=extensions/v1beta1`
if your kubernetes cluster is under `v1.16`
+
+### Enable SSL
+
+The ssl config is disabled by default, add `--set gateway.tls.enabled=true` to
enable tls support.
+
+### Change default apikey
+
+It's Recommended to change the default key by add `--set
ingress-controller.config.apisix.adminKey=ADMIN_KEY_GENERATED_BY_YOURSELF`,
`--set admin.credentials.admin=ADMIN_KEY_GENERATED_BY_YOURSELF`, `--set
admin.credentials.viewer=VIEWER_KEY_GENERATED_BY_YOURSELF`, notice that
`ingress-controller.config.apisix.adminKey` and `admin.credentials.admin` must
be the same, and should better not same as `admin.credentials.viewer`.
