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

feat(kuma-cp): added docs for tls prom secured #1438

Merged
merged 14 commits into from
Aug 28, 2023
2 changes: 2 additions & 0 deletions .github/styles/Vocab/Base/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ deduplicat(:?e|ion)
degraphql
denylist
dev
disabled
DNS
eBPF
EKS|eks
Expand Down Expand Up @@ -130,6 +131,7 @@ targetRef
tbl
tcpdump
TLS
tls
transcoder
ttl
txt
Expand Down
5 changes: 4 additions & 1 deletion app/_src/explore/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@
There are 2 ways you can run prometheus:

1. Inside the mesh (default for [`kumactl install observability`](#demo-setup)). In this case you can use mTLS to retrieve the metrics. This provides high security but will require one prometheus per mesh and might not be accessible if your mesh becomes unavailable. It will also require one Prometheus deployment per {{site.mesh_product_name}} mesh.
2. Outside the mesh. In this case you'll need to specify `skipMTLS: true` in the [traffic metrics configuration](/docs/{{ page.version }}/policies/traffic-metrics). This is less secured but will ensure Prometheus is as available as possible. It is also easier to add to an existing setup with services in and outside the mesh.
2. Outside the mesh. In this case you'll need to specify {% if_version lte:2.3.x %}`skipMTLS: true`{% endif_version %}{% if_version gte:2.4.x %}`tls.mode: disabled`{% endif_version %} in the [traffic metrics configuration](/docs/{{ page.version }}/policies/traffic-metrics). This is less secure but ensures Prometheus is as available as possible. It's also easier to add to an existing setup with services in and outside the mesh.

Check warning on line 48 in app/_src/explore/observability.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/explore/observability.md", "range": {"start": {"line": 48, "column": 223}}}, "severity": "INFO"}
{% if_version gte:2.4.x %}
3. Outside the mesh with TLS enabled. In this case you'll need to provide certificates for each dataplane and specify configuration in the [traffic metrics configuration](/docs/{{ page.version }}/policies/traffic-metrics#secure-metrics-with-tls). This is more secure than second option but requires more configuration.
{% endif_version %}

In production, we recommend the second option as it provides better visibility when things go wrong, and it's usually acceptable for metrics to be less secure.
{% endtip %}
Expand Down
Loading
Loading