Kubernetes icon

Kubernetes

Interact with Kubernetes

Pods → Port Forward

AI-generated

Overview

This node interacts with Kubernetes clusters to perform various operations on Kubernetes resources. Specifically, the 'Port Forward' operation allows users to forward one or more local ports to a pod in the Kubernetes cluster, enabling access to the pod's services locally. This is useful for debugging, testing, or accessing services running inside pods without exposing them externally.

Use Case Examples

  1. Forward a local port to a pod to access a web service running inside the pod for testing purposes.
  2. Use port forwarding to connect to a database running inside a Kubernetes pod from a local machine securely.

Properties

Name Meaning
Namespace The Kubernetes namespace where the pod is located. Defaults to 'default' if not specified.
Resource The Kubernetes resource type to operate on, which is 'pods' for port forwarding.
Resource Name The name of the specific pod to which the port forwarding will be applied.

Output

JSON

  • json - The result of the port forwarding operation, typically connection details or status.

Dependencies

  • Requires Kubernetes API credentials to authenticate and interact with the Kubernetes cluster.

Troubleshooting

  • Ensure Kubernetes credentials are correctly configured and have sufficient permissions to perform port forwarding.
  • Verify that the specified pod name exists in the given namespace.
  • Common error: 'Resource name is required for port-forward operation!' indicates the pod name was not provided; specify the pod name to resolve this.
  • Network or firewall issues may prevent successful port forwarding; ensure local ports are available and not blocked.

Links

Discussion