diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 7507cd90..81873f3d 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -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 +------------ + +SkyShift requires SkyPilot to be installed and configured with at least one cloud provider. Follow these steps to set up your environment: + +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 `_ +- `GCP Setup Guide `_ +- `Azure Setup Guide `_ - # 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.