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.

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

fix(Mesh*Route): make behavior clearer #1496

Merged
merged 5 commits into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion app/_src/policies/meshhttproute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

{% warning %}
This policy uses new policy matching algorithm.
Do **not** combine with [TrafficRoute](/docs/{{ page.version }}/policies/traffic-route).
Do **not** combine with [TrafficRoute](/docs/{{ page.version }}/policies/traffic-route) except for the default `route-all` route, which should be kept..

Check warning on line 7 in app/_src/policies/meshhttproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "app/_src/policies/meshhttproute.md", "range": {"start": {"line": 7, "column": 39}}}, "severity": "INFO"}

Check warning on line 7 in app/_src/policies/meshhttproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('be kept'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('be kept').", "location": {"path": "app/_src/policies/meshhttproute.md", "range": {"start": {"line": 7, "column": 144}}}, "severity": "INFO"}
{% endwarning %}

The `MeshHTTPRoute` policy allows altering and redirecting HTTP requests
Expand Down Expand Up @@ -114,6 +114,10 @@
- **`weight`** - when a request matches the route, the choice of an upstream cluster
is determined by its weight. Total weight is a sum of all weights in `backendRefs` list.

## Interactions with `MeshTCPRoute`

Check warning on line 117 in app/_src/policies/meshhttproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Headings] 'Interactions with ************' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'Interactions with ************' should use sentence-style capitalization.", "location": {"path": "app/_src/policies/meshhttproute.md", "range": {"start": {"line": 117, "column": 1}}}, "severity": "WARNING"}

`MeshHTTPRoute` takes priority over [`MeshTCPRoute`](../meshtcproute) when both are defined for the same service, and the matching `MeshTCPRoute` is ignored.

Check warning on line 119 in app/_src/policies/meshhttproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('are defined'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('are defined').", "location": {"path": "app/_src/policies/meshhttproute.md", "range": {"start": {"line": 119, "column": 81}}}, "severity": "INFO"}

Check warning on line 119 in app/_src/policies/meshhttproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is ignored'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is ignored').", "location": {"path": "app/_src/policies/meshhttproute.md", "range": {"start": {"line": 119, "column": 147}}}, "severity": "INFO"}

## Examples

### Traffic split
Expand Down
5 changes: 4 additions & 1 deletion app/_src/policies/meshtcproute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

{% warning %}
This policy uses a new policy matching algorithm.
Do **not** combine with [TrafficRoute](/docs/{{ page.version }}/policies/traffic-route).
Do **not** combine with [TrafficRoute](/docs/{{ page.version }}/policies/traffic-route) except for the default `route-all` route, which should be kept.

Check warning on line 7 in app/_src/policies/meshtcproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "app/_src/policies/meshtcproute.md", "range": {"start": {"line": 7, "column": 39}}}, "severity": "INFO"}

Check warning on line 7 in app/_src/policies/meshtcproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('be kept'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('be kept').", "location": {"path": "app/_src/policies/meshtcproute.md", "range": {"start": {"line": 7, "column": 144}}}, "severity": "INFO"}
{% endwarning %}

The `MeshTCPRoute` policy allows you to alter and redirect TCP requests
Expand Down Expand Up @@ -53,6 +53,9 @@
cluster is determined by its weight. Total weight is a sum of all weights
in the `backendRefs` list.

## Interactions with `MeshHTTPRoute`

Check warning on line 56 in app/_src/policies/meshtcproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Headings] 'Interactions with *************' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'Interactions with *************' should use sentence-style capitalization.", "location": {"path": "app/_src/policies/meshtcproute.md", "range": {"start": {"line": 56, "column": 1}}}, "severity": "WARNING"}

[`MeshHTTPRoute`](../meshhttproute) takes priority over `MeshTCPRoute` when both are defined for the same service, and the matching `MeshTCPRoute` is ignored.

Check warning on line 58 in app/_src/policies/meshtcproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('are defined'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('are defined').", "location": {"path": "app/_src/policies/meshtcproute.md", "range": {"start": {"line": 58, "column": 82}}}, "severity": "INFO"}

Check warning on line 58 in app/_src/policies/meshtcproute.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is ignored'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is ignored').", "location": {"path": "app/_src/policies/meshtcproute.md", "range": {"start": {"line": 58, "column": 148}}}, "severity": "INFO"}

## Examples

Expand Down
Loading