Doc: add doc for ~/.sky/config.yaml. #2230
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Michaelvll
approved these changes
Jul 20, 2023
There was a problem hiding this comment.
Thanks for adding this @concretevitamin! It looks pretty good to me. The only one thought is that should we add the instructions for how to create the VPC/subnets with only private IPs on AWS from #1512 to somewhere in the doc?
Comment on lines
203
to
210
|
|
||
| To instruct SkyPilot to use a specific VPC, you can use SkyPilot's global config | ||
| file ``~/.sky/config.yaml`` to specify the VPC name. See the ``aws.vpc_name`` | ||
| field in :ref:`config-yaml`. | ||
|
|
||
| Example use cases include using a private VPC or a VPC with fine-grained | ||
| constraints, typically created via Terraform or manually. By default, SkyPilot | ||
| uses the "default" VPC in each region. |
There was a problem hiding this comment.
Do we want to include the detailed instructions of how to create VPC with only private IP from #1512 here?
There was a problem hiding this comment.
Added a pointer to the PR. We can wait for feedback to see if adding manual creation instructions is worthwhile? Reason is the target user may actually prefer using Terraform.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2222.
Tested (run the relevant ones):
bash format.shpytest tests/test_smoke.pypytest tests/test_smoke.py::test_fill_in_the_namebash tests/backward_comaptibility_tests.sh