Skip to content

Commit

Permalink
chore: add missing inline:true to if_versions + fix one more link
Browse files Browse the repository at this point in the history
Signed-off-by: Bart Smykla <[email protected]>
  • Loading branch information
bartsmykla committed Nov 5, 2024
1 parent 7edba32 commit 62672e2
Show file tree
Hide file tree
Showing 14 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion app/_src/introduction/kuma-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ To see if you may need to increase your control-plane's spec, there are two main
- propagation time (xds_delivery): this is the time it takes between a change in the mesh and the dataplane receiving its updated configuration. Think about it as the "reactivity of your mesh".
- configuration generation time (xds_generation): this is the time it takes for the configuration to be generated.

For any large mesh using transparent-proxy it's highly recommended to use [reachable-services](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying#{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/#{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/{% endif_version %}reachable-services).
For any large mesh using transparent-proxy it's highly recommended to use [reachable services](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying#{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/#{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/{% endif_version %}reachable-services).

You can also find tuning configuration in the {% if_version lte:2.1.x %}[fine-tuning](/docs/{{ page.version }}/documentation/fine-tuning){% endif_version %}{% if_version gte:2.2.x %}[fine-tuning](/docs/{{ page.version }}/production/upgrades-tuning/fine-tuning/){% endif_version %} section of the docs.

Expand Down
2 changes: 1 addition & 1 deletion app/_src/networking/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: DNS

{{site.mesh_product_name}} ships with DNS resolver to provide service naming - a mapping of hostname to Virtual IPs (VIPs) of services registered in {{site.mesh_product_name}}.

The usage of {{site.mesh_product_name}} DNS is only relevant when [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %}) is used.
The usage of {{site.mesh_product_name}} DNS is only relevant when [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %}) is used.

## How it works

Expand Down
2 changes: 1 addition & 1 deletion app/_src/networking/non-mesh-traffic.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If you want to allow external clients to consume mesh services see
the [Permissive mTLS](/docs/{{ page.version }}/policies/mutual-tls/#permissive-mtls) mode.

{% warning %}
Without [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %})
Without [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %})
TLS check on Envoy can be bypassed. You should take action to secure the application ports.
{% endwarning %}

Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/external-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ networking:

Then apply the configuration with `kumactl apply -f [..]` or with the [HTTP API](/docs/{{ page.version }}/reference/http-api).

{% capture tproxy-link %}/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version%}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version%}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version%}{% endcapture %}
{% capture tproxy-link %}/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version%}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version%}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version%}{% endcapture %}

Universal mode is best combined with [transparent proxy]({{ tproxy-link }}). For backward compatibility only, you can consume an external service from within the mesh by filling the proper `outbound` section of the relevant data plane resource:

Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/meshpassthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To learn more about the information in this table, see the [matching docs](/docs
## Configuration

{% warning %}
This policy doesn't work with sidecars without [transparent proxy](/docs/{{ page.version }}/{% if_version lte:2.8.x %}networking/transparent-proxying/#what-is-transparent-proxying{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %}).
This policy doesn't work with sidecars without [transparent proxy](/docs/{{ page.version }}/{% if_version lte:2.8.x inline:true %}networking/transparent-proxying/#what-is-transparent-proxying{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %}).
{% endwarning %}

The following describes the default configuration settings of the `MeshPassthrough` policy:
Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/traffic-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The `TrafficPermission` policy can also be used to restrict traffic to [services

### Prerequisites

* {{site.mesh_product_name}} deployed with [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %})
* {{site.mesh_product_name}} deployed with [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %})
* `Mesh` configured to {% if_version lte:2.1.x %}[disable passthrough mode](/docs/{{ page.version }}/policies/mesh/#usage){% endif_version %}{% if_version gte:2.2.x %}[disable passthrough mode](/docs/{{ page.version }}/production/mesh/#usage){% endif_version %}

These settings lock down traffic to and from the mesh, which means that requests to any unknown destination are not allowed. The mesh can't rely on mTLS, because there is no data plane proxy on the destination side.
Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/virtual-outbound.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ produce the hostname: `v1.backend.mesh` with port: `1800`.

Additional Requirements:

- [Transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %}) must be enabled.
- [Transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %}) must be enabled.
- Either:
- [Data plane proxy DNS](/docs/{{ page.version }}/networking/dns) must be enabled.
- Or, the value of `conf.host` must end with the value of `dns_server.domain`, which defaults to `.mesh`.
Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/cp-deployment/multi-zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ outbound:
From the data plane running you will now be able to reach the service using `localhost:20012`.

Alternatively, if you configure [transparent proxy](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %}) you can just call `echo-server_echo-example_svc_1010.mesh` without defining an `outbound` section.
Alternatively, if you configure [transparent proxy](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %}) you can just call `echo-server_echo-example_svc_1010.mesh` without defining an `outbound` section.

{% endtab %}
{% endtabs %}
Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/deployment/multi-zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ You can also favor local service instances with {% if_version lte:2.5.x %}[local

In the presence of a {% if_version lte:2.1.x %}[zone egress](/docs/{{ page.version }}/explore/zoneegress){% endif_version %}{% if_version gte:2.2.x %}[zone egress](/docs/{{ page.version }}/production/cp-deployment/zoneegress/){% endif_version %}, the traffic is routed through the local zone egress before being sent to the remote zone ingress.

When using [transparent proxy](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %}) (default in Kubernetes),
When using [transparent proxy](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %}) (default in Kubernetes),
{{site.mesh_product_name}} generates a VIP,
a DNS entry with the format `<kuma.io/service>.mesh`, and will listen for traffic on port 80. The `<kuma.io/service>.mesh:80` format is just a convention.
[`VirtualOutbounds`](/docs/{{ page.version }}/policies/virtual-outbound)s enable you to customize the listening port and how the DNS name for these services looks.
Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/dp-config/cni.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ content_type: how-to

In order for traffic to flow through the {{site.mesh_product_name}} data plane, all inbound and
outbound traffic for a service needs to go through its data plane proxy.
The recommended way of accomplishing this is via [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %}).
The recommended way of accomplishing this is via [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %}).

On Kubernetes it's handled automatically by default with the
`initContainer` `kuma-init`, but this container requires certain privileges.
Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/dp-config/dpp-on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ On Kubernetes the {% if_version lte:2.1.x %}[`Dataplane`](/docs/{{ page.version

The {{ site.mesh_product_name }} control plane injects a `kuma-sidecar` container into your `Pod`'s container. If
you're not using the CNI, it also injects a `kuma-init` into `initContainers` to
setup [transparent proxying](../transparent-proxying).
setup [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version%}{% if_version gte:2.9.x inline:true %}/networking/transparent-proxy/introduction/{% endif_version%}).

You can control whether {{site.mesh_product_name}} automatically injects the data plane proxy by **labeling** either the Namespace or the Pod with
`kuma.io/sidecar-injection=enabled`, e.g.
Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/dp-config/dpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ A service is a group of all DPP inbounds that have the same `kuma.io/service` ta

### Outbounds
An outbound allows the workload to consume a service in the mesh using a local port.
This is only useful when not using [transparent proxy](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %}).
This is only useful when not using [transparent proxy](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %}).

## `Dataplane` entity

Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/upgrades-tuning/fine-tuning.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ By default, with the transparent proxy enabled, each data plane proxy follows al
* Smaller configurations reduce network bandwidth.
* Envoy manages fewer clusters/listeners, reducing statistics and memory usage.
^
See [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x %}production/dp-config/transparent-proxying/#reachable-services{% endif_version %}) for configuration details.{% endif_version %}
See [transparent proxying](/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x inline:true %}production/dp-config/transparent-proxying/#reachable-services{% endif_version %}) for configuration details.{% endif_version %}

{% if_version gte:2.9.x %}
For more details, including how to configure reachable services, refer to the [Reachable Services](/docs/{{ page.version }}/networking/transparent-proxy/reachable-services/) documentation.
Expand Down
4 changes: 2 additions & 2 deletions app/_src/reference/kubernetes-annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ spec:

### `kuma.io/transparent-proxying-reachable-services`

{% capture reachable-services-docs-link %}/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying#{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/#{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/{% endif_version %}reachable-services{% endcapture %}
{% capture reachable-services-docs-link %}/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying#{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/#{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/{% endif_version %}reachable-services{% endcapture %}

A comma separated list of `kuma.io/service` to indicate which services this communicates with.
For more details see the [reachable services docs]({{ reachable-services-docs-link }}).
Expand Down Expand Up @@ -578,7 +578,7 @@ spec:
When transparent proxy is installed with eBPF mode, you can disable it for particular workloads if necessary.

<!-- vale Vale.Terms = NO -->
{% capture tproxy-ebpf-link %}/docs/{{ page.version }}/{% if_version lte:2.1.x %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x %}networking/transparent-proxy/introduction/{% endif_version %}#transparent-proxy-with-ebpf-experimental{% endcapture %}
{% capture tproxy-ebpf-link %}/docs/{{ page.version }}/{% if_version lte:2.1.x inline:true %}networking/transparent-proxying/{% endif_version %}{% if_version gte:2.2.x lte:2.8.x inline:true %}production/dp-config/transparent-proxying/{% endif_version %}{% if_version gte:2.9.x inline:true %}networking/transparent-proxy/introduction/{% endif_version %}#transparent-proxy-with-ebpf-experimental{% endcapture %}
<!-- vale Vale.Terms = YES -->

For more details see the [transparent proxying with eBPF docs]({{ tproxy-ebpf-link }}).
Expand Down

0 comments on commit 62672e2

Please sign in to comment.