-
Notifications
You must be signed in to change notification settings - Fork 595
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(mesh): add prod usage helm values (#7640)
* docs(mesh): add document for production usage helm values * docs(mesh): read values files from embeded and versioned files --------- Signed-off-by: Jay Chen <[email protected]> Co-authored-by: lena-larionova <[email protected]>
- Loading branch information
1 parent
87695b0
commit 8df5693
Showing
3 changed files
with
74 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
app/_src/mesh/production/cp-deployment/production-usage-values.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: Deploy Kong Mesh in Production with Helm | ||
--- | ||
|
||
To install a production-ready {{site.mesh_product_name}}, you must ensure that the service mesh is secure, reliable, and performant. When deploying {{site.mesh_product_name}} on Kubernetes, use the provided values here to deploy your {{site.mesh_product_name}} installation. | ||
|
||
Instructions on this page are meant to be the starting point for your installation. It's always recommended to read the full [Helm configuration reference](/mesh/{{ page.release }}/reference/kuma-cp/#helm-valuesyaml) to find support for other options available before executing the install steps. Values provided here will override values in the default reference Helm configuration, and they may be overridden again by further `values.yaml` files or arguments of the `helm` command. See the [Helm documentation](https://helm.sh/docs/chart_template_guide/values_files/) to learn more about how values are calculated. | ||
|
||
Values on this page may reference resources that need to be created in advance when certain features are enabled, read the file content carefully and prepare these resources according to the notes near the keywords `(action)`. If you decide to disable a feature that requires a pre-existing resource, remove or change those fields according to the full [Helm configuration reference](/mesh/{{ page.release }}/reference/kuma-cp/#helm-valuesyaml). | ||
|
||
|
||
{% navtabs %} | ||
{% navtab Single zone control plane %} | ||
|
||
Install a single zone control plane: | ||
|
||
```sh | ||
helm install {{ site.mesh_helm_install_name }} {{ site.mesh_helm_repo }} --namespace {{site.mesh_namespace}} -f ./values.single-zone-cp.yaml | ||
``` | ||
|
||
Suggested `values.yaml` file: | ||
|
||
```yaml | ||
{% embed helm-values-prod/values.single-zone-cp.yaml versioned %} | ||
``` | ||
|
||
{% endnavtab %} | ||
{% navtab Multi-zone global control plane %} | ||
|
||
Install the global control plane for a multi-zone deployment: | ||
|
||
```sh | ||
helm install {{ site.mesh_helm_install_name }} {{ site.mesh_helm_repo }} --namespace {{site.mesh_namespace}} -f ./values.global-cp.yaml | ||
``` | ||
|
||
Suggested `values.yaml` file: | ||
|
||
```yaml | ||
{% embed helm-values-prod/values.global-cp.yaml versioned %} | ||
``` | ||
|
||
The values on this page may reference resources that need to be created in advance when certain features are enabled, read the file content carefully and prepare these resources according to the notes near the keywords `(action)`. If you decide to disable a feature that requires a pre-existing resource, remove or change those fields according to the full [Helm configuration reference](/mesh/{{ page.release }}/reference/kuma-cp/#helm-valuesyaml). | ||
|
||
{% endnavtab %} | ||
|
||
{% navtab Multi-zone federated zone control planes %} | ||
|
||
Install federated zone control planes for a multi-zone deployment: | ||
|
||
```sh | ||
helm install {{ site.mesh_helm_install_name }} {{ site.mesh_helm_repo }} --namespace {{site.mesh_namespace}} -f ./values.federated-zone-cp.yaml \ | ||
--set '{{site.set_flag_values_prefix}}controlPlane.zone=zone-prod' \ | ||
--set '{{site.set_flag_values_prefix}}controlPlane.kdsGlobalAddress=kds-global.example.com' | ||
``` | ||
|
||
Suggested `values.yaml` file: | ||
|
||
```yaml | ||
{% embed helm-values-prod/values.federated-zone-cp.yaml versioned %} | ||
``` | ||
|
||
The values on this page may reference resources that need to be created in advance when certain features are enabled, read the file content carefully and prepare these resources according to the notes near the keywords `(action)`. If you decide to disable a feature that requires a pre-existing resource, remove or change those fields according to the full [Helm configuration reference](/mesh/{{ page.release }}/reference/kuma-cp/#helm-valuesyaml). | ||
{% endnavtab %} | ||
{% endnavtabs %} |