Skip to content
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.

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

[docs] Docs for sky check specific cloud #3558

Merged
merged 1 commit into from
May 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/source/getting-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ section :ref:`below <cloud-account-setup>`.
If your clouds show ``enabled`` --- |:tada:| |:tada:| **Congratulations!** |:tada:| |:tada:| You can now head over to
:ref:`Quickstart <quickstart>` to get started with SkyPilot.

.. tip::

To check credentials only for specific clouds, pass the clouds as arguments: :code:`sky check aws gcp`

.. _cloud-account-setup:

Cloud account setup
Expand Down
12 changes: 11 additions & 1 deletion sky/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -2862,7 +2862,7 @@ def _down_or_stop(name: str):
progress.refresh()


@cli.command()
@cli.command(cls=_DocumentedCodeCommand)
@click.argument('clouds', required=False, type=str, nargs=-1)
@click.option('--verbose',
'-v',
Expand All @@ -2881,6 +2881,16 @@ def check(clouds: Tuple[str], verbose: bool):

The enabled clouds are cached and form the "search space" to be considered
for each task.

Examples:

.. code-block:: bash

# Check credentials for all supported clouds.
sky check
\b
# Check only specific clouds - AWS and GCP.
sky check aws gcp
"""
clouds_arg = clouds if len(clouds) > 0 else None
sky_check.check(verbose=verbose, clouds=clouds_arg)
Expand Down
Loading