You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: refactor quickstart and manifest for readability
Reorganize quickstart from flat bullet dump into logical sections
(install, start, connect, sync, teardown). Replace manifest field
reference bullet lists with tables for scannability and inline
validation rules.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Uses native Kubernetes `corev1.Volume` schema. Define volume sources here and mount them via `spec.podTemplate.spec.containers[*].volumeMounts`.
61
+
62
+
### Workspace Behavior
71
63
72
-
- Define storage source with standard `VolumeSource` (for example `emptyDir`, `persistentVolumeClaim`, `ephemeral`, `configMap`, `secret`).
73
-
- Mount points are defined with standard Kubernetes `volumeMounts` in `spec.podTemplate.spec.containers[*].volumeMounts`.
64
+
- If no volume named `workspace` is provided, okdev injects `emptyDir: {}` automatically.
65
+
- okdev ensures `workspace` is mounted on both the `dev` container and sidecar.
66
+
- Mount path defaults to `/workspace`, or follows the `volumeMounts` entry for `workspace` in `podTemplate`.
74
67
75
-
### Example
68
+
### PVC
76
69
77
70
```yaml
78
71
spec:
@@ -95,11 +88,7 @@ spec:
95
88
readOnly: true
96
89
```
97
90
98
-
### More Examples
99
-
100
-
#### `emptyDir` Scratch Space
101
-
102
-
Useful for build caches, temporary outputs, or other pod-lifetime data.
91
+
### emptyDir (Scratch Space)
103
92
104
93
```yaml
105
94
spec:
@@ -115,9 +104,7 @@ spec:
115
104
mountPath: /tmp/build-cache
116
105
```
117
106
118
-
#### `configMap` and `secret` Mounts
119
-
120
-
Useful when the dev container needs checked-in config plus cluster-managed credentials.
107
+
### configMap and secret
121
108
122
109
```yaml
123
110
spec:
@@ -141,9 +128,9 @@ spec:
141
128
readOnly: true
142
129
```
143
130
144
-
#### `ephemeral` Per-Session Persistent Storage
131
+
### Ephemeral (Per-Session PVC)
145
132
146
-
Useful when each okdev session should get its own PVC-backed storage that is created with the pod and removed with it.
133
+
Created with the pod, removed when it's deleted.
147
134
148
135
```yaml
149
136
spec:
@@ -165,21 +152,23 @@ spec:
165
152
mountPath: /models
166
153
```
167
154
168
-
### Workspace Behavior
169
-
170
-
- If a `workspace` volume is not provided, okdev injects a volume with `name: workspace` and `emptyDir: {}`.
171
-
- okdev ensures `workspace` is mounted on the `dev` container and `okdev-sidecar`.
172
-
- Workspace mount path defaults to `/workspace` (or follows `dev` container `volumeMounts` entry for `workspace` if provided in `podTemplate`).
155
+
---
173
156
174
157
## `spec.sync`
175
158
176
-
- `engine`(`string`, required, currently only `syncthing`)
177
-
- `paths` (`[]string`): mappings in `local:remote` format.
178
-
- `exclude` (`[]string`): local ignore patterns.
179
-
- `remoteExclude` (`[]string`): remote-only ignore patterns (written to remote `.stignore`).
180
-
- `syncthing` (`object`): includes `version` (`string`, default: `v1.29.7`) for the local auto-installed Syncthing client, `autoInstall` (`bool`, default: `true`), and `image` (`string`, default: `ghcr.io/acmore/okdev:<okdev-version>` with `edge` fallback) for the sidecar runtime image.
0 commit comments