Skip to content

Commit fce53b0

Browse files
author
Yoichi Kawasaki
committed
Added description
1 parent 4e586f8 commit fce53b0

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,10 @@ pubkey=/Users/yokawasa/.ssh/id_rsa_k8s.pub
7373

7474
#### SSH Agent (ssh-agent)
7575

76-
The plugin automatically check if there are any `ssh-agents` started running by the plugin, and if `ssh-agent` not found, the plugin starts `ssh-agent` and adds SSH Identity key into the agent before SSH login. If the command find that ssh-agent is already running, it doesn't start a new agent, and re-use the agent.
77-
You can kill the created agent with `--cleanup-agent` at the end of command.
76+
The plugin automatically check if there are any `ssh-agents` started running by the plugin, and starts `ssh-agent`if it doesn't find any `ssh-agent` running and adds SSH Identity key into the agent before SSH login. If the command find that ssh-agent is already running, it doesn't start a new agent, and re-use the agent.
77+
Add `--cleanup-agent` option if you want to kill the created agent at the end of command.
7878

79-
In addtion, you can skip starting `ssh-agent` by giving `--skip-agent`. This is actually a case where you already have ssh-agent managed.
79+
In addtion, add `--skip-agent` option if you want to skip automatic starting `ssh-agent`. This is actually a case where you already have ssh-agent managed or you want to manually start the agent.
8080

8181
### Examples
8282

@@ -166,6 +166,11 @@ $ kubectl ssh aks-nodepool1-18558189-0 \
166166
$ ssh-agent -k
167167
```
168168
169+
## Useful Links
170+
- [Extend kubectl with plugins](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/)
171+
- [Write your own kubectl subcommands](https://ahmet.im/blog/kubectl-plugins/)
172+
- [SSH-AGENT - SINGLE SIGN-ON USING SSH](https://www.ssh.com/ssh/agent)
173+
169174
## Contributing
170175
171176
Bug reports and pull requests are welcome on GitHub at https://github.com/yokawasa/kubectl-plugin-ssh-jumphost

0 commit comments

Comments
 (0)