Skip to content

docs: improve installation guide with SkyPilot prerequisites #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AlexCuadron wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: improve installation guide with SkyPilot prerequisites #321

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
66d201b
feat: add GCP dependencies to skypilot installation
AlexCuadron Nov 7, 2024
d79adbf
docs: improve installation guide
AlexCuadron Nov 7, 2024
e291015
docs: remove Docker section and version pinning
AlexCuadron Nov 7, 2024
a2c0c8a
Update setup.py
AlexCuadron Nov 7, 2024
7556cfa
Merge branch 'main' into improve-installation-guide
AlexCuadron Nov 15, 2024
acad5db
Merge branch 'main' into improve-installation-guide
AlexCuadron Dec 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 42 additions & 16 deletions docs/source/getting_started/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,61 @@ Installation

.. note::

For Macs, macOS >= 10.15 is required to install SkyShift.
For Macs, macOS >= 10.15 is required to install SkyShift. Apple Silicon-based devices (e.g. Apple M1) must run ``pip uninstall grpcio; conda install -c conda-forge grpcio=1.43.0`` prior to installing SkyShift.

To install SkyShift's python API and CLI, run:
Prerequisites
Copy link
Collaborator

@michaelzhiluo michaelzhiluo Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not true right?

Copy link
Collaborator

@michaelzhiluo michaelzhiluo Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be in cloud section; the mvp for skyshift is over K8s.

Copy link
Contributor Author

@AlexCuadron AlexCuadron Nov 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is true, they need to run sky check at least once. But you are right, it should be merged to the cloud branch

Copy link
Contributor Author

@AlexCuadron AlexCuadron Nov 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no cloud branch, must have been merged into the MVP

------------

SkyShift requires SkyPilot to be installed and configured with at least one cloud provider. Follow these steps to set up your environment:
Copy link
Collaborator

@michaelzhiluo michaelzhiluo Jan 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not required if users only want to use onprem resources.


1. Install SkyPilot with your preferred cloud provider(s):

.. code-block:: shell

# Recommended: Create new conda env to avoid package conflicts.
# Recommended: use a new conda env to avoid package conflicts.
# SkyPilot requires 3.7 <= python <= 3.11.
conda create -y -n skyshift python=3.10
conda activate skyshift

# Pull the latest version of SkyShift from Github.
git clone https://github.com/michaelzhiluo/skyshift.git
# Choose your cloud provider(s):
pip install "skypilot[aws]" # For AWS
pip install "skypilot[gcp]" # For Google Cloud
pip install "skypilot[azure]" # For Azure
pip install "skypilot[all]" # For all supported clouds

# Verify cloud access is properly configured
sky check

# Install basic SkyShift dependencies.
2. Install SkyShift:

.. code-block:: shell

# Pull the latest version of SkyShift
git clone https://github.com/sky-shift/skyshift.git
cd skyshift

# For basic usage (CLI and Python API)
pip install -e .

# For API server deployment
pip install -e .[server]

To install dependencies for the API server, run:
# For development
pip install -e .[dev]

.. code-block:: shell
Cloud Setup
----------

# Recommended: Create new conda env to avoid package conflicts.
conda create -y -n skyshift python=3.10
conda activate skyshift
If you haven't configured your cloud credentials yet, follow the SkyPilot cloud setup guides:

# Pull the latest version of SkyShift from Github.
git clone https://github.com/michaelzhiluo/skyshift.git
- `AWS Setup Guide <https://skypilot.readthedocs.io/en/latest/getting-started/installation.html#amazon-web-services-aws>`_
- `GCP Setup Guide <https://skypilot.readthedocs.io/en/latest/getting-started/installation.html#google-cloud-platform-gcp>`_
- `Azure Setup Guide <https://skypilot.readthedocs.io/en/latest/getting-started/installation.html#azure>`_

# Install API server dependencies.
cd skyshift
pip install -e .[server]
After configuring your cloud credentials, verify the setup:

.. code-block:: shell

sky check

This will show which clouds are properly configured and available for use with SkyShift.
Loading