diff --git a/docs/vendor/admin-console-port-forward.mdx b/docs/vendor/admin-console-port-forward.mdx index 4a0e440046..f860caf21a 100644 --- a/docs/vendor/admin-console-port-forward.mdx +++ b/docs/vendor/admin-console-port-forward.mdx @@ -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. - - - - 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: + + + + + + + + + + + + + + + + + + +
FieldInstructions
`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.
`ports.servicePort`

Add the `containerPort` of the Pod where the service is running. This is the port where KOTS forwards traffic.

Go templates are not supported in the `localPort` or `servicePort` field. For more information, see [`ports`](/reference/custom-resource-application#ports) in _Application_.

`ports.localPort`

Add the port to map on the local workstation.

Go templates are not supported in the `localPort` or `servicePort` field. For more information, see [`ports`](/reference/custom-resource-application#ports) in _Application_..

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