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(templating): fix mesh product name templating #1380

Merged
merged 1 commit into from
Jun 23, 2023
Merged

fix(templating): fix mesh product name templating #1380

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
2 changes: 1 addition & 1 deletion app/_src/documentation/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 controlPlace.config=cp-conf.yaml
helm install {{ site.mesh_helm_install_name }} {{ site.mesh_helm_repo }} --set-file {{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 @@ -43,7 +43,7 @@ Gateway API [`Gateways`](https://gateway-api.sigs.k8s.io/api-types/gateway/) are
The `Gateway` resource represents the proxy instance that handles traffic for a set of Gateway API routes.

Every `Gateway` refers to a [`GatewayClass`](https://gateway-api.sigs.k8s.io/api-types/gatewayclass/).
The `GatewayClass` represents the class of `Gateway`, in this case Kuma's builtin edge
The `GatewayClass` represents the class of `Gateway`, in this case {{site.mesh_product_name}}'s builtin edge
gateway, and points to a controller that should manage these `Gateways`. It can also hold
[additional configuration](#customization).

Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/how-kuma-chooses-the-right-policy-to-apply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ conf:
backend: splunk
```

What does `Kuma` do when it encounters multiple matching policies?
What does {{site.mesh_product_name}} do when it encounters multiple matching policies?

## General rules

Expand Down
4 changes: 2 additions & 2 deletions app/_src/policies/meshloadbalancingstrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ kind: MeshLoadBalancingStrategy
apiVersion: kuma.io/v1alpha1
metadata:
name: ring-hash
namespace: kuma-system
namespace: {{site.mesh_namespace}}
labels:
kuma.io/mesh: mesh-1
spec:
Expand Down Expand Up @@ -196,7 +196,7 @@ kind: MeshLoadBalancingStrategy
apiVersion: kuma.io/v1alpha1
metadata:
name: disable-la-to-backend
namespace: kuma-system
namespace: {{site.mesh_namespace}}
labels:
kuma.io/mesh: mesh-1
spec:
Expand Down
4 changes: 2 additions & 2 deletions app/_src/policies/protocol-support-in-kuma.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Protocol support in Kuma
---

At its core, `Kuma` distinguishes between the following major categories of traffic: `http`, `grpc`, `kafka` and opaque `tcp` traffic.
At its core, {{site.mesh_product_name}} distinguishes between the following major categories of traffic: `http`, `grpc`, `kafka` and opaque `tcp` traffic.

For `http`, `grpc` and `kafka` traffic {{site.mesh_product_name}} provides deep insights down to application-level transactions, in the latter `tcp` case the observability is limited to connection-level statistics.

Expand Down Expand Up @@ -96,7 +96,7 @@

{{site.mesh_product_name}} out of the box support's `Websocket` protocol. The service exposing `Websocket` should be marked as `tcp`.

As `Websockets` use pure `TCP` connections under the hood, your service have to be recognised by `Kuma` as the `TCP` one. It's also the default behavior for {{site.mesh_product_name}} to assume the service's `inbound` interfaces are the TCP ones, so you don't have to do anything, but if you want to be explicit, you can configure your services exposing `Websocket` endpoints with `appProtocol` property. I.e.:
As `Websockets` use pure `TCP` connections under the hood, your service have to be recognised by {{site.mesh_product_name}} as the `TCP` one. It's also the default behavior for {{site.mesh_product_name}} to assume the service's `inbound` interfaces are the TCP ones, so you don't have to do anything, but if you want to be explicit, you can configure your services exposing `Websocket` endpoints with `appProtocol` property. I.e.:

Check warning on line 99 in app/_src/policies/protocol-support-in-kuma.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 ('be recognised').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be recognised').", "location": {"path": "app/_src/policies/protocol-support-in-kuma.md", "range": {"start": {"line": 99, "column": 81}}}, "severity": "INFO"}

Check warning on line 99 in app/_src/policies/protocol-support-in-kuma.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Google.Spelling] In general, use American spelling instead of 'recognised'.

Raw Output:
{"message": "[Google.Spelling] In general, use American spelling instead of 'recognised'.", "location": {"path": "app/_src/policies/protocol-support-in-kuma.md", "range": {"start": {"line": 99, "column": 84}}}, "severity": "WARNING"}

{% tabs websocket-support useUrlFragment=false %}
{% tab websocket-support Kubernetes %}
Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/traffic-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
{{site.mesh_product_name}} provides full integration with Prometheus:

* Each proxy can expose its metrics in [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format).
* Because metrics are part of the mesh configuration, Kuma exposes an API called the monitoring assignment service (MADS) which exposes every proxy in the mesh.
* Because metrics are part of the mesh configuration, {{site.mesh_product_name}} exposes an API called the monitoring assignment service (MADS) which exposes every proxy in the mesh.

Check warning on line 12 in app/_src/policies/traffic-metrics.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/policies/traffic-metrics.md", "range": {"start": {"line": 12, "column": 138}}}, "severity": "INFO"}

Check warning on line 12 in app/_src/policies/traffic-metrics.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'MADS', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'MADS', if it's unfamiliar to the audience.", "location": {"path": "app/_src/policies/traffic-metrics.md", "range": {"start": {"line": 12, "column": 139}}}, "severity": "INFO"}

To collect metrics from {{site.mesh_product_name}}, you need to expose metrics from proxies and applications.

Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/dp-config/cni.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@
{% tab insallation OpenShift 3.11 %}

1. Follow the instructions in [OpenShift 3.11 installation](/docs/{{ page.version }}/installation/openshift/#2-run-kuma)
to get the `MutatingAdmissionWebhook` and `ValidatingAdmissionWebhook` enabled (this is required for regular kuma installation).
to get the `MutatingAdmissionWebhook` and `ValidatingAdmissionWebhook` enabled (this is required for regular {{site.mesh_product_name}} installation).

Check warning on line 223 in app/_src/production/dp-config/cni.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/dp-config/cni.md", "range": {"start": {"line": 223, "column": 83}}}, "severity": "INFO"}

Check warning on line 223 in app/_src/production/dp-config/cni.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/dp-config/cni.md", "range": {"start": {"line": 223, "column": 89}}}, "severity": "INFO"}

2. You need to grant privileged permission to kuma-cni service account:

Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/upgrades-tuning/fine-tuning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Follow the {% if_version lte:2.1.x %}[transparent proxying](/docs/{{ page.versio

## Postgres

If you choose `Postgres` as a configuration store for `Kuma` on Universal,
If you choose `Postgres` as a configuration store for {{site.mesh_product_name}} on Universal,
please be aware of the following key settings that affect performance of {{site.mesh_product_name}} Control Plane.

* `KUMA_STORE_POSTGRES_CONNECTION_TIMEOUT` : connection timeout to the Postgres database (default: 5s)
Expand Down
4 changes: 2 additions & 2 deletions app/docs/1.2.x/documentation/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* `kuma-dp`: this is the Kuma data plane proxy executable that - under the hood - invokes `envoy`.
* `envoy`: this is the Envoy executable that we bundle for convenience into the archive.
* `kumactl`: this is the the user CLI to interact with Kuma (`kuma-cp`) and its data.
* `kuma-prometheus-sd`: this is a helper tool that enables native integration between `Kuma` and `Prometheus`. Thanks to it, `Prometheus` will be able to automatically find all dataplanes in your Mesh and scrape metrics out of them.
* `kuma-prometheus-sd`: this is a helper tool that enables native integration between {{site.mesh_product_name}} and `Prometheus`. Thanks to it, `Prometheus` will be able to automatically find all dataplanes in your Mesh and scrape metrics out of them.

Check warning on line 11 in app/docs/1.2.x/documentation/cli.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "app/docs/1.2.x/documentation/cli.md", "range": {"start": {"line": 11, "column": 159}}}, "severity": "WARNING"}
* `kuma-tcp-echo`: this is a sample application that echos back the requests we are making, used for demo purposes.

According to the [installation instructions](/install/), some of these executables are automatically executed as part of the installation workflow, while some other times you will have to execute them directly.
Expand Down Expand Up @@ -52,4 +52,4 @@
* `kumactl generate tls-certificate`: used to generate a TLS certificate for client or server.
* `kumactl manage ca [..]`: used to manage certificate authorities.
* `kumactl help [..]`: help dialog that explains the commands available.
* `kumactl version [--detailed]`: shows the version of the program.
* `kumactl version [--detailed]`: shows the version of the program.
2 changes: 1 addition & 1 deletion app/docs/1.2.x/documentation/dps-and-data-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
* you can turn `Envoy Admin API` off by using `--admin-port=`

{% warning %}
If you choose to turn `Envoy Admin API` off, you will not be able to leverage some of `Kuma` features, such as enabling `Prometheus` metrics on that dataplane.
If you choose to turn `Envoy Admin API` off, you will not be able to leverage some of {{site.mesh_product_name}} features, such as enabling `Prometheus` metrics on that dataplane.

Check warning on line 120 in app/docs/1.2.x/documentation/dps-and-data-model.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Google.Contractions] Use 'won't' instead of 'will not'.

Raw Output:
{"message": "[Google.Contractions] Use 'won't' instead of 'will not'.", "location": {"path": "app/docs/1.2.x/documentation/dps-and-data-model.md", "range": {"start": {"line": 120, "column": 50}}}, "severity": "INFO"}

Check warning on line 120 in app/docs/1.2.x/documentation/dps-and-data-model.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "app/docs/1.2.x/documentation/dps-and-data-model.md", "range": {"start": {"line": 120, "column": 50}}}, "severity": "WARNING"}
{% endwarning %}

## Tags
Expand Down
4 changes: 2 additions & 2 deletions app/docs/1.2.x/documentation/fine-tuning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Postgres

If you choose `Postgres` as a configuration store for `Kuma` on Universal,
If you choose `Postgres` as a configuration store for {{site.mesh_product_name}} on Universal,
please be aware of the following key settings that affect performance of Kuma Control Plane.

* `KUMA_STORE_POSTGRES_CONNECTION_TIMEOUT` : connection timeout to the Postgres database (default: 5s)
Expand Down Expand Up @@ -78,4 +78,4 @@

{% warning %}
After a successful debugging session, please remember to turn off the debugging endpoints since anybody could execute heap dumps on them potentially exposing sensitive data.
{% endwarning %}
{% endwarning %}

Check failure on line 81 in app/docs/1.2.x/documentation/fine-tuning.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'endwarning'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'endwarning'?", "location": {"path": "app/docs/1.2.x/documentation/fine-tuning.md", "range": {"start": {"line": 81, "column": 4}}}, "severity": "ERROR"}
2 changes: 1 addition & 1 deletion app/docs/1.2.x/documentation/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* `kuma-dp`: this is the Kuma data-plane executable that - under the hood - invokes `envoy`.
* `envoy`: this is the Envoy executable that we bundle for convenience into the archive.
* `kumactl`: this is the the user CLI to interact with Kuma (`kuma-cp`) and its data.
* `kuma-prometheus-sd`: this is a helper tool that enables native integration between `Kuma` and `Prometheus`. Thanks to it, `Prometheus` will be able to automatically find all dataplanes in your Mesh and scrape metrics out of them.
* `kuma-prometheus-sd`: this is a helper tool that enables native integration between {{site.mesh_product_name}} and `Prometheus`. Thanks to it, `Prometheus` will be able to automatically find all dataplanes in your Mesh and scrape metrics out of them.

Check warning on line 30 in app/docs/1.2.x/documentation/overview.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "app/docs/1.2.x/documentation/overview.md", "range": {"start": {"line": 30, "column": 159}}}, "severity": "WARNING"}
* `kuma-tcp-echo`: this is a sample application that echos back the requests we are making, used for demo purposes.

A minimal Kuma deployment involves one or more instances of the control-plane (`kuma-cp`), and one or more instances of the data-planes (`kuma-dp`) which will connect to the control-plane as soon as they startup. Kuma supports two modes:
Expand Down
6 changes: 3 additions & 3 deletions app/docs/1.2.x/policies/general-notes-about-kuma-policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: General notes about Kuma policies
---

You may have already noticed that most `Kuma` policies have very similar structure, namely
You may have already noticed that most {{site.mesh_product_name}} policies have very similar structure, namely

```yaml
sources:
Expand All @@ -25,7 +25,7 @@
* `destinations` - a list of selectors to match those `Dataplanes` where network traffic destined at
* `conf` - configuration to apply to network traffic between `sources` and `destinations`

To keep configuration model simple and consistent, `Kuma` assumes that every `Dataplane` represents a `service`, even if it's a cron job that doesn't normally handle incoming traffic.
To keep configuration model simple and consistent, {{site.mesh_product_name}} assumes that every `Dataplane` represents a `service`, even if it's a cron job that doesn't normally handle incoming traffic.

Check failure on line 28 in app/docs/1.2.x/policies/general-notes-about-kuma-policies.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'cron'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'cron'?", "location": {"path": "app/docs/1.2.x/policies/general-notes-about-kuma-policies.md", "range": {"start": {"line": 28, "column": 149}}}, "severity": "ERROR"}

Consequently, `service` tag is mandatory for `sources` and `destinations` selectors.

Expand Down Expand Up @@ -87,4 +87,4 @@
In some cases there is a fundamental technical cause for that (e.g., `TrafficRoute`), in other cases it's a simplification of the initial implementation (e.g., `TrafficLog` and `HealthCheck`).

Please let us know if such constraints become critical to your use case.
{% endwarning %}
{% endwarning %}

Check failure on line 90 in app/docs/1.2.x/policies/general-notes-about-kuma-policies.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'endwarning'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'endwarning'?", "location": {"path": "app/docs/1.2.x/policies/general-notes-about-kuma-policies.md", "range": {"start": {"line": 90, "column": 4}}}, "severity": "ERROR"}
2 changes: 1 addition & 1 deletion app/docs/1.2.x/policies/how-kuma-chooses-the-right-policy-to-apply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ conf:
backend: splunk
```

What does `Kuma` do when it encounters multiple matching policies?
What does {{site.mesh_product_name}} do when it encounters multiple matching policies?

## General rules

Expand Down
6 changes: 3 additions & 3 deletions app/docs/1.2.x/policies/protocol-support-in-kuma.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Protocol support in Kuma
---

At its core, `Kuma` distinguishes between the following major categories of traffic: `http`, `grpc`, `kafka` and opaque `tcp` traffic.
At its core, {{site.mesh_product_name}} distinguishes between the following major categories of traffic: `http`, `grpc`, `kafka` and opaque `tcp` traffic.

For `http`, `grpc` and `kafka` traffic Kuma provides deep insights down to application-level transactions, in the latter `tcp` case the observability is limited to connection-level statistics.

Expand Down Expand Up @@ -76,7 +76,7 @@

Kuma out of the box support's `Websocket` protocol. The service exposing `Websocket` should be annotated with `kuma.io/protocol: tcp` annotation

As `Websockets` use pure `TCP` connections under the hood, your service have to be recognised by `Kuma` as the `TCP` one. It's also the default behavior for Kuma to assume the service's `inbound` interfaces are the TCP ones, so you don't have to do anything, but if you want to be explicit, you can annotate your services exposing `Websocket` endpoints with `kuma.io/protocol: tcp` annotation. I.e.:
As `Websockets` use pure `TCP` connections under the hood, your service have to be recognised by {{site.mesh_product_name}} as the `TCP` one. It's also the default behavior for Kuma to assume the service's `inbound` interfaces are the TCP ones, so you don't have to do anything, but if you want to be explicit, you can annotate your services exposing `Websocket` endpoints with `kuma.io/protocol: tcp` annotation. I.e.:

{% tabs websocket-support useUrlFragment=false %}
{% tab websocket-support Kubernetes %}
Expand Down Expand Up @@ -111,4 +111,4 @@
kuma.io/protocol: tcp
```
{% endtab %}
{% endtabs %}
{% endtabs %}

Check failure on line 114 in app/docs/1.2.x/policies/protocol-support-in-kuma.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'endtabs'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'endtabs'?", "location": {"path": "app/docs/1.2.x/policies/protocol-support-in-kuma.md", "range": {"start": {"line": 114, "column": 4}}}, "severity": "ERROR"}
12 changes: 6 additions & 6 deletions app/docs/1.2.x/policies/traffic-log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[//]: # (The logs can be then forwarded to a collector that can further transmit them into systems like Splunk, ELK and Datadog.)

Configuring access logs in `Kuma` is a 3-step process:
Configuring access logs in {{site.mesh_product_name}} is a 3-step process:

* [1. Add a logging backend](#add-a-logging-backend)
* [2. Add a TrafficLog resource](#add-a-trafficlog-resource)
Expand All @@ -16,7 +16,7 @@

A _logging backend_ is essentially a sink for access logs.

In the current release of `Kuma`, a _logging backend_ can be either a _file_ or a _TCP log collector_, such as Logstash.
In the current release of {{site.mesh_product_name}}, a _logging backend_ can be either a _file_ or a _TCP log collector_, such as Logstash.

Check failure on line 19 in app/docs/1.2.x/policies/traffic-log.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Logstash'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Logstash'?", "location": {"path": "app/docs/1.2.x/policies/traffic-log.md", "range": {"start": {"line": 19, "column": 132}}}, "severity": "ERROR"}

{% tabs logging-backend useUrlFragment=false %}
{% tab logging-backend Kubernetes %}
Expand Down Expand Up @@ -158,7 +158,7 @@

## Log aggregation and visualisation

`Kuma` is presenting a simple solution to aggregate the **logs of your containers** and the **access logs of your data-planes**.
{{site.mesh_product_name}} is presenting a simple solution to aggregate the **logs of your containers** and the **access logs of your data-planes**.

{% tabs log-aggregation useUrlFragment=false %}
{% tab log-aggregation Kubernetes %}
Expand Down Expand Up @@ -250,7 +250,7 @@

### Access Log Format

`Kuma` gives you full control over the format of access logs.
{{site.mesh_product_name}} gives you full control over the format of access logs.

The shape of a single log record is defined by a template string that uses [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) to extract and format data about a `TCP` connection or an `HTTP` request.

Expand All @@ -265,7 +265,7 @@
A complete set of supported _command operators_ consists of:

1. All _command operators_ [supported by Envoy](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators)
2. _Command operators_ unique to `Kuma`
2. _Command operators_ unique to {{site.mesh_product_name}}

The latter include:

Expand All @@ -283,7 +283,7 @@

If a _command operator_ is specific to `HTTP` traffic, such as `%REQ(X?Y):Z%` or `%RESP(X?Y):Z%`, it will be replaced by a symbol "`-`" in case of `TCP` traffic.

Internally, `Kuma` [determines traffic protocol](/docs/{{ page.version }}/policies/protocol-support-in-kuma) based on the value of `kuma.io/protocol` tag on the `inbound` interface of a `destination` `Dataplane`.
Internally, {{site.mesh_product_name}} [determines traffic protocol](/docs/{{ page.version }}/policies/protocol-support-in-kuma) based on the value of `kuma.io/protocol` tag on the `inbound` interface of a `destination` `Dataplane`.

Check failure on line 286 in app/docs/1.2.x/policies/traffic-log.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Kuma' instead of 'kuma'.

Raw Output:
{"message": "[Vale.Terms] Use 'Kuma' instead of 'kuma'.", "location": {"path": "app/docs/1.2.x/policies/traffic-log.md", "range": {"start": {"line": 286, "column": 124}}}, "severity": "ERROR"}

The default format string for `TCP` traffic is:

Expand Down
2 changes: 1 addition & 1 deletion app/docs/1.2.x/policies/traffic-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ By default all available metrics are returned.

{% tabs override useUrlFragment=false %}
{% tab override Kubernetes %}
To override `Mesh`-wide defaults for a particular `Pod`, use `Kuma`-specific annotations:
To override `Mesh`-wide defaults for a particular `Pod`, use {{site.mesh_product_name}}-specific annotations:
* `prometheus.metrics.kuma.io/port` - to override `Mesh`-wide default port
* `prometheus.metrics.kuma.io/path` - to override `Mesh`-wide default path

Expand Down
4 changes: 2 additions & 2 deletions app/docs/1.3.x/documentation/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Kuma ships in a bundle that includes a few executables:
* `kuma-dp`: this is the Kuma data plane proxy executable that - under the hood - invokes `envoy`.
* `envoy`: this is the Envoy executable that we bundle for convenience into the archive.
* `kumactl`: this is the the user CLI to interact with Kuma (`kuma-cp`) and its data.
* `kuma-prometheus-sd`: this is a helper tool that enables native integration between `Kuma` and `Prometheus`. Thanks to it, `Prometheus` will be able to automatically find all dataplanes in your Mesh and scrape metrics out of them.
* `kuma-prometheus-sd`: this is a helper tool that enables native integration between {{site.mesh_product_name}} and `Prometheus`. Thanks to it, `Prometheus` will be able to automatically find all dataplanes in your Mesh and scrape metrics out of them.
* `kuma-tcp-echo`: this is a sample application that echos back the requests we are making, used for demo purposes.

According to the [installation instructions](/install/), some of these executables are automatically executed as part of the installation workflow, while some other times you will have to execute them directly.
Expand Down Expand Up @@ -52,4 +52,4 @@ Available commands on `kumactl` are:
* `kumactl generate tls-certificate`: used to generate a TLS certificate for client or server.
* `kumactl manage ca [..]`: used to manage certificate authorities.
* `kumactl help [..]`: help dialog that explains the commands available.
* `kumactl version [--detailed]`: shows the version of the program.
* `kumactl version [--detailed]`: shows the version of the program.
2 changes: 1 addition & 1 deletion app/docs/1.3.x/documentation/dps-and-data-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ E.g.,
* you can turn `Envoy Admin API` off by using `--admin-port=`

{% warning %}
If you choose to turn `Envoy Admin API` off, you will not be able to leverage some of `Kuma` features, such as enabling `Prometheus` metrics on that dataplane.
If you choose to turn `Envoy Admin API` off, you will not be able to leverage some of {{site.mesh_product_name}} features, such as enabling `Prometheus` metrics on that dataplane.
{% endwarning %}

## Tags
Expand Down
4 changes: 2 additions & 2 deletions app/docs/1.3.x/documentation/fine-tuning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Postgres

If you choose `Postgres` as a configuration store for `Kuma` on Universal,
If you choose `Postgres` as a configuration store for {{site.mesh_product_name}} on Universal,
please be aware of the following key settings that affect performance of Kuma Control Plane.

* `KUMA_STORE_POSTGRES_CONNECTION_TIMEOUT` : connection timeout to the Postgres database (default: 5s)
Expand Down Expand Up @@ -78,4 +78,4 @@

{% warning %}
After a successful debugging session, please remember to turn off the debugging endpoints since anybody could execute heap dumps on them potentially exposing sensitive data.
{% endwarning %}
{% endwarning %}

Check failure on line 81 in app/docs/1.3.x/documentation/fine-tuning.md

View workflow job for this annotation

GitHub Actions / Lint docs 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'endwarning'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'endwarning'?", "location": {"path": "app/docs/1.3.x/documentation/fine-tuning.md", "range": {"start": {"line": 81, "column": 4}}}, "severity": "ERROR"}
Loading
Loading