Skip to content

Commit ad3cec2

Browse files
authored
Merge pull request #3275 from replicatedhq/local-port-templ-func-limitation
call out go template limitations
2 parents 2dc0a7e + f3c6374 commit ad3cec2

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

docs/vendor/admin-console-port-forward.mdx

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,26 @@ To port forward a service with KOTS for existing cluster installations:
4141
servicePort: 3000
4242
localPort: 8888
4343
```
44-
45-
1. For `ports.serviceName`, add the name of the service. KOTS can create a port forward to ClusterIP, NodePort, or LoadBalancer services. For more information about Kubernetes service types, see [Service](https://kubernetes.io/docs/concepts/services-networking/service/) in the Kubernetes documentation.
46-
47-
1. For `ports.servicePort`, add the `containerPort` of the Pod where the service is running. This is the port where KOTS forwards traffic.
48-
49-
<ServicePortNote/>
50-
51-
1. For `ports.localPort`, add the port to map on the local workstation.
44+
The following table provides more information about how to configure each field:
45+
46+
<table>
47+
<tr>
48+
<td>Field</td>
49+
<td>Instructions</td>
50+
</tr>
51+
<tr>
52+
<td>`ports.serviceName`</td>
53+
<td>Add the name of the service. KOTS can create a port forward to ClusterIP, NodePort, or LoadBalancer services. For more information about Kubernetes service types, see [Service](https://kubernetes.io/docs/concepts/services-networking/service/) in the Kubernetes documentation.</td>
54+
</tr>
55+
<tr>
56+
<td>`ports.servicePort`</td>
57+
<td><p>Add the `containerPort` of the Pod where the service is running. This is the port where KOTS forwards traffic.</p><p>Go templates are not supported in the `localPort` or `servicePort` field. For more information, see [`ports`](/reference/custom-resource-application#ports) in _Application_.</p><ServicePortNote/></td>
58+
</tr>
59+
<tr>
60+
<td>`ports.localPort`</td>
61+
<td><p>Add the port to map on the local workstation.</p><p>Go templates are not supported in the `localPort` or `servicePort` field. For more information, see [`ports`](/reference/custom-resource-application#ports) in _Application_..</p></td>
62+
</tr>
63+
</table>
5264

5365
1. Promote the release to the channel that you use for internal testing, then install in a development environment to test your changes.
5466

0 commit comments

Comments
 (0)