[PodPool-VK] add podpool vk README (#4250) (#4251)

lw309637554 · rueian · web-flow · commit 162cafcdb5c7 · 2025-12-11T02:33:43.000+09:00
* [PodPool-VK] add podpool vk README (#4250) * Fix lint Signed-off-by: Rueian <rueiancsie@gmail.com> * Update podpool-vk/README.md Signed-off-by: Rueian <rueiancsie@gmail.com> * fix lint Signed-off-by: Rueian <rueiancsie@gmail.com> * rename podpool-vk to podpool --------- Signed-off-by: Rueian <rueiancsie@gmail.com> Co-authored-by: Rueian <rueiancsie@gmail.com>
diff --git a/podpool/README.md b/podpool/README.md
@@ -0,0 +1,13 @@
+# KubeRay Pod Pool Virtual Kubelet
+
+KubeRay Pod Pool Virtual Kubelet is an optional and standalone component of the KubeRay Ecosystem.
+It provides warmed-up pod pools by registering itself as a virtual kubelet to a Kubernetes cluster.
+When KubeRay requests pods from the virtual kubelet,
+the actual pods are taken from one of the pod pools specified by the users and effectively skip:
+
+* resource scheduling time
+* image pulling time
+* volume preparation time
+because those pods are already active and waiting in pools.
+
+<!-- TODO: Add docs for local development -->
diff --git a/podpool/cmd/main.go b/podpool/cmd/main.go
@@ -0,0 +1 @@
+package cmd
diff --git a/podpool/controller/controller.go b/podpool/controller/controller.go
@@ -0,0 +1 @@
+package controller
diff --git a/podpool/go.mod b/podpool/go.mod
@@ -0,0 +1,3 @@
+module github.com/ray-project/kuberay/podpool-vk
+
+go 1.24.8
diff --git a/podpool/manager/manager.go b/podpool/manager/manager.go
@@ -0,0 +1 @@
+package manager
diff --git a/podpool/test/controller_test.go b/podpool/test/controller_test.go
@@ -0,0 +1 @@
+package test
diff --git a/podpool/test/manager_test.go b/podpool/test/manager_test.go
@@ -0,0 +1 @@
+package test

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module github.com/ray-project/kuberay/podpool-vk`
	`2`	`+`
	`3`	`+go 1.24.8`