docs(tproxy): restructure and expand transparent proxy documentation #2064
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| config: | ||
| redirect: | ||
| inbound: | ||
| excludePorts: &excludePortsInbound | ||
| path: redirect.inbound.excludePorts | ||
| flag: --exclude-inbound-ports | ||
| env: KUMA_TRANSPARENT_PROXY_REDIRECT_INBOUND_EXCLUDE_PORTS | ||
| runtime: | ||
| path: runtime.kubernetes.injector.sidecarTraffic.excludeInboundPorts | ||
| env: KUMA_RUNTIME_KUBERNETES_SIDECAR_TRAFFIC_EXCLUDE_INBOUND_PORTS | ||
| excludePortsForIPs: &excludePortsForIPsInbound | ||
| path: redirect.inbound.excludePortsForIPs | ||
| flag: --exclude-inbound-ips | ||
| env: KUMA_TRANSPARENT_PROXY_REDIRECT_INBOUND_EXCLUDE_PORTS_FOR_IPS | ||
| runtime: | ||
| path: runtime.kubernetes.injector.sidecarTraffic.excludeInboundIPs | ||
| env: KUMA_RUNTIME_KUBERNETES_SIDECAR_TRAFFIC_EXCLUDE_INBOUND_IPS | ||
| outbound: | ||
| excludePorts: &excludePortsOutbound | ||
| path: redirect.outbound.excludePorts | ||
| flag: --exclude-outbound-ports | ||
| env: KUMA_TRANSPARENT_PROXY_REDIRECT_OUTBOUND_EXCLUDE_PORTS | ||
| runtime: | ||
| path: runtime.kubernetes.injector.sidecarTraffic.excludeOutboundPorts | ||
| env: KUMA_RUNTIME_KUBERNETES_SIDECAR_TRAFFIC_EXCLUDE_OUTBOUND_PORTS | ||
| excludePortsForIPs: &excludePortsForIPsOutbound | ||
| path: redirect.outbound.excludePortsForIPs | ||
| flag: --exclude-outbound-ips | ||
| env: KUMA_TRANSPARENT_PROXY_REDIRECT_OUTBOUND_EXCLUDE_PORTS_FOR_IPS | ||
| runtime: | ||
| path: runtime.kubernetes.injector.sidecarTraffic.excludeOutboundIPs | ||
| env: KUMA_RUNTIME_KUBERNETES_SIDECAR_TRAFFIC_EXCLUDE_OUTBOUND_IPS | ||
|
|
||
| defaults: | ||
| redirect: | ||
| inbound: | ||
| port: 15006 | ||
| outbound: | ||
| port: 15001 | ||
| dns: | ||
| port: 15053 | ||
| kuma-dp: | ||
| username: kuma-dp | ||
| uid: 5678 | ||
| resolv: | ||
| conf: | ||
| path: /etc/resolv.conf | ||
|
|
||
| data: | ||
| guides: | ||
| exclude-traffic: | ||
| excludePorts: | ||
| - *excludePortsInbound | ||
| - *excludePortsOutbound | ||
| excludeIPs: | ||
| - *excludePortsForIPsInbound | ||
| - *excludePortsForIPsOutbound |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| {%- assign values = include.values | split: "," -%} | ||
| {%- capture snippet-tproxy-field-table -%} | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td><strong>Type</strong></td> | ||
| <td><code>{{ include.type }}</code></td> | ||
| </tr> | ||
| {% if include.default %} | ||
| <tr> | ||
| <td><strong>Default Value</strong></td> | ||
| <td><code>{{ include.default }}</code></td> | ||
| </tr> | ||
| {% endif %} | ||
| {% if include.values %} | ||
| <tr> | ||
| <td><strong>Values</strong></td> | ||
| <td> | ||
| {% for value in values %} | ||
| {% if forloop.length > 0 %} | ||
| <code>{{ value }}</code>{% unless forloop.last %}, {% endunless %} | ||
| {% endif %} | ||
| {% endfor %} | ||
| </td> | ||
| </tr> | ||
| {% endif %} | ||
| {% if include.format %} | ||
| <tr> | ||
| <td><strong>Format</strong></td> | ||
| <td><code>{{ include.format }}</code></td> | ||
| </tr> | ||
| {% endif %} | ||
| {% if include.flag %} | ||
| <tr> | ||
| <td><strong>CLI Flag</strong></td> | ||
| <td><code>{{ include.flag }}</code></td> | ||
| </tr> | ||
| {% endif %} | ||
| {% if_version gte:2.9.x %} | ||
| {% if include.env %} | ||
| <tr> | ||
| <td><strong>Environment Variable</strong></td> | ||
| <td><code>KUMA_TRANSPARENT_PROXY_{{ include.env }}</code></td> | ||
| </tr> | ||
| {% endif %} | ||
| {% endif_version %} | ||
| {% if include.annotation %} | ||
| <tr> | ||
| <td><strong>Kubernetes Annotation</strong></td> | ||
| <td><code>{{ include.annotation }}</code></td> | ||
| </tr> | ||
| {% endif %} | ||
| {% if include.runtime %} | ||
| <tr> | ||
| <td colspan="2"><strong>Control Plane Runtime Configuration</strong></td> | ||
| </tr> | ||
| <tr> | ||
| <td><strong>Field</strong></td> | ||
| <td><code>runtime.kubernetes.injector.{{ include.runtime }}</code></td> | ||
| </tr> | ||
| {% if include.runtimeEnv %} | ||
| <tr> | ||
| <td><strong>Environment Variable</strong></td> | ||
| <td><code>KUMA_RUNTIME_KUBERNETES_INJECTOR_{{ include.runtimeEnv }}</code></td> | ||
| </tr> | ||
| {% endif %} | ||
| {% endif %} | ||
| </tbody> | ||
| </table> | ||
| {%- endcapture -%} | ||
| {{ snippet-tproxy-field-table | normalize_whitespace }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| <h3 class="no-anchor">Other configuration options</h3> | ||
|
|
||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th colspan="2" style="text-align: left"> | ||
| <a href="/docs/{{ page.version }}/networking/transparent-proxy/configuration-on-kubernetes/#method-2-configuration-in-configmap"> | ||
| <strong>Configuration in ConfigMap</strong> | ||
| </a> | ||
| </th> | ||
| </tr> | ||
| <tr> | ||
| <th style="text-align: left">Field</th> | ||
| <th style="text-align: left">Environment Variable</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| {% for field in include.data %} | ||
| <tr> | ||
| <td><code>{{ field.path }}</code></td> | ||
| <td><code>{{ field.env }}</code></td> | ||
| </tr> | ||
| {% endfor %} | ||
| </tbody> | ||
| </table> | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th colspan="3" style="text-align: left"> | ||
| <a href="/docs/{{ page.version }}/networking/transparent-proxy/configuration-on-kubernetes/#method-1-control-plane-runtime-configuration"> | ||
| <strong>Control Plane Runtime Configuration</strong> | ||
| </a> | ||
| </th> | ||
| </tr> | ||
| <tr> | ||
| <th style="text-align: left">Field</th> | ||
| <th style="text-align: left">Environment Variable</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| {% for field in include.data %} | ||
| <tr> | ||
| <td><code>{{ field.runtime.path }}</code></td> | ||
| <td><code>{{ field.runtime.env }}</code></td> | ||
| </tr> | ||
| {% endfor %} | ||
| </tbody> | ||
| </table> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm off the opinion of being opiniated and when both are accepted only tolerate one.