From 3b6d1f3f84d6577cd686fbb21989e0729799a7b8 Mon Sep 17 00:00:00 2001
From: Jonas Forsberg <jonas.m.forsberg@advania.se>
Date: Thu, 13 Mar 2025 08:46:03 +0100
Subject: [PATCH] documented kubectl-rsh

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 19523b9..e52020c 100644
--- a/README.md
+++ b/README.md
@@ -10,3 +10,16 @@ Verify that the scripts are picked up in `kubectl`
 ```
 kubectl plugin list
 ```
+
+## kubectl-rsh
+
+Usage:
+  kubectl rsh [nodeName]
+
+### Variables
+| Name | Default | Desciption |
+|------|---------|------------|
+| KUBECTL_RSH_IMAGE | docker.io/library/busybox | The image used by the pod creating the shell |
+| KUBECTL_RSH_IMAGE_TAG | latest | Image tag to use |
+| KUBECTL_RSH_NAMESPACE | default | Namespace to create the rsh pod in |
+| KUBECTL_RSH_POD_CREATE_TIMEOUT | 3 | Minutes to wait before failing to create pod |