docs(cli): update truss ssh setup docstring for model support#2393
Merged
Conversation
truss ssh setup's docstring claims training-only scope and shows a hostname format (<job-id>-<replica>...) that predates the training-job- prefix that proxy_command.py now requires. Update the docstring to match current behavior: both training jobs and model deployments, correct hostname formats.
|
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates truss ssh setup CLI help text to reflect that SSH access supports both training jobs and model deployments, and refreshes the hostname examples to current formats.
Changes:
- Broaden wording from “training jobs” to “workloads”.
- Replace the legacy training-job hostname example with current training-job and model-deployment examples.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+43
to
+53
| """One-time setup: configure SSH access for Baseten workloads. | ||
|
|
||
| Generates an SSH keypair, installs a ProxyCommand script, and adds a | ||
| wildcard Host entry to ~/.ssh/config. After running this once, connect | ||
| to any running training job with: | ||
| to any running workload with: | ||
|
|
||
| ssh <job-id>-<replica>.<remote>.ssh.baseten.co | ||
| # Training job | ||
| ssh training-job-<job_id>-<node>.ssh.baseten.co | ||
|
|
||
| Example: ssh 5wo5n3y-0.dev.ssh.baseten.co | ||
| # Model deployment (requires runtime.remote_ssh.enabled) | ||
| ssh model-<model_id>-<deployment_id>.ssh.baseten.co |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
truss ssh setup's docstring claims training-only scope, but the proxy script has handled model hostnames since Remote SSH support for model containers #2377.<job-id>-<replica>...) predates thetraining-job-prefix thatproxy_command.py:120now requires, so copy-pasting it would fail.Change
Docstring-only update to
truss/cli/ssh_commands.py: