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.

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

docs: update keys based helm chart version #2085

Merged
merged 1 commit into from
Dec 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/ack.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ You should now be able to use APISIX ingress controller. You can try running thi

### Enable SSL

SSL is disabled by default. You can enable it by adding the flag `--set gateway.tls.enabled=true`.
SSL is disabled by default. You can enable it by adding the flag `--set apisix.ssl.enabled=true`.

### Change default keys

Expand Down
4 changes: 2 additions & 2 deletions docs/en/latest/deployments/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ helm install apisix apisix/apisix \
--namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix \
--set ingress-controller.config.apisix.adminAPIVersion=$ADMIN_API_VERSION \
--set gateway.tls.enabled=true \
--set apisix.ssl.enabled=true \
--set gateway.annotations."service\.beta\.kubernetes\.io/aws-load-balancer-type"=nlb
```

Expand Down Expand Up @@ -125,7 +125,7 @@ You should now be able to use APISIX ingress controller. You can try running thi

### Enable SSL

SSL is disabled by default. You can enable it by adding the flag `--set gateway.tls.enabled=true`.
SSL is disabled by default. You can enable it by adding the flag `--set apisix.ssl.enabled=true`.

### Change default keys

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ You should now be able to use APISIX ingress controller. You can try running thi

### Enable SSL

SSL is disabled by default. You can enable it by adding the flag `--set gateway.tls.enabled=true`.
SSL is disabled by default. You can enable it by adding the flag `--set apisix.ssl.enabled=true`.

### Change default keys

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ You should now be able to use APISIX ingress controller. You can try running thi

### Enable SSL

SSL is disabled by default. You can enable it by adding the flag `--set gateway.tls.enabled=true`.
SSL is disabled by default. You can enable it by adding the flag `--set apisix.ssl.enabled=true`.

### Change default keys

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/k3s-rke.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ helm repo update
# We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--create-namespace \
--namespace ingress-apisix \
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/kind.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ helm repo update
# We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--create-namespace \
--namespace ingress-apisix \
Expand Down
4 changes: 2 additions & 2 deletions docs/en/latest/deployments/kubesphere.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ helm repo update
# We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--create-namespace \
--namespace ingress-apisix \
Expand Down Expand Up @@ -96,7 +96,7 @@ You should now be able to use APISIX ingress controller. You can try running thi

### Enable SSL

SSL is disabled by default. You can enable it by adding the flag `--set gateway.tls.enabled=true`.
SSL is disabled by default. You can enable it by adding the flag `--set apisix.ssl.enabled=true`.

### Change default keys

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/minikube.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ helm repo update
# We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--create-namespace \
--namespace ingress-apisix \
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ helm repo update
# We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--set etcd.podSecurityContext.enabled=false \
--set etcd.containerSecurityContext.enabled=false \
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/deployments/tke.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ You should now be able to use APISIX ingress controller. You can try running thi

### Enable SSL

SSL is disabled by default. You can enable it by adding the flag `--set gateway.tls.enabled=true`.
SSL is disabled by default. You can enable it by adding the flag `--set apisix.ssl.enabled=true`.

### Change default keys

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update
kubectl create ns ingress-apisix
helm install apisix apisix/apisix --namespace ingress-apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix \
--set ingress-controller.config.kubernetes.enableGatewayAPI=true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Then install APISIX using helm with the following command in the directory of Ap
# We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set apisix.image.repository=custom/apisix \
--set apisix.image.tag=v0.1 \
--set extPlugin.enabled=true \
Expand Down
4 changes: 2 additions & 2 deletions docs/en/latest/tutorials/istio-egress-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ kubectl create ns ingress-apisix
kubectl label ns ingress-apisix istio-injection=disabled

helm install apisix apisix/apisix --create-namespace \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix \
--set gateway.tls.enabled=true
--set apisix.ssl.enabled=true
```

### Create Test Workload
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ This tutorial will detail how to manage secrets of ApisixTls using cert-manager.
* Install [apisix-ingress-controller](https://github.com/apache/apisix-ingress-controller/blob/master/install.md).
* Install [cert-manager](https://cert-manager.io/docs/installation/#default-static-install).

In this guide, we assume that your APISIX is installed with `ssl` enabled, which is not enabled by default in the Helm Chart. To enable it, you need to set `gateway.tls.enabled=true` during installation.
In this guide, we assume that your APISIX is installed with `ssl` enabled, which is not enabled by default in the Helm Chart. To enable it, you need to set `apisix.ssl.enabled=true` during installation.

For example, you could install APISIX and APISIX ingress controller by running:

```bash
# We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--set gateway.tls.enabled=true \
--set apisix.ssl.enabled=true \
--set ingress-controller.config.apisix.serviceNamespace=default \
--set ingress-controller.config.apisix.adminAPIVersion=$ADMIN_API_VERSION
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ This tutorial will detail how to secure ingress using cert-manager.
* Install [apisix-ingress-controller](https://github.com/apache/apisix-ingress-controller/blob/master/install.md).
* Install [cert-manager](https://cert-manager.io/docs/installation/#default-static-install).

In this guide, we assume that your APISIX is installed with `ssl` enabled, which is not enabled by default in the Helm Chart. To enable it, you need to set `gateway.tls.enabled=true` during installation.
In this guide, we assume that your APISIX is installed with `ssl` enabled, which is not enabled by default in the Helm Chart. To enable it, you need to set `apisix.ssl.enabled=true` during installation.

For example, you could install APISIX and APISIX ingress controller by running:

```bash
# We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--set gateway.tls.enabled=true \
--set apisix.ssl.enabled=true \
--set ingress-controller.config.apisix.serviceNamespace=default \
--set ingress-controller.config.apisix.adminAPIVersion=$ADMIN_API_VERSION
```
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/tutorials/mtls.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To learn more about mTLS, please refer to [Mutual authentication](https://en.wik
- an available Kubernetes cluster
- an available APISIX and APISIX Ingress Controller installation

In this guide, we assume that your APISIX is installed in the `apisix` namespace and `ssl` is enabled, which is not enabled by default in the Helm Chart. To enable it, you need to set `gateway.tls.enabled=true` during installation.
In this guide, we assume that your APISIX is installed in the `apisix` namespace and `ssl` is enabled, which is not enabled by default in the Helm Chart. To enable it, you need to set `apisix.ssl.enabled=true` during installation.

Assuming the SSL port is `9443`.

Expand Down
4 changes: 2 additions & 2 deletions docs/en/latest/tutorials/proxy-grpc-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ You could install APISIX and APISIX ingress controller by running:
# We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix -n ingress-apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--set gateway.tls.enabled=true \
--set apisix.ssl.enabled=true \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix \
--set ingress-controller.config.apisix.adminAPIVersion=$ADMIN_API_VERSION
```
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/tutorials/using-custom-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ plugins:
- custom-response
```

Finally you can enable the Ingress controller and configure the gateway to be exposed to external traffic. For this, set `gateway.type=NodePort`, `ingress-controller.enabled=true`, and `ingress-controller.config.apisix.serviceNamespace=ingress-apisix` in your `values.yaml` file.
Finally you can enable the Ingress controller and configure the gateway to be exposed to external traffic. For this, set `service.type=NodePort`, `ingress-controller.enabled=true`, and `ingress-controller.config.apisix.serviceNamespace=ingress-apisix` in your `values.yaml` file.

Now we can run `helm install` with this [updated values.yaml](https://raw.githubusercontent.com/navendu-pottekkat/apisix-in-kubernetes/master/custom-plugin/values.yaml) file:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Just as an example, the specific configuration needs to be modified by yourself.

```sh
helm upgrade apisix apisix/apisix \
--set gateway.type=NodePort \
--set service.type=NodePort \
--set ingress-controller.enabled=true \
--namespace ingress-apisix \
--set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
Expand Down
Loading