Skip to content

Commit

Permalink
chore: fix links to make them work well in docs.konghq.com (#1411)
Browse files Browse the repository at this point in the history
Also add the possibility to redact URLs from the page

Signed-off-by: Charly Molter <charly.molter@konghq.com>
  • Loading branch information
lahabana authored Jul 11, 2023
1 parent 614f1fd commit 56f4ba3
Show file tree
Hide file tree
Showing 29 changed files with 97 additions and 97 deletions.
2 changes: 1 addition & 1 deletion app/_src/explore/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Available commands on `kumactl` are:
* `kumactl help [..]`: help dialog that explains the commands available.
* `kumactl version [--detailed]`: shows the version of the program.

Checkout the [`kumactl` usage docs](/docs/{{ page.version }}/generated/cmd/kumactl/kumactl) for full documentation.
Just use `kumactl [cmd] --help` for documentation.

### Using variables

Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/general-notes-about-kuma-policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: General notes about Kuma policies

{% tip %}
This only applies to source/destination policies.
If you are unfamiliar with these, checkout [introduction to policies](../introduction).
If you are unfamiliar with these, checkout [introduction to policies](/docs/{{ page.version }}/policies/introduction).
{% endtip %}

Policies applied to data plane proxies all follow the same basic structure:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: How Kuma chooses the right policy to apply

{% tip %}
This only applies to source/destination policies.
If you are unfamiliar with these, checkout [introduction to policies](../introduction).
If you are unfamiliar with these, checkout [introduction to policies](/docs/{{ page.version }}/policies/introduction).
{% endtip %}

At any single moment, there might be multiple policies (of the same type) that match a connection between `sources` and `destinations` `Dataplane`s.
Expand Down
40 changes: 19 additions & 21 deletions app/_src/policies/introduction.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,30 @@
---
title: Policies
---

{% tip %}
**Need help?** Installing and using {{site.mesh_product_name}} should be as easy as possible. [Contact and chat](/community) with the community in real-time if you get stuck or need clarifications. We are here to help.
{% endtip %}

Here you can find the list of Policies that {{site.mesh_product_name}} supports.

Going forward from version 2.0, {{site.mesh_product_name}} is transitioning from [source/destination policies](../general-notes-about-kuma-policies) to [`targetRef` policies](../targetref).
Going forward from version 2.0, {{site.mesh_product_name}} is transitioning from [source/destination policies](/docs/{{
page.version }}/policies/general-notes-about-kuma-policies) to [`targetRef` policies](/docs/{{ page.version
}}/policies/targetref).

The following table shows the equivalence between source/destination and `targetRef` policies:

| source/destination policy | `targetRef` policy |
|----------------------------------------------|---------------------------------------------------|
| [CircuitBreaker](../circuit-breaker) | [MeshCircuitBreaker](../meshcircuitbreaker) |
| [FaultInjection](../fault-injection) | [MeshFaultInjection](../meshfaultinjection) |
| [HealthCheck](../health-check) | [MeshHealthCheck](../meshhealthcheck) |
| [RateLimit](../rate-limit) | [MeshRateLimit](../meshratelimit) |
| [Retry](../retry) | [MeshRetry](../meshretry) |
| [Timeout](../timeout) | [MeshTimeout](../meshtimeout) |
| [TrafficLog](../traffic-log) | [MeshAccessLog](../meshaccesslog) |
| [TrafficMetrics](../traffic-metrics) | N/A |
| [TrafficPermissions](../traffic-permissions) | [MeshTrafficPermission](../meshtrafficpermission) |
| [TrafficRoute](../traffic-route) | [MeshHTTPRoute](../meshhttproute) |
| [TrafficTrace](../traffic-trace) | [MeshTrace](../meshtrace) |
| [ProxyTemplate](../proxy-template) | [MeshProxyPatch](../meshproxypatch) |
| source/destination policy | `targetRef` policy |
|-----------------------------------------------------------------------------|----------------------------------------------------------------------------------|
| [CircuitBreaker](/docs/{{ page.version }}/policies/circuit-breaker) | [MeshCircuitBreaker](/docs/{{ page.version }}/policies/meshcircuitbreaker) |
| [FaultInjection](/docs/{{ page.version }}/policies/fault-injection) | [MeshFaultInjection](/docs/{{ page.version }}/policies/meshfaultinjection) |
| [HealthCheck](/docs/{{ page.version }}/policies/health-check) | [MeshHealthCheck](/docs/{{ page.version }}/policies/meshhealthcheck) |
| [RateLimit](/docs/{{ page.version }}/policies/rate-limit) | [MeshRateLimit](/docs/{{ page.version }}/policies/meshratelimit) |
| [Retry](/docs/{{ page.version }}/policies/retry) | [MeshRetry](/docs/{{ page.version }}/policies/meshretry) |
| [Timeout](/docs/{{ page.version }}/policies/timeout) | [MeshTimeout](/docs/{{ page.version }}/policies/meshtimeout) |
| [TrafficLog](/docs/{{ page.version }}/policies/traffic-log) | [MeshAccessLog](/docs/{{ page.version }}/policies/meshaccesslog) |
| [TrafficMetrics](/docs/{{ page.version }}/policies/traffic-metrics) | N/A |
| [TrafficPermissions](/docs/{{ page.version }}/policies/traffic-permissions) | [MeshTrafficPermission](/docs/{{ page.version }}/policies/meshtrafficpermission) |
| [TrafficRoute](/docs/{{ page.version }}/policies/traffic-route) | [MeshHTTPRoute](/docs/{{ page.version }}/policies/meshhttproute) |
| [TrafficTrace](/docs/{{ page.version }}/policies/traffic-trace) | [MeshTrace](/docs/{{ page.version }}/policies/meshtrace) |
| [ProxyTemplate](/docs/{{ page.version }}/policies/proxy-template) | [MeshProxyPatch](/docs/{{ page.version }}/policies/meshproxypatch) |

{% warning %}
`targetRef` policies are still beta and it is therefore not supported to mix source/destination and targetRef policies together.
`targetRef` policies are still beta and it is therefore not supported to mix source/destination and targetRef policies
together.
{% endwarning %}
4 changes: 0 additions & 4 deletions app/_src/policies/mesh-gateway-route.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,4 @@ For example, the following filters match `/prefix`, trim it from the path and se

## Reference

The reference doc contains all options on [`MeshGatewayRoute`](/docs/{{ page.version }}/generated/resources/policy_meshgatewayroute).

## All options

{% json_schema MeshGatewayRoute type=proto %}
2 changes: 0 additions & 2 deletions app/_src/policies/mesh-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,6 @@ This set of listener tags is what {{site.mesh_product_name}} will match policies
| kuma.io/service=edge-gateway | kuma.io/service=example,domain=example.com | kuma.io/service=example,domain=example.com |
| kuma.io/service=edge,location=us | version=2 | kuma.io/service=edit,location=us,version=2 |

The reference doc contains all options on [`MeshGateway`](/docs/{{ page.version }}/generated/resources/policy_meshgateway).

## TLS Termination

TLS sessions are terminated on a Gateway by specifying the "HTTPS" protocol, and providing a server certificate configuration.
Expand Down
6 changes: 3 additions & 3 deletions app/_src/policies/meshaccesslog.md
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ spec:
```
{% endif_version %}

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

{% endtab %}
{% endtabs %}
Expand Down Expand Up @@ -718,7 +718,7 @@ spec:
```
{% endif_version %}

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

{% endtab %}
{% endtabs %}
Expand Down Expand Up @@ -843,7 +843,7 @@ spec:
```
{% endif_version %}

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

{% endtab %}
{% endtabs %}
Expand Down
6 changes: 3 additions & 3 deletions app/_src/policies/meshcircuitbreaker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: MeshCircuitBreaker (beta)

{% warning %}
This policy uses new policy matching algorithm and is in beta state, it should not be mixed
with [CircuitBreaker](../circuit-breaker).
with [CircuitBreaker](/docs/{{ page.version }}/policies/circuit-breaker).
{% endwarning %}

This policy will look for errors in the live traffic being exchanged between our data plane proxies. It will mark a data
Expand Down Expand Up @@ -65,7 +65,7 @@ To learn more about the information in this table, see the [matching docs](/docs

### Outlier detection

Outlier detection can be configured for [HTTP, TCP or gRPC](/docs/{{ page.version }}/policies/protocol-support-in-kuma/#protocol-support-in-kuma) traffic.
Outlier detection can be configured for [HTTP, TCP or gRPC](/docs/{{ page.version }}/policies/protocol-support-in-kuma) traffic.

{% warning %}
For **gRPC** requests, the outlier detection will use the HTTP status mapped from the `grpc-status` response header.
Expand Down Expand Up @@ -138,7 +138,7 @@ Split Mode is when [`splitExternalAndLocalErrors`](#outlier-detection) is equal

This detection type takes into account only externally originated (transaction) errors, ignoring locally originated ones.

[**HTTP**](/docs/{{ page.version }}/policies/protocol-support-in-kuma/#protocol-support-in-kuma)
[**HTTP**](/docs/{{ page.version }}/policies/protocol-support-in-kuma)

If an upstream host is an HTTP-server, only 5xx types of error are taken into account (see Consecutive Gateway Failure for exceptions).

Expand Down
6 changes: 3 additions & 3 deletions app/_src/policies/meshfaultinjection.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ spec:
percentage: 50
```

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

{% endtab %}
{% endtabs %}
Expand Down Expand Up @@ -188,7 +188,7 @@ spec:
value: 5s
```

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

{% endtab %}
{% endtabs %}
Expand Down Expand Up @@ -257,7 +257,7 @@ spec:
percentage: 5
```

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

{% endtab %}
{% endtabs %}
Expand Down
4 changes: 2 additions & 2 deletions app/_src/policies/meshhealthcheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Mesh Health Check (beta)

{% warning %}
This policy uses new policy matching algorithm and is in beta state,
it should not be mixed with [HealthCheck](../health-check).
it should not be mixed with [HealthCheck](/docs/{{ page.version }}/policies/health-check).
{% endwarning %}

This policy enables {{site.mesh_product_name}} to keep track of the health of every data plane proxy,
Expand Down Expand Up @@ -40,7 +40,7 @@ The `MeshHealthCheck` policy supports both L4/TCP and L7/HTTP/gRPC checks.

### Protocol selection

The health check protocol is selected by picking the most [specific protocol](/docs/{{ page.version }}/policies/protocol-support-in-kuma/#protocol-support-in-kuma)
The health check protocol is selected by picking the most [specific protocol](/docs/{{ page.version }}/policies/protocol-support-in-kuma)
and falls back to more general protocol when specified protocol has `disabled=true` in policy definition.
See [protocol fallback example](#protocol-fallback).

Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/meshhttproute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Mesh HTTP Route (beta)

{% warning %}
This policy uses new policy matching algorithm and is in beta state,
it should not be mixed with [TrafficRoute](../traffic-route).
it should not be mixed with [TrafficRoute](/docs/{{ page.version }}/policies/traffic-route).
{% endwarning %}

The `MeshHTTPRoute` policy allows altering and redirecting HTTP requests
Expand Down
4 changes: 2 additions & 2 deletions app/_src/policies/meshloadbalancingstrategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ spec:
name: x-header
```

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

{% endtab %}
{% endtabs %}
Expand Down Expand Up @@ -232,7 +232,7 @@ spec:
disabled: true
```

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

{% endtab %}
{% endtabs %}
Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/meshratelimit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: MeshRateLimit (beta)

{% warning %}
This policy uses new policy matching algorithm and is in beta state,
it shouldn't be mixed with [Rate Limit](../rate-limit).
it shouldn't be mixed with [Rate Limit](/docs/{{ page.version }}/policies/rate-limit).
{% endwarning %}

This policy enables per-instance service request limiting. Policy supports ratelimiting of HTTP/HTTP2 requests and TCP connections.
Expand Down
10 changes: 5 additions & 5 deletions app/_src/policies/meshretry.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: MeshRetry (beta)

{% warning %}
This policy uses new policy matching algorithm and is in beta state,
it should not be mixed with [Retry](../retry).
it should not be mixed with [Retry](/docs/{{ page.version }}/policies/retry).
{% endwarning %}

This policy enables {{site.mesh_product_name}} to know how to behave if there is a failed scenario (i.e. HTTP request) which could be retried.
Expand All @@ -23,7 +23,7 @@ To learn more about the information in this table, see the [matching docs](/docs
## Configuration

The policy let you configure retry behaviour for `HTTP`, `GRPC` and `TCP` protocols.
The protocol is selected by picking the most [specific protocol](/docs/{{ page.version }}/policies/protocol-support-in-kuma/#protocol-support-in-kuma).
The protocol is selected by picking the most [specific protocol](/docs/{{ page.version }}/policies/protocol-support-in-kuma).

Each protocol has a separate section under `default` in the policy YAML.
Some sections are common between protocols or have similar meaning.
Expand Down Expand Up @@ -204,7 +204,7 @@ spec:
- "5xx"
```

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

{% endtab %}
{% endtabs %}
Expand Down Expand Up @@ -267,7 +267,7 @@ spec:
- "DeadlineExceeded"
```

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

{% endtab %}
{% endtabs %}
Expand Down Expand Up @@ -320,7 +320,7 @@ spec:
maxConnectAttempt: 5
```

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

{% endtab %}
{% endtabs %}
Expand Down
2 changes: 1 addition & 1 deletion app/_src/policies/meshtcproute.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: MeshTCPRoute (beta)
---

{% warning %}
This policy uses a new policy matching algorithm and is in beta state. It shouldn't be combined with [TrafficRoute](../traffic-route).
This policy uses a new policy matching algorithm and is in beta state. It shouldn't be combined with [TrafficRoute](/docs/{{ page.version }}/policies/traffic-route).
{% endwarning %}

The `MeshTCPRoute` policy allows you to alter and redirect TCP requests
Expand Down
6 changes: 3 additions & 3 deletions app/_src/policies/meshtimeout.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Mesh Timeout (beta)

{% warning %}
This policy uses new policy matching algorithm and is in beta state,
it should not be mixed with [Timeout policy](../timeout).
it should not be mixed with [Timeout policy](/docs/{{ page.version }}/policies/timeout).
{% endwarning %}

## TargetRef support matrix
Expand Down Expand Up @@ -40,7 +40,7 @@ This policy enables {{site.mesh_product_name}} to set timeouts on the inbound an
depending on the protocol. Using this policy you can configure TCP and HTTP timeouts.
Timeout configuration is split into two sections: common configuration and HTTP configuration.
Common config is applied to both HTTP and TCP communication. HTTP timeout are only applied when
service is marked as http. More on this in [protocol support section](../protocol-support-in-kuma).
service is marked as http. More on this in [protocol support section](/docs/{{ page.version }}/policies/protocol-support-in-kuma).

MeshTimeout policy lets you configure multiple timeouts:

Expand Down Expand Up @@ -264,7 +264,7 @@ spec:
| http.maxConnectionDuration | 0s |

{% if_version eq:2.1.x %}
If you don't specify a `from` or `to` section , the defaults from [`Timeout`](../timeout) will be used. This
If you don't specify a `from` or `to` section , the defaults from [`Timeout`](/docs/{{ page.version }}/policies/timeout) will be used. This
is [a known bug](https://github.com/kumahq/kuma/issues/5850) and is fixed in the next version.
{% endif_version %}

Expand Down
12 changes: 6 additions & 6 deletions app/_src/policies/meshtrace.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: MeshTrace (beta)

{% warning %}
This policy uses new policy matching algorithm and is in beta state,
it should not be mixed with [TrafficTrace](../traffic-trace).
it should not be mixed with [TrafficTrace](/docs/{{ page.version }}/policies/traffic-trace).
{% endwarning %}

This policy enables publishing traces to a third party tracing solution.

Tracing is supported over HTTP, HTTP2, and gRPC protocols.
You must [explicitly specify the protocol](../protocol-support-in-kuma) for each service and data plane proxy you want to enable tracing for.
You must [explicitly specify the protocol](/docs/{{ page.version }}/policies/protocol-support-in-kuma) for each service and data plane proxy you want to enable tracing for.

{{site.mesh_product_name}} currently supports the following trace exposition formats:

Expand Down Expand Up @@ -343,15 +343,15 @@ spec:
```
{% endif_version %}

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

{% endtab %}
{% endtabs %}

### Datadog

{% tip %}
This assumes a Datadog agent is configured and running. If you haven't already check the [Datadog observability page](../../explore/observability#configuring-datadog).
This assumes a Datadog agent is configured and running. If you haven't already check the [Datadog observability page](/docs/{{ page.version }}/explore/observability#configuring-datadog).
{% endtip %}

{% tabs meshtrace-datadog useUrlFragment=false %}
Expand Down Expand Up @@ -567,7 +567,7 @@ spec:
```
{% endif_version %}

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

{% endtab %}
{% endtabs %}
Expand Down Expand Up @@ -781,7 +781,7 @@ spec:
```
{% endif_version %}

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

{% endtab %}
{% endtabs %}
Expand Down
4 changes: 2 additions & 2 deletions app/_src/policies/meshtrafficpermission.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: MeshTrafficPermission (beta)

{% warning %}
This policy uses new policy matching algorithm and is in beta state,
it should not be mixed with [TrafficPermission](../traffic-permissions).
it should not be mixed with [TrafficPermission](/docs/{{ page.version }}/policies/traffic-permissions).
{% endwarning %}

## TargetRef support matrix
Expand Down Expand Up @@ -224,7 +224,7 @@ spec:
default: # 5
action: Deny
```
Apply the configuration with `kumactl apply -f [..]` or with the [HTTP API](../../reference/http-api).
Apply the configuration with `kumactl apply -f [..]` or with the [HTTP API](/docs/{{ page.version }}/reference/http-api).

{% endtab %}
{% endtabs %}
Expand Down
Loading

0 comments on commit 56f4ba3

Please sign in to comment.