[Core] Add Support for External Links

[lloyd-brown]

This PR adds support for custom links that the user can specify:

• Statically through the CLI sky jobs launch --custom-links 'Docs="https://docs.example.com"' task.yaml
• In the task YAML

name: my-job

links:
  Documentation: https://docs.example.com
  Team Wiki: https://wiki.example.com/team

run: echo "Hello, world!"

• Or at runtime via a file stored in $SKYPILOT_LINKS on running jobs

Our links are stored in a new column in the spot jobs table.

Our runtime link support is implemented by having users write to the new link file on the cluster and by adding logic in the JobsController instance to periodically read these links and update the database.

We've made docs changes with a preview here https://docs.skypilot.co/en/external-link-docs/examples/managed-jobs.html#custom-links

Tested (run the relevant ones):

• Code formatting: install pre-commit (auto-check on commit) or bash format.sh
• Any manual or new tests for this PR (please specify below)
• All smoke tests: /smoke-test (CI) or pytest tests/test_smoke.py (local)
• Relevant individual tests: /smoke-test -k test_name (CI) or pytest tests/test_smoke.py::test_name (local)
• Backward compatibility: /quicktest-core (CI) or pytest tests/smoke_tests/test_backward_compat.py (local)

[gemini-code-assist]

Summary of Changes

Hello @lloyd-brown, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the job monitoring experience by adding comprehensive support for external links. It allows users to define custom links for their jobs and automatically generates cloud-specific instance links, all of which are stored in the database and prominently displayed in the dashboard. This feature aims to provide quick access to relevant external resources and cloud console pages directly from the job details, streamlining debugging and management workflows.

Highlights

• External Links Support: Introduced the ability to associate external links with jobs, allowing users to define custom links that will be displayed in the dashboard.
• Dashboard Integration: Implemented a new section in the job details page of the dashboard to visually present all associated external links, making them easily accessible.
• Automatic Instance Links: Added functionality to automatically generate and store cloud-provider-specific instance console links (for AWS, GCP, and Azure) for launched clusters, enhancing observability.
• Database Schema Updates: Modified the database schemas for both global user state and spot jobs to include a new 'links' column, persisting external link information.
• API and Protobuf Changes: Updated the API response schemas and protobuf definitions to include the new 'links' field, ensuring consistency across the system.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds support for displaying external links associated with jobs in the dashboard. The changes span the backend, database, and frontend, including schema migrations to store links, logic to auto-populate instance console URLs, and UI components to render them. The implementation is solid, but I've identified a few areas for improvement: a leftover debug log, an inconsistent type in a database migration, incorrect revision IDs in another migration's docstring, and a redundant code statement.

[lloyd-brown]

/quicktest-core --base-branch pypi/skypilot
/smoke-test -k test_managed_jobs_runtime_links --kubernetes
/smoke-test -k test_managed_jobs_cli_custom_links --kubernetes
/smoke-test -k test_managed_jobs_runtime_links --gcp
/smoke-test -k test_managed_jobs_cli_custom_links --gcp

[lloyd-brown]

/build-docs

[github-actions]

❌ Failed to trigger ReadTheDocs build for branch lloyd/external-links. Please check the workflow logs for details.