Skip to content

Commit

Permalink
fix: always put ( closed to link when doing conditional rendering (#1414
Browse files Browse the repository at this point in the history
)

Some plugin down in docs.konghq.com gets upset otherwise

Signed-off-by: Charly Molter <[email protected]>
  • Loading branch information
lahabana committed Jul 12, 2023
1 parent bb519b5 commit f991c1e
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion app/_src/introduction/how-kuma-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ By reducing the code that our teams create and maintain, we can modernize our ap
Out of the box, {{site.mesh_product_name}} ships with a bundled [Envoy](https://www.envoyproxy.io/) data plane proxy ready to use for our services, so that you don't have to worry about putting all the pieces together.

{% tip %}
{{site.mesh_product_name}} ships with an executable `kuma-dp` that executes the bundled `envoy` executable to create the data plane proxy. For details, see the [Overview]({%if_version lte:2.1.x %}/docs/{{ page.version }}/introduction/what-is-kuma{%endif_version%}{%if_version gte:2.2.x %}/docs/{{ page.version }}/introduction/overview-of-kuma{%endif_version%}).
{{site.mesh_product_name}} ships with an executable `kuma-dp` that executes the bundled `envoy` executable to create the data plane proxy. For details, see the [Overview]{%if_version lte:2.1.x %}(/docs/{{ page.version }}/introduction/what-is-kuma){%endif_version%}{%if_version gte:2.2.x %}(/docs/{{ page.version }}/introduction/overview-of-kuma){%endif_version%}.
{% endtip %}

[Install {{site.mesh_product_name}}](/install/) and follow the instructions to get up and running in a few steps.
Expand Down
2 changes: 1 addition & 1 deletion app/_src/networking/service-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The connection between the data-planes and the control-plane is not on the execu
While doing so, the data-planes also advertise the IP address of each service. The IP address is retrieved:

* On Kubernetes by looking at the address of the `Pod`.
* On Universal by looking at the inbound listeners that have been configured in the [`inbound` property]({%if_version lte:2.1.x %}/docs/{{ page.version }}/explore/dpp-on-universal/{%endif_version%}{%if_version gte:2.2.x %}/docs/{{ page.version }}/production/dp-config/dpp-on-universal#dataplane-configuration{%endif_version%}) of the data-plane specification.
* On Universal by looking at the inbound listeners that have been configured in the [`inbound` property]{%if_version lte:2.1.x %}(/docs/{{ page.version }}/explore/dpp-on-universal/){%endif_version%}{%if_version gte:2.2.x %}(/docs/{{ page.version }}/production/dp-config/dpp-on-universal#dataplane-configuration){%endif_version%} of the data-plane specification.

The IP address that's being advertised by every data-plane to the control-plane is also being used to route service traffic from one `kuma-dp` to another `kuma-dp`. This means that {{site.mesh_product_name}} knows at any given time what are all the IP addresses associated to every replica of every service. Another use-case where the IP address of the data-planes is being used is for metrics scraping by Prometheus.

Expand Down
20 changes: 10 additions & 10 deletions app/_src/production/cp-deployment/multi-zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,16 @@ The global control plane on Kubernetes must reside on its own Kubernetes cluster
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:
1. Find the external IP and port of the `global-remote-sync` service in the `{{site.mesh_namespace}}` namespace:

```sh
kubectl get services -n {{site.mesh_namespace}}
NAMESPACE NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
{{site.mesh_namespace}} global-remote-sync LoadBalancer 10.105.9.10 35.226.196.103 5685:30685/TCP 89s
{{site.mesh_namespace}} {{site.mesh_cp_name}} ClusterIP 10.105.12.133 <none> 5681/TCP,443/TCP,5676/TCP,5677/TCP,5678/TCP,5679/TCP,5682/TCP,5653/UDP 90s
```
```sh
kubectl get services -n {{site.mesh_namespace}}
NAMESPACE NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
{{site.mesh_namespace}} global-remote-sync LoadBalancer 10.105.9.10 35.226.196.103 5685:30685/TCP 89s
{{site.mesh_namespace}} {{site.mesh_cp_name}} ClusterIP 10.105.12.133 <none> 5681/TCP,443/TCP,5676/TCP,5677/TCP,5678/TCP,5679/TCP,5682/TCP,5653/UDP 90s
```

By default, it's exposed on [port 5685]({% if_version lte:2.1.x %}/docs/{{ page.version }}/networking/networking{% endif_version %}{% if_version gte:2.2.x %}/docs/{{ page.version }}/production/use-mesh#control-plane-ports{% endif_version %}). In this example the value is `35.226.196.103:5685`. You pass this as the value of `<global-kds-address>` when you set up the zone control planes.
By default, it's exposed on [port 5685]{% if_version lte:2.1.x %}(/docs/{{ page.version }}/networking/networking){% endif_version %}{% if_version gte:2.2.x %}(/docs/{{ page.version }}/production/use-mesh#control-plane-ports){% endif_version %}. In this example the value is `35.226.196.103:5685`. You pass this as the value of `<global-kds-address>` when you set up the zone control planes.
{% endtab %}
Expand Down Expand Up @@ -216,7 +216,7 @@ You need the following values to pass to each zone control plane setup:

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

Add `--egress-enabled` to list of arguments if you want to deploy optional [Zone Egress]({% if_version lte:2.1.x %}/docs/{{ page.version }}/explore/zoneegress/{% endif_version %}{% if_version gte:2.2.x %}/docs/{{ page.version }}/production/cp-deployment/zoneegress/{% endif_version %}).
Add `--egress-enabled` to list of arguments if you want to deploy optional [Zone Egress]{% if_version lte:2.1.x %}(/docs/{{ page.version }}/explore/zoneegress/){% endif_version %}{% if_version gte:2.2.x %}(/docs/{{ page.version }}/production/cp-deployment/zoneegress/){% endif_version %}.

{% if_version gte:2.3.x %}
`--set {{site.set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true` is required because the default global control plane's certificate is self-signed.
Expand Down Expand Up @@ -254,7 +254,7 @@ You need the following values to pass to each zone control plane setup:
where `controlPlane.zone` is the same value for all zone control planes in the same zone.
Add `--set {{site.set_flag_values_prefix}}egress.enabled=true` to list of arguments if you want to deploy optional [Zone Egress]({% if_version lte:2.1.x %}/docs/{{ page.version }}/explore/zoneegress/{% endif_version %}{% if_version gte:2.2.x %}/docs/{{ page.version }}/production/cp-deployment/zoneegress/{% endif_version %}).
Add `--set {{site.set_flag_values_prefix}}egress.enabled=true` to list of arguments if you want to deploy optional [Zone Egress]{% if_version lte:2.1.x %}(/docs/{{ page.version }}/explore/zoneegress/){% endif_version %}{% if_version gte:2.2.x %}(/docs/{{ page.version }}/production/cp-deployment/zoneegress/){% endif_version %}.
{% if_version gte:2.3.x %}
`--set {{site.set_flag_values_prefix}}controlPlane.tls.kdsZoneClient.skipVerify=true` is required because the default global control plane's certificate is self-signed.
Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/dp-config/transparent-proxying.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ All incoming and outgoing traffic is automatically intercepted by `kuma-dp` with

## Universal

On **Universal** `kuma-dp` leverages the [data plane proxy specification]({%if_version lte:2.1.x %}/docs/{{ page.version }}/explore/dpp-on-universal/{%endif_version%}{%if_version gte:2.2.x %}/docs/{{ page.version }}/production/dp-config/dpp-on-universal#dataplane-configuration{%endif_version%}) associated to it for receiving incoming requests on a pre-defined port.
On **Universal** `kuma-dp` leverages the [data plane proxy specification]{%if_version lte:2.1.x %}(/docs/{{ page.version }}/explore/dpp-on-universal/){%endif_version%}{%if_version gte:2.2.x %}(/docs/{{ page.version }}/production/dp-config/dpp-on-universal#dataplane-configuration){%endif_version%} associated to it for receiving incoming requests on a pre-defined port.

There are several advantages for using transparent proxying in universal mode:

Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/mesh.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ kuma-dp run \
{% endtab %}
{% endtabs %}

You can control which data plane proxies are allowed to join the mesh using [mesh constraints]({% if_version gte:2.2.x %}/docs/{{ page.version }}/production/secure-deployment/dp-membership/{% endif_version %}{% if_version lte:2.1.x %}/docs/{{ page.version }}/security/dp-membership/{% endif_version %}).
You can control which data plane proxies are allowed to join the mesh using [mesh constraints]{% if_version gte:2.2.x %}(/docs/{{ page.version }}/production/secure-deployment/dp-membership/){% endif_version %}{% if_version lte:2.1.x %}(/docs/{{ page.version }}/security/dp-membership/){% endif_version %}.

#### Policies

Expand Down
2 changes: 1 addition & 1 deletion app/_src/production/secure-deployment/api-server-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Authentication with the API server
content_type: how-to
---

{{site.mesh_product_name}} exposes API server on [ports]({% if_version lte:2.1.x %}/docs/{{ page.version }}/networking/networking{% endif_version %}{% if_version gte:2.2.x %}/docs/{{ page.version }}/production/use-mesh#control-plane-ports{% endif_version %}) `5681` and `5682` (protected by TLS).
{{site.mesh_product_name}} exposes API server on [ports]{% if_version lte:2.1.x %}(/docs/{{ page.version }}/networking/networking){% endif_version %}{% if_version gte:2.2.x %}(/docs/{{ page.version }}/production/use-mesh#control-plane-ports){% endif_version %} `5681` and `5682` (protected by TLS).

An authenticated user can be authorized to execute administrative actions such as
* Managing administrative resources like {{site.mesh_product_name}} Secrets on Universal
Expand Down

0 comments on commit f991c1e

Please sign in to comment.