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 |