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

fix: add missing "site." prefix to jekyll variables #1392

Merged
merged 1 commit into from
Jun 27, 2023
Merged

fix: add missing "site." prefix to jekyll variables #1392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions app/_src/documentation/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ kumactl install control plane \
When using `helm`, you can override the configuration with the `envVars` field. For example, to configure the refresh interval for configuration with the data plane proxy, specify:
```sh
helm install \
--set {{set_flag_values_prefix}}controlPlane.envVars.KUMA_XDS_SERVER_DATAPLANE_CONFIGURATION_REFRESH_INTERVAL=5s \
--set {{set_flag_values_prefix}}controlPlane.envVars.KUMA_XDS_SERVER_DATAPLANE_STATUS_FLUSH_INTERVAL=5s \
--set {{site.set_flag_values_prefix}}controlPlane.envVars.KUMA_XDS_SERVER_DATAPLANE_CONFIGURATION_REFRESH_INTERVAL=5s \
--set {{site.set_flag_values_prefix}}controlPlane.envVars.KUMA_XDS_SERVER_DATAPLANE_STATUS_FLUSH_INTERVAL=5s \
{{ site.mesh_helm_install_name }} {{ site.mesh_helm_repo }}
```

Expand All @@ -52,7 +52,7 @@ helm install -f values.yaml {{ site.kuma_install_name }} {{ site.mesh_helm_repo
If you have a lot of configuration you can just write them all in a YAML file and use:

```shell
helm install {{ site.mesh_helm_install_name }} {{ site.mesh_helm_repo }} --set-file {{set_flag_values_prefix}}controlPlane.config=cp-conf.yaml
helm install {{ site.mesh_helm_install_name }} {{ site.mesh_helm_repo }} --set-file {{site.set_flag_values_prefix}}controlPlane.config=cp-conf.yaml
```
The value of the configmap `{{site.mesh_cp_name}}-config` is now the content of `cp-conf.yaml`.

Expand Down
2 changes: 1 addition & 1 deletion app/_src/explore/gateway-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Gateway API [`Gateways`](https://gateway-api.sigs.k8s.io/api-types/gateway/) are
2. Enable Gateway API support.

- With `kumactl`, use the `--experimental-gatewayapi` flag.
- With Helm, use the `{{set_flag_values_prefix}}experimental.gatewayAPI=true` value.
- With Helm, use the `{{site.set_flag_values_prefix}}experimental.gatewayAPI=true` value.

{% if_version lte:2.2.x %}
## Usage
Expand Down
30 changes: 15 additions & 15 deletions app/_src/production/cp-deployment/multi-zone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@
1. Set the `controlPlane.mode` value to `global` in the chart (`values.yaml`), then install. On the command line, run:

```sh
helm install {{ site.mesh_helm_install_name }} --create-namespace --namespace {{site.mesh_namespace}} --set {{set_flag_values_prefix}}controlPlane.mode=global {{ site.mesh_helm_repo }}
helm install {{ site.mesh_helm_install_name }} --create-namespace --namespace {{site.mesh_namespace}} --set {{site.set_flag_values_prefix}}controlPlane.mode=global {{ site.mesh_helm_repo }}
```

Or you can edit the chart and pass the file to the `helm install {{ site.mesh_helm_install_name }}` command. To get the default values, run:

```sh
helm show values {{mesh_helm_repo}}
helm show values {{site.mesh_helm_repo}}
```

1. Find the external IP and port of the `global-remote-sync` service in the `{{site.mesh_namespace}}` namespace:
Expand Down Expand Up @@ -201,7 +201,7 @@
--zone=<zone name> \
--ingress-enabled \
--kds-global-address grpcs://<global-kds-address>:5685 \
--set {{set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true | kubectl apply -f -
--set {{site.set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true | kubectl apply -f -
```
{% endif_version %}
{% if_version lte:2.2.x %}
Expand All @@ -219,7 +219,7 @@
Add `--egress-enabled` to list of arguments if you want to deploy optional [Zone Egress](/docs/{{ page.version }}/production/cp-deployment/zoneegress/).

{% if_version gte:2.3.x %}
`--set {{set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true` is required because the default global control plane's certificate is self-signed.
`--set {{site.set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true` is required because the default global control plane's certificate is self-signed.

Check warning on line 222 in app/_src/production/cp-deployment/multi-zone.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is required').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is required').", "location": {"path": "app/_src/production/cp-deployment/multi-zone.md", "range": {"start": {"line": 222, "column": 91}}}, "severity": "INFO"}
It is recommended to use a certificate signed by a trusted CA in production. See [Secure access across services](/docs/{{ page.version }}/production/secure-deployment/certificates/) page for more information.
{% endif_version %}

Expand All @@ -233,31 +233,31 @@
helm install {{ site.mesh_helm_install_name }} \
--create-namespace \
--namespace {{site.mesh_namespace}} \
--set {{set_flag_values_prefix}}controlPlane.mode=zone \
--set {{set_flag_values_prefix}}controlPlane.zone=<zone-name> \
--set {{set_flag_values_prefix}}ingress.enabled=true \
--set {{set_flag_values_prefix}}controlPlane.kdsGlobalAddress=grpcs://<global-kds-address>:5685 \
--set {{set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true {{ site.mesh_helm_repo }}
--set {{site.set_flag_values_prefix}}controlPlane.mode=zone \
--set {{site.set_flag_values_prefix}}controlPlane.zone=<zone-name> \
--set {{site.set_flag_values_prefix}}ingress.enabled=true \
--set {{site.set_flag_values_prefix}}controlPlane.kdsGlobalAddress=grpcs://<global-kds-address>:5685 \
--set {{site.set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true {{ site.mesh_helm_repo }}
```
{% endif_version %}
{% if_version lte:2.2.x %}
```sh
helm install {{ site.mesh_helm_install_name }} \
--create-namespace \
--namespace {{site.mesh_namespace}} \
--set {{set_flag_values_prefix}}controlPlane.mode=zone \
--set {{set_flag_values_prefix}}controlPlane.zone=<zone-name> \
--set {{set_flag_values_prefix}}ingress.enabled=true \
--set {{set_flag_values_prefix}}controlPlane.kdsGlobalAddress=grpcs://<global-kds-address>:5685 {{ site.mesh_helm_repo }}
--set {{site.set_flag_values_prefix}}controlPlane.mode=zone \
--set {{site.set_flag_values_prefix}}controlPlane.zone=<zone-name> \
--set {{site.set_flag_values_prefix}}ingress.enabled=true \
--set {{site.set_flag_values_prefix}}controlPlane.kdsGlobalAddress=grpcs://<global-kds-address>:5685 {{ site.mesh_helm_repo }}
```
{% endif_version %}

where `controlPlane.zone` is the same value for all zone control planes in the same zone.

Add `--set {{set_flag_values_prefix}}egress.enabled=true` to list of arguments if you want to deploy optional [Zone Egress](/docs/{{ page.version }}/production/cp-deployment/zoneegress/).
Add `--set {{site.set_flag_values_prefix}}egress.enabled=true` to list of arguments if you want to deploy optional [Zone Egress](/docs/{{ page.version }}/production/cp-deployment/zoneegress/).

Check warning on line 257 in app/_src/production/cp-deployment/multi-zone.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "app/_src/production/cp-deployment/multi-zone.md", "range": {"start": {"line": 257, "column": 133}}}, "severity": "INFO"}

{% if_version gte:2.3.x %}
`--set {{set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true` is required because the default global control plane's certificate is self-signed.
`--set {{site.set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true` is required because the default global control plane's certificate is self-signed.

Check warning on line 260 in app/_src/production/cp-deployment/multi-zone.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is required').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is required').", "location": {"path": "app/_src/production/cp-deployment/multi-zone.md", "range": {"start": {"line": 260, "column": 91}}}, "severity": "INFO"}
It is recommended to use a certificate signed by a trusted CA in production. See [Secure access across services](/docs/{{ page.version }}/production/secure-deployment/certificates/) page for more information.
{% endif_version %}

Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/cp-deployment/zone-ingress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Zone Ingress without `advertisedAddress` and `advertisedPort` is not taken into

{% tabs usage useUrlFragment=false %}
{% tab usage Kubernetes %}
To install `ZoneIngress` in Kubernetes when doing `kumactl install control-plane` use the `--ingress-enabled`. If using helm add `{{set_flag_values_prefix}}ingress.enabled: true` to your `values.yaml`.
To install `ZoneIngress` in Kubernetes when doing `kumactl install control-plane` use the `--ingress-enabled`. If using helm add `{{site.set_flag_values_prefix}}ingress.enabled: true` to your `values.yaml`.

{{site.mesh_product_name}} will set `advertisedAddress` and `advertisedPort` automatically by checking the Service associated with this Zone Ingress.

Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/cp-deployment/zoneegress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The `ZoneEgress` entity includes a few sections:

{% tabs usage useUrlFragment=false %}
{% tab usage Kubernetes %}
To install `ZoneEgress` in Kubernetes when doing `kumactl install control-plane` use the `--egress-enabled`. If using helm add `{{set_flag_values_prefix}}egress.enabled: true` to your `values.yaml`.
To install `ZoneEgress` in Kubernetes when doing `kumactl install control-plane` use the `--egress-enabled`. If using helm add `{{site.set_flag_values_prefix}}egress.enabled: true` to your `values.yaml`.

{% endtab %}
{% tab usage Universal %}
Expand Down
Loading
Loading