Skip to content

call out go template limitations #3275

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

Merged
merged 1 commit into from
May 27, 2025
Merged

call out go template limitations #3275

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 20 additions & 8 deletions docs/vendor/admin-console-port-forward.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,26 @@ To port forward a service with KOTS for existing cluster installations:
servicePort: 3000
localPort: 8888
```

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.

1. For `ports.servicePort`, add the `containerPort` of the Pod where the service is running. This is the port where KOTS forwards traffic.

<ServicePortNote/>

1. For `ports.localPort`, add the port to map on the local workstation.
The following table provides more information about how to configure each field:

<table>
<tr>
<td>Field</td>
<td>Instructions</td>
</tr>
<tr>
<td>`ports.serviceName`</td>
<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>
</tr>
<tr>
<td>`ports.servicePort`</td>
<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>
</tr>
<tr>
<td>`ports.localPort`</td>
<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>
</tr>
</table>

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

Expand Down