comments

skypilot-org · Sep 10, 2024 · 3e7ae9e · 3e7ae9e
1 parent c38eb65
commit 3e7ae9e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/docs/source/reference/kubernetes/kubernetes-deployment.rst b/docs/source/reference/kubernetes/kubernetes-deployment.rst
@@ -35,6 +35,13 @@ Below we include minimal guides to set up a new Kubernetes cluster in different
 
         Amazon's hosted Kubernetes service.
 
+    .. grid-item-card::  On-demand Cloud VMs
+        :link: kubernetes-setup-ondemand
+        :link-type: ref
+        :text-align: center
+
+        We provide scripts to deploy k8s on on-demand cloud VMs.
+
 .. _kubernetes-setup-kind:
 
 
@@ -267,4 +274,15 @@ After the GPU operator is installed, create the nvidia RuntimeClass required by
     metadata:
       name: nvidia
     handler: nvidia
-    EOF
+    EOF
+
+
+.. _kubernetes-setup-ondemand:
+
+Deploying on cloud VMs
+^^^^^^^^^^^^^^^^^^^^^^
+
+You can also spin up on-demand cloud VMs and deploy Kubernetes on them.
+
+We provide scripts to take care of provisioning VMs, installing Kubernetes, setting up GPU support and configuring your local kubeconfig.
+Refer to our `Deploying Kubernetes on VMs guide <https://github.com/skypilot-org/skypilot/tree/master/examples/k8s_cloud_deploy>`_ for more details.
diff --git a/examples/k8s_cloud_deploy/README.md b/examples/k8s_cloud_deploy/README.md
@@ -8,19 +8,22 @@ This example demonstrates how to deploy a Kubernetes cluster on the cloud with S
 pip install "skypilot-nightly[lambda,kubernetes]"
 ```
 
-2. On your lambda cloud dashboard, configure the firewall to allow inbound connections on port `443` and `6443` (required to expose k8s API server).
+2. Use a cloud which supports opening ports on SkyPilot or manually expose ports 6443 and 443 on the VMs. This is required to expose k8s API server. 
+
+   For example, if using lambda cloud, configure the firewall on the lambda cloud dashboard to allow inbound connections on port `443` and `6443`.
 
 <p align="center">
 <img src="https://i.imgur.com/uSA7BMH.png" alt="firewall" width="500"/>
 </p>
 
 ## Instructions
 
-1. Edit `cloud_k8s.yaml` to set the desired number of workers and GPUs per node.
+1. Edit `cloud_k8s.yaml` to set the desired number of workers and GPUs per node. If using GCP, AWS or Azure, uncomment the ports line to allow inbound connections to the Kubernetes API server. 
 ```yaml
 resources:
   cloud: lambda
   accelerators: A10:1
+  # ports: 6443
 
 num_nodes: 2
 ```