feat(init): scaffold guaranteed qos pod resources

Author: acmore

docs/command-reference.md

@@ -66,7 +66,7 @@
 - Pod-only setups default to `.okdev.yaml`.
 - When built-in workload scaffolding also writes files under `.okdev/`, the config is written as `.okdev/okdev.yaml`.
 - `--workload`: chooses the scaffold mode. `pod` keeps the current simple config shape; `job` and `pytorchjob` add a `spec.workload` block plus a starter manifest; `generic` requires explicit inject information and can optionally use a preset such as `--generic-preset deployment`.
-- `--dev-image`: sets the dev container image for pod workloads. When provided, the generated config includes a `podTemplate` with the given image.
+- `--dev-image`: sets the dev container image for pod workloads. Pod configs generated from the built-in template include a `podTemplate` with the dev container image plus equal CPU/memory requests and limits for the dev container and sidecar, so the starter pod is eligible for Kubernetes `Guaranteed` QoS.
 - `--template`: accepts built-in `basic`, a user template name from `~/.okdev/templates/`, a file path, or a URL.
 - For built-in templates, it also writes a starter local `.stignore` file for the initialized sync root.
 - For built-in `basic`, `job` and `pytorchjob` scaffold `.okdev/job.yaml` or `.okdev/pytorchjob.yaml`. When the config itself is `.okdev/okdev.yaml`, the generated `manifestPath` stays relative to that directory, for example `job.yaml` or `pytorchjob.yaml`. okdev resolves those paths from `.okdev/` first and falls back to the project root for compatibility with older layouts. `generic --generic-preset deployment` scaffolds `.okdev/deployment.yaml` while still using `spec.workload.type=generic`.

internal/cli/init_test.go

@@ -300,6 +300,27 @@ func TestInitUsesRootConfigForPod(t *testing.T) {
 	if _, err := os.Stat(filepath.Join(tmp, ".okdev.yaml")); err != nil {
 		t.Fatalf("expected root config, got err=%v", err)
 	}
+	cfgRaw, err := os.ReadFile(filepath.Join(tmp, ".okdev.yaml"))
+	if err != nil {
+		t.Fatalf("read config: %v", err)
+	}
+	cfg := string(cfgRaw)
+	for _, want := range []string{
+		"podTemplate:",
+		"name: dev",
+		"image: ubuntu:22.04",
+		"resources:",
+		"cpu: \"500m\"",
+		"memory: 512Mi",
+		"cpu: \"250m\"",
+	} {
+		if !strings.Contains(cfg, want) {
+			t.Fatalf("expected generated pod config to contain %q, got:\n%s", want, cfg)
+		}
+	}
+	if strings.Count(cfg, "cpu: \"500m\"") != 2 || strings.Count(cfg, "cpu: \"250m\"") != 2 || strings.Count(cfg, "memory: 512Mi") != 4 {
+		t.Fatalf("expected generated pod config to use equal requests and limits for Guaranteed QoS, got:\n%s", cfg)
+	}
 }
 
 func TestInitScaffoldsJobManifest(t *testing.T) {

internal/config/template.go

@@ -77,7 +77,13 @@ type TemplateVars struct {
 	Name             string
 	Namespace        string
 	DevImage         string
+	DevCPURequest    string
+	DevMemoryRequest string
+	DevCPULimit      string
+	DevMemoryLimit   string
 	SidecarImage     string
+	SidecarCPU       string
+	SidecarMemory    string
 	SyncthingVersion string
 	SyncLocal        string
 	SyncRemote       string
@@ -102,7 +108,14 @@ func NewTemplateVars() *TemplateVars {
 	return &TemplateVars{
 		Name:             "",
 		Namespace:        "default",
+		DevImage:         "ubuntu:22.04",
+		DevCPURequest:    "500m",
+		DevMemoryRequest: "512Mi",
+		DevCPULimit:      "500m",
+		DevMemoryLimit:   "512Mi",
 		SidecarImage:     "",
+		SidecarCPU:       "250m",
+		SidecarMemory:    "512Mi",
 		SyncthingVersion: DefaultSyncthingVersion,
 		SyncLocal:        ".",
 		SyncRemote:       "/workspace",

internal/config/template_test.go

@@ -28,6 +28,15 @@ func TestDefaultTemplateVars(t *testing.T) {
 	if vars.SyncRemote != "/workspace" {
 		t.Fatalf("expected /workspace sync remote, got %q", vars.SyncRemote)
 	}
+	if vars.DevImage != "ubuntu:22.04" {
+		t.Fatalf("expected default dev image, got %q", vars.DevImage)
+	}
+	if vars.DevCPURequest != "500m" || vars.DevMemoryRequest != "512Mi" || vars.DevCPULimit != "500m" || vars.DevMemoryLimit != "512Mi" {
+		t.Fatalf("unexpected default dev resources: %#v", vars)
+	}
+	if vars.SidecarCPU != "250m" || vars.SidecarMemory != "512Mi" {
+		t.Fatalf("unexpected default sidecar resources: %#v", vars)
+	}
 	if vars.WorkloadType != "pod" {
 		t.Fatalf("expected pod workload type, got %q", vars.WorkloadType)
 	}
@@ -62,6 +71,21 @@ func TestRenderBuiltinBasic(t *testing.T) {
 	if strings.Contains(out, "\n    exclude:\n") {
 		t.Fatalf("expected starter template to keep local ignore rules out of .okdev.yaml, got:\n%s", out)
 	}
+	if !strings.Contains(out, "podTemplate:") {
+		t.Fatalf("expected default pod template, got:\n%s", out)
+	}
+	if !strings.Contains(out, "image: ubuntu:22.04") {
+		t.Fatalf("expected default dev image, got:\n%s", out)
+	}
+	if !strings.Contains(out, "cpu: \"500m\"") || !strings.Contains(out, "memory: 512Mi") {
+		t.Fatalf("expected default dev resource requests, got:\n%s", out)
+	}
+	if strings.Count(out, "cpu: \"500m\"") != 2 || strings.Count(out, "memory: 512Mi") != 4 {
+		t.Fatalf("expected default dev resource limits, got:\n%s", out)
+	}
+	if strings.Count(out, "cpu: \"250m\"") != 2 {
+		t.Fatalf("expected equal default sidecar CPU request/limit, got:\n%s", out)
+	}
 }
 
 func TestBuiltinTemplateLocalIgnores(t *testing.T) {

internal/config/templates/basic.yaml.tmpl

@@ -40,11 +40,25 @@ spec:
 {{- if .SidecarImage }}
     image: {{ .SidecarImage }}
 {{- end }}
-{{- if and (eq .WorkloadType "pod") .DevImage }}
+    resources:
+      requests:
+        cpu: "{{ .SidecarCPU }}"
+        memory: {{ .SidecarMemory }}
+      limits:
+        cpu: "{{ .SidecarCPU }}"
+        memory: {{ .SidecarMemory }}
+{{- if eq .WorkloadType "pod" }}
   podTemplate:
     spec:
       containers:
         - name: dev
           image: {{ .DevImage }}
           command: ["sleep", "infinity"]
+          resources:
+            requests:
+              cpu: "{{ .DevCPURequest }}"
+              memory: {{ .DevMemoryRequest }}
+            limits:
+              cpu: "{{ .DevCPULimit }}"
+              memory: {{ .DevMemoryLimit }}
 {{- end }}