You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Improved SkyPilot Documentation and Removed Unused Sandbox Script
### TL;DR
Enhanced SkyPilot documentation with dashboard access instructions and
improved shell aliases, while removing an unused sandbox script.
### What changed?
- Removed the unused `devops/sandbox.sh` script that was only running an
infinite loop
- Added documentation for accessing the SkyPilot web dashboard with
authentication instructions
- Updated shell aliases documentation to match the current aliases
- Removed the requirement for AWS ECR access in us-east-1 region from
prerequisites
### How to test?
1. Try accessing the SkyPilot dashboard using the new instructions:
- Visit https://skypilot-api.softmax-research.net/
- Use credentials from `~/.sky/config.yaml` or by running `sky api info`
2. Source the updated shell script to verify the aliases work correctly:
```bash
source ./devops/skypilot/setup_shell.sh
jj # Should list active jobs
```
### Why make this change?
- The sandbox script was unused and could be safely removed
- The dashboard access instructions help users monitor their jobs more
effectively
- Improved documentation makes the SkyPilot tooling more accessible to
team members
[Asana
Task](https://app.asana.com/1/1209016784099267/project/1210348820405981/task/1210630741514021)
Copy file name to clipboardExpand all lines: devops/skypilot/README.md
+49-45Lines changed: 49 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,6 @@ This script provides a convenient way to launch training jobs on AWS using SkyPi
5
5
## Prerequisites
6
6
7
7
- AWS credentials configured with `softmax` profile
8
-
- Access to AWS ECR in us-east-1 region
9
8
- SkyPilot CLI installed and configured
10
9
- Git repository with pushed commits (unless using `--skip-git-check`)
11
10
@@ -28,11 +27,20 @@ For a complete list of optional parameters and their descriptions, use:
28
27
./devops/skypilot/launch.py --help
29
28
```
30
29
30
+
## Accessing the Dashboard
31
+
32
+
There's a [web dashboard](https://skypilot-api.softmax-research.net/) that displays the status of all clusters and jobs.
33
+
34
+
To sign in, you'll need user/password credentials. You can obtain these by peeking into the URL in your `~/.sky/config.yaml`, or by running `sky api info`.
35
+
36
+
Warning: if you click the URL with `https://user:password@...` pair in the terminal, it will load the dashboard, but it might show up as empty. To fix this, you'll need to open a new tab with the [dashboard](https://skypilot-api.softmax-research.net/)**without** the user:password pair.
37
+
31
38
## Examples
32
39
33
40
### Basic Usage
34
41
35
42
1.**Launch a training run with default parameters:**
0 commit comments