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

docs(policy): improve targetRef table #1579

Merged
merged 14 commits into from
Jan 22, 2024
Merged

docs(policy): improve targetRef table #1579

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
795c7e5
docs(MeshAccessLog): improve targetRef table
michaelbeaumont Jan 15, 2024
e6fdb4b
docs(MeshCircuitBreaker): add targetRef tables
michaelbeaumont Jan 16, 2024
f3905f3
docs(MeshFaultInjection): add targetRef tables
michaelbeaumont Jan 16, 2024
f99db4a
docs(MeshHealthCheck): add targetRef tables
michaelbeaumont Jan 16, 2024
53fb47e
docs(MeshLoadBalancingStrategy): add targetRef tables
michaelbeaumont Jan 16, 2024
a370384
docs(MeshProxyPatch): add targetRef tables
michaelbeaumont Jan 16, 2024
b08b64e
docs(MeshRateLimit): add targetRef table
michaelbeaumont Jan 16, 2024
a1d3ea4
docs(MeshRetry): add targetRef tables
michaelbeaumont Jan 16, 2024
213fae9
docs(MeshTimeout): add targetRef tables
michaelbeaumont Jan 16, 2024
ffd9c15
docs(MeshTrace): add targetRef tables
michaelbeaumont Jan 16, 2024
5b5539a
docs(MeshTrafficPermission): update targetRef table
michaelbeaumont Jan 16, 2024
ab928ba
docs(policy): explain new table
michaelbeaumont Jan 19, 2024
4b6ad93
chore: add back old targetRef explanation
michaelbeaumont Jan 22, 2024
1973cf6
docs(MeshTrafficPermission): add note about gateway
michaelbeaumont Jan 22, 2024
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
30 changes: 13 additions & 17 deletions app/_src/policies/meshaccesslog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,25 @@ If you haven't, see the [observability docs](/docs/{{ page.version }}/explore/ob
{% if_version gte:2.4.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef.kind` | top level | to | from |
| ------------------- | --------- | --- | ---- |
| `Mesh` | ✅ | ✅ | ✅ |
| `MeshSubset` | ✅ | ❌ | ❌ |
| `MeshService` | ✅ | ✅ | ❌ |
| `MeshServiceSubset` | ✅ | ❌ | ❌ |
| `targetRef` | Allowed kinds |
| ----------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
| `from[].targetRef.kind` | `Mesh` |
{% endtab %}

{% tab targetRef Builtin Gateway %}
{% if_version lte:2.5.x %}
| `targetRef.kind` | top level | to |
| ------------------- | --------- | --- |
| `Mesh` | ✅ | ✅ |
| `MeshGateway` | ✅ | ❌ |
| `MeshService` | ✅ | ❌ |
| `targetRef` | Allowed kinds |
| --------------------- | ----------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService` |
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
{% endif_version %}
{% if_version gte:2.6.x %}
| `targetRef.kind` | top level | to |
| ----------------------------------- | --------- | --- |
| `Mesh` | ✅ | ✅ |
| `MeshGateway` | ✅ | ❌ |
| `MeshGateway` with listener `.tags` | ✅ | ❌ |
| `MeshService` | ✅ | ✅ |
| `targetRef` | Allowed kinds |
| --------------------- | ------------------------------------------------ |
| `targetRef.kind` | `Mesh`, `MeshGateway`, `MeshGateway` with `tags` |
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
{% endif_version %}
{% endtab %}
{% endtabs %}
Expand Down
21 changes: 9 additions & 12 deletions app/_src/policies/meshcircuitbreaker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,18 @@ target proxies are healthy or not.
{% if_version gte:2.6.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef.kind` | top level | to | from |
| ------------------- | --------- | --- | ---- |
| `Mesh` | ✅ | ✅ | ✅ |
| `MeshSubset` | ✅ | ❌ | ❌ |
| `MeshService` | ✅ | ✅ | ❌ |
| `MeshServiceSubset` | ✅ | ❌ | ❌ |
| `targetRef` | Allowed kinds |
| ----------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
| `from[].targetRef.kind` | `Mesh` |
{% endtab %}

{% tab targetRef Builtin Gateway %}
| `targetRef.kind` | top level | to |
| ----------------------------------- | --------- | --- |
| `Mesh` | ✅ | ✅ |
| `MeshGateway` | ✅ | ❌ |
| `MeshGateway` with listener `.tags` | ✅ | ❌ |
| `MeshService` | ✅ | ✅ |
| `targetRef` | Allowed kinds |
| ----------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags`|
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
{% endtab %}
{% endtabs %}

Expand Down
22 changes: 22 additions & 0 deletions app/_src/policies/meshfaultinjection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,35 @@ Do **not** combine with [FaultInjection](/docs/{{ page.version }}/policies/fault

## `targetRef` support matrix

{% if_version gte:2.6.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef` | Allowed kinds |
| ----------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
| `from[].targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
{% endtab %}

{% tab targetRef Builtin Gateway %}
| `targetRef` | Allowed kinds |
| ----------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags`|
| `to[].targetRef.kind` | `Mesh` |
{% endtab %}
{% endtabs %}

{% endif_version %}
{% if_version lte:2.5.x %}

| `targetRef.kind` | top level | to | from |
| ------------------- | --------- | --- | ---- |
| `Mesh` | ✅ | ❌ | ✅ |
| `MeshSubset` | ✅ | ❌ | ✅ |
| `MeshService` | ✅ | ❌ | ✅ |
| `MeshServiceSubset` | ✅ | ❌ | ✅ |

{% endif_version %}

To learn more about the information in this table, see the [matching docs](/docs/{{ page.version }}/policies/targetref).

## Configuration
Expand Down
21 changes: 21 additions & 0 deletions app/_src/policies/meshhealthcheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,34 @@ This mode generates extra traffic to other proxies and services as described in

## TargetRef support matrix

{% if_version gte:2.6.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef` | Allowed kinds |
| --------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
{% endtab %}

{% tab targetRef Builtin Gateway %}
| `targetRef` | Allowed kinds |
| ----------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags`|
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
{% endtab %}
{% endtabs %}

{% endif_version %}
{% if_version lte:2.5.x %}

| TargetRef type | top level | to | from |
| ----------------- | --------- | --- | ---- |
| Mesh | ✅ | ✅ | ❌ |
| MeshSubset | ✅ | ❌ | ❌ |
| MeshService | ✅ | ✅ | ❌ |
| MeshServiceSubset | ✅ | ❌ | ❌ |

{% endif_version %}

To learn more about the information in this table, see the [matching docs](/docs/{{ page.version }}/policies/targetref).

Expand Down
22 changes: 22 additions & 0 deletions app/_src/policies/meshloadbalancingstrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,35 @@ flag is going to be replaced by the current policy and will be deprecated in the

## TargetRef support matrix

{% if_version gte:2.6.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef` | Allowed kinds |
| --------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
{% endtab %}

{% tab targetRef Builtin Gateway %}
| `targetRef` | Allowed kinds |
| ----------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags`|
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
{% endtab %}
{% endtabs %}

{% endif_version %}
{% if_version lte:2.5.x %}

| TargetRef type | top level | to | from |
| ----------------- | --------- | --- | ---- |
| Mesh | ✅ | ✅ | ❌ |
| MeshSubset | ✅ | ❌ | ❌ |
| MeshService | ✅ | ✅ | ❌ |
| MeshServiceSubset | ✅ | ❌ | ❌ |

{% endif_version %}

To learn more about the information in this table, see the [matching docs](/docs/{{ page.version }}/policies/targetref).

## Configuration
Expand Down
17 changes: 17 additions & 0 deletions app/_src/policies/meshproxypatch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,23 @@ Do **not** combine with [Proxy Template](/docs/{{ page.version }}/policies/proxy

{% endif_version %}
{% if_version gte:2.5.x %}
{% if_version gte:2.6.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef` | Allowed kinds |
| --------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
{% endtab %}

{% tab targetRef Builtin Gateway %}
| `targetRef` | Allowed kinds |
| ---------------- | --------------------- |
| `targetRef.kind` | `Mesh`, `MeshGateway` |
{% endtab %}
{% endtabs %}

{% endif_version %}
{% if_version lte:2.5.x %}
| `targetRef.kind` | top level |
|---------------------|-----------|
| `Mesh` | ✅ |
Expand All @@ -43,6 +59,7 @@ Do **not** combine with [Proxy Template](/docs/{{ page.version }}/policies/proxy
| `MeshServiceSubset` | ✅ |
| `MeshGateway` | ✅ |

{% endif_version %}
{% endif_version %}

To learn more about the information in this table, see the [matching docs](/docs/{{ page.version }}/policies/targetref).
Expand Down
22 changes: 22 additions & 0 deletions app/_src/policies/meshratelimit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,35 @@ Rate limiting supports an [ExternalService](/docs/{{ page.version }}/policies/ex

## TargetRef support matrix

{% if_version gte:2.6.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef` | Allowed kinds |
| ----------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
| `from[].targetRef.kind` | `Mesh` |
{% endtab %}

{% tab targetRef Builtin Gateway %}
| `targetRef` | Allowed kinds |
| --------------------- | --------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags` |
| `to[].targetRef.kind` | `Mesh` |
{% endtab %}
{% endtabs %}

{% endif_version %}
{% if_version lte:2.5.x %}

| TargetRef type | top level | to | from |
| ----------------- | --------- | --- | ---- |
| Mesh | ✅ | ❌ | ✅ |
| MeshSubset | ✅ | ❌ | ❌ |
| MeshService | ✅ | ❌ | ❌ |
| MeshServiceSubset | ✅ | ❌ | ❌ |

{% endif_version %}

To learn more about the information in this table, see the [matching docs](/docs/{{ page.version }}/policies/targetref).

## Configuration
Expand Down
16 changes: 16 additions & 0 deletions app/_src/policies/meshretry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,37 @@ This policy enables {{site.mesh_product_name}} to know how to behave if there is
{% if_version gte:2.4.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
{% if_version gte:2.6.x %}
| `targetRef` | Allowed kinds |
| --------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
{% endif_version %}
{% if_version lte:2.5.x %}
| `targetRef.kind` | top level | to | from |
| ------------------- | --------- | --- | ---- |
| `Mesh` | ✅ | ✅ | ❌ |
| `MeshSubset` | ✅ | ❌ | ❌ |
| `MeshService` | ✅ | ✅ | ❌ |
| `MeshServiceSubset` | ✅ | ❌ | ❌ |
{% endif_version %}
{% endtab %}

{% tab targetRef Builtin Gateway %}
{% if_version gte:2.6.x %}
| `targetRef` | Allowed kinds |
| --------------------- | --------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags` |
| `to[].targetRef.kind` | `Mesh` |
{% endif_version %}
{% if_version lte:2.5.x %}
| `targetRef.kind` | top level | to |
| ------------------- | --------- | --- |
| `Mesh` | ✅ | ✅ |
| `MeshGateway` | ✅ | ❌ |
| `MeshService` | ✅ | ❌ |
| `MeshServiceSubset` | ✅ | ❌ |
{% endif_version %}
{% endtab %}
{% endtabs %}

Expand Down
21 changes: 21 additions & 0 deletions app/_src/policies/meshtimeout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,26 @@ Do **not** combine with [Timeout policy](/docs/{{ page.version }}/policies/timeo

## TargetRef support matrix

{% if_version gte:2.6.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef` | Allowed kinds |
| ----------------------- | ------------------------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset`, `MeshHTTPRoute` |
| `to[].targetRef.kind` | `Mesh`, `MeshService` |
| `from[].targetRef.kind` | `Mesh` |
{% endtab %}

{% tab targetRef Builtin Gateway %}
| `targetRef` | Allowed kinds |
| --------------------- | --------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags` |
| `to[].targetRef.kind` | `Mesh` |
{% endtab %}
{% endtabs %}

{% endif_version %}
{% if_version lte:2.5.x %}
{% if_version gte:2.3.x %}

| TargetRef type | top level | to | from |
Expand All @@ -30,6 +50,7 @@ Do **not** combine with [Timeout policy](/docs/{{ page.version }}/policies/timeo
| MeshService | ✅ | ✅ | ❌ |
| MeshServiceSubset | ✅ | ❌ | ❌ |
lahabana marked this conversation as resolved.
Show resolved Hide resolved

{% endif_version %}
{% endif_version %}

To learn more about the information in this table, see the [matching docs](/docs/{{ page.version }}/policies/targetref).
Expand Down
20 changes: 20 additions & 0 deletions app/_src/policies/meshtrace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,33 @@ For HTTP you can also manually forward the following headers:

## TargetRef support matrix

{% if_version gte:2.6.x %}
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef` | Allowed kinds |
| --------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
{% endtab %}

{% tab targetRef Builtin Gateway %}
| `targetRef` | Allowed kinds |
| ---------------- | --------------------- |
| `targetRef.kind` | `Mesh`, `MeshGateway` |
{% endtab %}
{% endtabs %}

{% endif_version %}
{% if_version lte:2.5.x %}

| TargetRef type | top level | to | from |
| ----------------- | --------- | --- | ---- |
| Mesh | ✅ | ❌ | ❌ |
| MeshSubset | ✅ | ❌ | ❌ |
| MeshService | ✅ | ❌ | ❌ |
| MeshServiceSubset | ✅ | ❌ | ❌ |
lahabana marked this conversation as resolved.
Show resolved Hide resolved

{% endif_version %}

To learn more about the information in this table, see the [matching docs](/docs/{{ page.version }}/policies/targetref).

## Configuration
Expand Down
14 changes: 8 additions & 6 deletions app/_src/policies/meshtrafficpermission.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ Do **not** combine with [TrafficPermission](/docs/{{ page.version }}/policies/tr

## TargetRef support matrix

| TargetRef type | top level | to | from |
| ----------------- | --------- | --- | ---- |
| Mesh | ✅ | ❌ | ✅ |
| MeshSubset | ✅ | ❌ | ✅ |
| MeshService | ✅ | ❌ | ✅ |
| MeshServiceSubset | ✅ | ❌ | ✅ |
{% tabs targetRef useUrlFragment=false %}
{% tab targetRef Sidecar %}
| `targetRef` | Allowed kinds |
| ----------------------- | -------------------------------------------------------- |
| `targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
| `from[].targetRef.kind` | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
{% endtab %}
michaelbeaumont marked this conversation as resolved.
Show resolved Hide resolved
{% endtabs %}

If you don't understand this table you should read [matching docs](/docs/{{ page.version }}/policies/targetref).

Expand Down
Loading
Loading