Skip to content

Commit 5e2c91f

Browse files
authored
Modified Portforward Section to Kubectl Section (#5236)
1 parent b456bcc commit 5e2c91f

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

docs/user-guide/resource-browser.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -452,13 +452,11 @@ spec:
452452
453453
---
454454
455-
## Port Forwarding
455+
## Running Kubectl Commands Locally
456456
457457
### Introduction
458458
459-
Assume your applications are running in a Kubernetes cluster on cloud. Now, if you wish to test or debug them on your local machine, you can perform [port forwarding](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/). It creates a tunnel between a port on your machine and a port on a resource within your cluster. Therefore, you can access applications running inside the cluster as though they are running locally on your machine.
460-
461-
But first, you would need access to that cluster. Traditionally, the kubeconfig file (`./kube/config`) helps you connect with the cluster.
459+
If you wish to run kubectl commands from your local system, you need to have access to your cluster. Traditionally, the kubeconfig file (`./kube/config`) helps you connect with the cluster from your local system.
462460

463461
![Figure 21: Kubeconfig File](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/kubeconfig.jpg)
464462

@@ -520,7 +518,16 @@ If you are not a super-admin and can't generate a token yourself, you can find t
520518

521519
3. Test the connection to the cluster by running any kubectl command, e.g., `kubectl get ns` or `kubectl get po -A`
522520

523-
4. Once you have successfully connected to the cluster, you may run the port-forward command. Refer [kubectl port-forward](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/) to see a few examples.
521+
{% hint style="info" %}
522+
### Additional References
523+
Once the connection is successful, you may run any [kubectl operations](https://kubernetes.io/docs/reference/kubectl/#operations) from your system.
524+
{% endhint %}
525+
526+
### Use Case - Port Forwarding
527+
528+
Assume your applications are running in a Kubernetes cluster on cloud. Now, if you wish to test or debug them on your local machine, you can perform [port forwarding](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/). It creates a tunnel between a port on your machine and a port on a resource within your cluster. Therefore, you can access applications running inside the cluster as though they are running locally on your machine.
529+
530+
Once you have successfully connected to the cluster, you may run the port-forward command. Refer [kubectl port-forward](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/) to see a few examples.
524531

525-
![Figure 24: Example - Port Forwarding](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/port-forward.gif)
532+
![Figure 24: Example - Port Forwarding](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/port-forward.gif)
526533

0 commit comments

Comments
 (0)