[Docs] Multiple k8s support #4586
Conversation
|
Added the figure. Ready for review @romilbhardwaj. |
|
|
||
| In this example, we have two Kubernetes clusters: ``my-h100-cluster`` and ``my-tpu-cluster``, and each Kubernetes cluster has a context for it. | ||
|
|
||
| Point to a Kubernetes Cluster and Launch |
There was a problem hiding this comment.
I think we need to have a section on adding contexts to allowed_contexts". If allowed_contexts is not set, I believe --region will not work, we will only use the active context.
There was a problem hiding this comment.
Might be good to clearly mark section titles:
Step 1 - Set Up Credentials for Multiple Kubernetes Clusters
Step 2 - Configure SkyPilot to access multiple clusters
Then have sections on launching, show-gpus, failover etc.
There was a problem hiding this comment.
As the final check, we have the users run sky check kubernetes as a way to verify which contexts are available to SkyPilot.
There was a problem hiding this comment.
Good point! Updated the doc. PTAL.
Co-authored-by: Romil Bhardwaj <[email protected]>
Co-authored-by: Romil Bhardwaj <[email protected]>
…into multi-k8s-docs-v2
| @@ -245,10 +245,10 @@ def _format_enabled_cloud(cloud_name: str) -> str: | |||
| # here we are using rich. We should migrate this file to | |||
| # use colorama as we do in the rest of the codebase. | |||
| symbol = ('└── ' if i == len(existing_contexts) - 1 else '├── ') | |||
| contexts_formatted.append(f'\n {symbol}{context}') | |||
| contexts_formatted.append(f'\n {symbol}{context}') | |||
There was a problem hiding this comment.
Reduced the indent for cleaner view, cc'ing @romilbhardwaj : )
There was a problem hiding this comment.
hmm I prefer the older format with the indent since it visually distinguishes the context as a sub-item under Kubernetes, making it clearer that it's part of Kubernetes rather than another top-level entry (cloud).
Not feeling too strongly though
There was a problem hiding this comment.
I feel the color should distinguish it well. The problem I had with the indent was that when my contexts are long and multiple contexts are specified in ~/.sky/config.yaml. The multiple level of indents make it a bit annoying:
|
Just a kind reminder for this @romilbhardwaj : ) |
| @@ -0,0 +1,146 @@ | |||
| .. _multi-kubernetes: | |||
|
|
|||
| Multi-Kubernetes Clusters | |||
There was a problem hiding this comment.
Multi-Kubernetes Clusters is a bit confusing; how about any of these:
- Multiple Kubernetes Clusters
- Multi-cluster Kubernetes
- Kubernetes multi-cluster
"Multi-cluster" seems to be a common term: https://www.cncf.io/blog/2021/04/12/simplifying-multi-clusters-in-kubernetes/, https://www.mirantis.com/cloud-native-concepts/getting-started-with-kubernetes/what-is-kubernetes-multi-cluster/, https://www.kubecost.com/kubernetes-multi-cloud/kubernetes-multi-cluster/
There was a problem hiding this comment.
I reverted it back to Multiple Kubernetes Clusters. The reason for the change was that the New badge gets to a new line with this title, but it should be fine, as I feel Multiple Kubernetes Cluster has the widest audiance.
| @@ -245,10 +245,10 @@ def _format_enabled_cloud(cloud_name: str) -> str: | |||
| # here we are using rich. We should migrate this file to | |||
| # use colorama as we do in the rest of the codebase. | |||
| symbol = ('└── ' if i == len(existing_contexts) - 1 else '├── ') | |||
| contexts_formatted.append(f'\n {symbol}{context}') | |||
| contexts_formatted.append(f'\n {symbol}{context}') | |||
There was a problem hiding this comment.
hmm I prefer the older format with the indent since it visually distinguishes the context as a sub-item under Kubernetes, making it clearer that it's part of Kubernetes rather than another top-level entry (cloud).
Not feeling too strongly though
Co-authored-by: Romil Bhardwaj <[email protected]>
Co-authored-by: Romil Bhardwaj <[email protected]>
Co-authored-by: Romil Bhardwaj <[email protected]>
Co-authored-by: Romil Bhardwaj <[email protected]>
…into multi-k8s-docs-v2
Tested (run the relevant ones):
bash format.shpytest tests/test_smoke.pypytest tests/test_smoke.py::test_fill_in_the_nameconda deactivate; bash -i tests/backward_compatibility_tests.sh