Skip to content

Commit ee4cdac

Browse files
committed
Update Readme
1 parent 408a4e4 commit ee4cdac

File tree

1 file changed

+3
-12
lines changed

1 file changed

+3
-12
lines changed

README.md

+3-12
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This SSH proxy can be deployed as a standalone docker container that allows to p
3737

3838
### Prerequisites
3939

40-
The target containers must run an SSH server and provide a valid public key via a `/publickey` endpoint. If this does not exist, the ssh-proxy tries to exec into the target container and search for the publickey under under `$SSH_TARGET_KEY_PATH` (default: `~/.ssh/id_ed25519.pub`).
40+
The target containers must run an SSH server and provide a valid public key. The ssh-proxy container will try to get a key from a target container via a `/publickey` endpoint; if this does not exist, the ssh-proxy tries to exec into the target container and search for the publickey under `$SSH_TARGET_KEY_PATH` (default: `~/.ssh/id_ed25519.pub`).
4141

4242
> ℹ️ _The SSH proxy accepts an incoming key, if it belongs to one of the targets key, in other words the proxy/bastion server authorizes all target public keys. It is still not possible to login to the proxy directly. The authorization happens only for creating and tunneling the final connection._
4343
@@ -55,21 +55,12 @@ You can avoid those requirements by setting `$MANUAL_AUTH_FILE=true` and maintai
5555
docker run -d \
5656
-p 8091:22 \
5757
-v /var/run/docker.sock:/var/run/docker.sock \
58-
--env SSH_PERMIT_TARGET_HOST=<some-name> \
5958
mltooling/ssh-proxy
6059
```
6160

6261
#### Kubernetes
6362

64-
_WIP_
65-
66-
```bash
67-
docker run -d \
68-
-p 8091:22 \
69-
-v /root/.kube/config:/root/.kube/config \
70-
--env SSH_PERMIT_TARGET_HOST=<some-name-prefix> \
71-
mltooling/ssh-proxy
72-
```
63+
If you make a kube config available to the container, either via incluster config (Python code: `kubernetes.config.load_incluster_config()`) or by mounting it to `/root/.kube/config`, ssh-proxy also works for tunneling requests in Kubernetes.
7364

7465
### Connect to Target
7566

@@ -108,7 +99,7 @@ The container can be configured with the following environment variables (`--env
10899
</tr>
109100
<tr>
110101
<td>SSH_TARGET_PUBLICKEY_API_PORT</td>
111-
<td>Port where the target pod exposes the /publickey endpoint (if used).</td>
102+
<td>Port where the target container exposes the /publickey endpoint (if used).</td>
112103
<td>8080</td>
113104
</tr>
114105
<tr>

0 commit comments

Comments
 (0)