docs: document OPENSHELL_SSH_HANDSHAKE_SECRET in Getting Started#1287
Conversation
The Podman and Kubernetes compute drivers require OPENSHELL_SSH_HANDSHAKE_SECRET to be set. This was introduced in 2e0afea ("feat(vm): derive guest rootfs from sandbox images (NVIDIA#957)"), which exempted only the Docker and VM drivers from the check. The Getting Started instructions in CONTRIBUTING.md didn't mention the variable, so developers using Podman (the default on systems where it is installed) hit an opaque configuration error on first run. Add the export as a separate setup step with a comment explaining which drivers require it. Signed-off-by: Russell Bryant <russell.bryant@gmail.com>
|
All contributors have signed the DCO ✍️ ✅ |
|
I have read the DCO document and I hereby sign the DCO. |
|
Hey @russellb - I was actually looking at removing the handshake altogether; we already have some auth guarantees with mTLS from the supervisor to gateways and we don't use it from the client to the gateways (I have a draft PR in flight for this, see #1274). It was originally needed when gateways initiated traffic to the supervisors, but as of 0.0.37 the traffic is switched (supervisors connect to the gateways) and we push the ssh traffic from the client to the sandbox over the grpc connection. So its original purpose is no longer needed. So we may not need to document this going forward. Wdyt? |
maxamillion
left a comment
There was a problem hiding this comment.
+1 good catch, thank you!
Summary
Add
OPENSHELL_SSH_HANDSHAKE_SECRETto the Getting Started section in CONTRIBUTING.md. The Podman and Kubernetes compute drivers require this variable, but it was never documented in the dev setup instructions. Developers using Podman (the default when it's installed) hit an opaque configuration error on first run.Related Issue
Introduced by 2e0afea ("feat(vm): derive guest rootfs from sandbox images (#957)"), which added the requirement but exempted only Docker and VM drivers.
Changes
export OPENSHELL_SSH_HANDSHAKE_SECRET=dev-secretstep to the Getting Started code block in CONTRIBUTING.mdTesting
mise run pre-commitpasses (pre-existingpython:protofailure on main, unrelated)Checklist