docs(policies): added policy support table for delegated gateway (#1664)

Signed-off-by: Lukasz Dziedziak <[email protected]>
kumahq · Feb 23, 2024 · f221a46 · f221a46
1 parent bcf611b
commit f221a46
Show file tree

Hide file tree

Showing 14 changed files with 105 additions and 0 deletions.
diff --git a/app/_src/policies/meshaccesslog.md b/app/_src/policies/meshaccesslog.md
@@ -41,6 +41,16 @@ If you haven't, see the [observability docs](/docs/{{ page.version }}/explore/ob
 | `from[].targetRef.kind` | `Mesh`                                                   |
 {% endif_version %}
 {% endtab %}
+
+{% if_version gte:2.6.x %}
+{% tab targetRef Delegated Gateway %}
+| `targetRef`             | Allowed kinds                                            |
+| ----------------------- | -------------------------------------------------------- |
+| `targetRef.kind`        | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+| `to[].targetRef.kind`   | `Mesh`, `MeshService`                                    |
+{% endtab %}
+{% endif_version %}
+
 {% endtabs %}
 {% endif_version %}
 

diff --git a/app/_src/policies/meshcircuitbreaker.md b/app/_src/policies/meshcircuitbreaker.md
@@ -54,6 +54,13 @@ target proxies are healthy or not.
 | `targetRef.kind`        | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags`|
 | `to[].targetRef.kind`   | `Mesh`, `MeshService`                                    |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+| `targetRef`             | Allowed kinds                                            |
+| ----------------------- | -------------------------------------------------------- |
+| `targetRef.kind`        | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+| `to[].targetRef.kind`   | `Mesh`, `MeshService`                                    |
+{% endtab %}
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshfaultinjection.md b/app/_src/policies/meshfaultinjection.md
@@ -25,6 +25,12 @@ Do **not** combine with [FaultInjection](/docs/{{ page.version }}/policies/fault
 | ----------------------- | -------------------------------------------------------- |
 | `targetRef.kind`        | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags`|
 | `to[].targetRef.kind`   | `Mesh`                                                   |
+{% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+
+`MeshFaultInjection` isn't supported on delegated gateways.
+
 {% endtab %}
 {% endtabs %}
 

diff --git a/app/_src/policies/meshhealthcheck.md b/app/_src/policies/meshhealthcheck.md
@@ -39,6 +39,14 @@ This mode generates extra traffic to other proxies and services as described in
 | `targetRef.kind`        | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags`|
 | `to[].targetRef.kind`   | `Mesh`, `MeshService`                                    |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+| `targetRef`           | Allowed kinds                                            |
+| --------------------- | -------------------------------------------------------- |
+| `targetRef.kind`      | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+| `to[].targetRef.kind` | `Mesh`, `MeshService`                                    |
+{% endtab %}
+
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshhttproute.md b/app/_src/policies/meshhttproute.md
@@ -33,6 +33,14 @@ depending on where the request coming from and where it's going to.
 | `targetRef.kind`        | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags`|
 | `to[].targetRef.kind`   | `Mesh`                                                   |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+| `targetRef`           | Allowed kinds                                            |
+| --------------------- | -------------------------------------------------------- |
+| `targetRef.kind`      | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+| `to[].targetRef.kind` | `MeshService`                                            |
+{% endtab %}
+
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshloadbalancingstrategy.md b/app/_src/policies/meshloadbalancingstrategy.md
@@ -26,6 +26,14 @@ When using this policy, the [localityAwareLoadBalancing](/docs/{{ page.version }
 | `targetRef.kind`        | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags`|
 | `to[].targetRef.kind`   | `Mesh`, `MeshService`                                    |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+| `targetRef`           | Allowed kinds                                            |
+| --------------------- | -------------------------------------------------------- |
+| `targetRef.kind`      | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+| `to[].targetRef.kind` | `Mesh`, `MeshService`                                    |
+{% endtab %}
+
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshmetric.md b/app/_src/policies/meshmetric.md
@@ -42,6 +42,13 @@ If you haven't already read the [observability docs](/docs/{{ page.version }}/ex
 | ----------------------- | --------------------------------------------------------- |
 | `targetRef.kind`        | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags` |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+| `targetRef`             | Allowed kinds                                            |
+| ----------------------- | -------------------------------------------------------- |
+| `targetRef.kind`        | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+{% endtab %}
+
 {% endtabs %}
 
 To learn more about the information in this table, see the [matching docs](/docs/{{ page.version }}/policies/targetref).

diff --git a/app/_src/policies/meshproxypatch.md b/app/_src/policies/meshproxypatch.md
@@ -47,6 +47,13 @@ Do **not** combine with [Proxy Template](/docs/{{ page.version }}/policies/proxy
 | ---------------- | --------------------- |
 | `targetRef.kind` | `Mesh`, `MeshGateway` |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+| `targetRef`           | Allowed kinds                                            |
+| --------------------- | -------------------------------------------------------- |
+| `targetRef.kind`      | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+{% endtab %}
+
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshratelimit.md b/app/_src/policies/meshratelimit.md
@@ -37,6 +37,15 @@ Rate limiting supports an [ExternalService](/docs/{{ page.version }}/policies/ex
 | `targetRef.kind`      | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags` |
 | `to[].targetRef.kind` | `Mesh`                                                    |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+
+{% warning %}
+`MeshRateLimit` isn't supported on delegated gateways.
+{% endwarning %}
+
+{% endtab %}
+
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshretry.md b/app/_src/policies/meshretry.md
@@ -46,6 +46,16 @@ This policy enables {{site.mesh_product_name}} to know how to behave if there is
 | `MeshServiceSubset` | ✅        | ❌  |
 {% endif_version %}
 {% endtab %}
+
+{% if_version gte:2.6.x %}
+{% tab targetRef Delegated Gateway %}
+| `targetRef`           | Allowed kinds                                            |
+| --------------------- | -------------------------------------------------------- |
+| `targetRef.kind`      | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+| `to[].targetRef.kind` | `Mesh`, `MeshService`                                    |
+{% endtab %}
+{% endif_version %}
+
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshtcproute.md b/app/_src/policies/meshtcproute.md
@@ -33,6 +33,13 @@ depending on where the request is coming from and where it's going to.
 | `targetRef.kind`        | `Mesh`, `MeshGateway`, `MeshGateway` with listener `tags` |
 | `to[].targetRef.kind`   | `Mesh`                                                    |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+| `targetRef`           | Allowed kinds                                            |
+| --------------------- | -------------------------------------------------------- |
+| `targetRef.kind`      | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+| `to[].targetRef.kind` | `MeshService`                                            |
+{% endtab %}
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshtimeout.md b/app/_src/policies/meshtimeout.md
@@ -26,6 +26,13 @@ Do **not** combine with [Timeout policy](/docs/{{ page.version }}/policies/timeo
 | `to[].targetRef.kind`   | `Mesh`                                                    |
 | `from[].targetRef.kind` | `Mesh`                                                    |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+| `targetRef`             | Allowed kinds                                                             |
+| ----------------------- | ------------------------------------------------------------------------- |
+| `targetRef.kind`        | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset`, `MeshHTTPRoute` |
+| `to[].targetRef.kind`   | `Mesh`, `MeshService`                                                     |
+{% endtab %}
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshtrace.md b/app/_src/policies/meshtrace.md
@@ -46,6 +46,13 @@ For HTTP you can also manually forward the following headers:
 | ---------------- | --------------------- |
 | `targetRef.kind` | `Mesh`, `MeshGateway` |
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+| `targetRef`           | Allowed kinds                                            |
+| --------------------- | -------------------------------------------------------- |
+| `targetRef.kind`      | `Mesh`, `MeshSubset`, `MeshService`, `MeshServiceSubset` |
+{% endtab %}
+
 {% endtabs %}
 
 {% endif_version %}

diff --git a/app/_src/policies/meshtrafficpermission.md b/app/_src/policies/meshtrafficpermission.md
@@ -20,6 +20,10 @@ Do **not** combine with [TrafficPermission](/docs/{{ page.version }}/policies/tr
 `MeshTrafficPermission` isn't supported on builtin gateways. If applied via
 `spec.targetRef.kind: MeshService`, it has no effect.
 {% endtab %}
+
+{% tab targetRef Delegated Gateway %}
+`MeshTrafficPermission` isn't supported on delegated gateways.
+{% endtab %}
 {% endtabs %}
 
 If you don't understand this table you should read [matching docs](/docs/{{ page.version }}/policies/targetref).