-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(website): added documentation for the port forwarding feature (#…
…9844) * docs(website): added documentation for the port forwarding feature Signed-off-by: Shipra Singh <[email protected]> * docs(website): fixed SME comment Signed-off-by: Shipra Singh <[email protected]> * docs(website): minor edit Signed-off-by: Shipra Singh <[email protected]> --------- Signed-off-by: Shipra Singh <[email protected]>
- Loading branch information
Showing
9 changed files
with
82 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+67.4 KB
website/docs/kubernetes/img/verifying-the-port-forwarding-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,82 @@ | ||
--- | ||
sidebar_position: 13 | ||
title: Configuring port forwarding | ||
description: Configuring port forwarding for a Kubernetes pod or service | ||
keywords: [podman desktop, podman, port forwarding, objects, kubernetes] | ||
tags: [Configuring-port-forwarding, port-forwarding] | ||
--- | ||
|
||
# Configuring port forwarding | ||
|
||
Within a Kubernetes cluster, you can access an application by its internal IP address. But, if you want to access the application from your local machine, use the port forwarding feature. Using UI, you can forward a local port to a port on the pod that runs your application. This way you can interact with the application running in a Kubernetes cluster from your local machine for debugging and testing purposes. | ||
|
||
You can use the port forwarding feature for the pods and services running on a Kubernetes cluster. Also, you can perform port forwarding for any exposed ports. | ||
|
||
#### Prerequisites | ||
|
||
Make sure you have: | ||
- A [running Podman machine](/docs/podman/creating-a-podman-machine). | ||
- A running Kubernetes cluster, such as [Kind](/docs/kind/creating-a-kind-cluster) or [Minikube](/docs/minikube/creating-a-minikube-cluster). | ||
- Created a YAML configuration file with an exposed port: | ||
|
||
```yaml | ||
apiVersion: v1 | ||
kind: Pod | ||
metadata: | ||
name: static-web | ||
spec: | ||
containers: | ||
- image: nginx | ||
name: web | ||
ports: | ||
- containerPort: 80 | ||
name: web | ||
protocol: TCP | ||
``` | ||
#### Procedure: Start port forwarding | ||
1. Create a Kubernetes pod: | ||
1. Go to the **Pods** component page. | ||
1. Click **Play Kubernetes YAML**. | ||
![play kubernetes yaml](img/play-kubernetes-yaml.png) | ||
1. Select a Kubernetes YAML file, such as `pod.yaml` from your local machine. | ||
1. Set the **Runtime** field to `Kubernetes cluster`. | ||
![set runtime field](img/play-a-yaml-file.png) | ||
1. Click **Play** and then **Done**. | ||
1. View the newly created pod that runs on a Kubernetes cluster on the same page. | ||
![view the newly created pod](img/new-kubernetes-pod.png) | ||
1. Click the name of the pod and select the **Summary** tab. | ||
|
||
1. Click the **Forward...** button corresponding to the port you want to use for port forwarding. | ||
![forward button](img/forward-button.png) | ||
1. Click the **Open** button to view the running application in a web browser. | ||
![open button](img/open-button.png) | ||
|
||
:::note | ||
|
||
You can also start port forwarding from the **Kubernetes > Services** component page. After creating a service, click the name of the service and configure port forwarding in the **Summary** tab. | ||
|
||
::: | ||
|
||
#### Procedure: Stop port forwarding | ||
|
||
You can stop port forwarding by using one of the following ways: | ||
|
||
**_Use the component page_** | ||
1. Go to the **Pods** or **Kubernetes > Services** page. | ||
1. Click the name of the Kubernetes pod or service for which you want to stop port fowarding. | ||
1. Click **Remove** in the Summary tab. The entry is removed from the **Kubernetes > Port Forwarding** page. | ||
![using component page](img/stop-port-forwarding-pod.png) | ||
|
||
**_Use the Port Forwarding page_** | ||
|
||
1. Go to the **Kubernetes > Port Forwarding** page. | ||
1. Click the **Delete** icon corresponding to the pod or servivce for which you want to stop port forwarding. The entry is removed from the page. | ||
![using port forwarding page](img/delete-icon-on-port-forwarding-page.png) | ||
|
||
#### Verification | ||
|
||
1. Go to the **Kubernetes > Port Forwarding** page. | ||
1. View the port forwarding details for Kubernetes pods and services. | ||
![verifying port forwarding details](img/verifying-the-port-forwarding-details.png) |