|
1 | 1 | # okdev |
2 | 2 |
|
3 | | -`okdev` is a CRD-less CLI for Kubernetes development sessions. |
4 | | -It provisions and operates dev environments from `.okdev.yaml` using standard Pod/PVC resources. |
| 3 | +**CRD-less Kubernetes dev environments from a single manifest.** |
5 | 4 |
|
6 | | -## Core Capabilities |
| 5 | +okdev provisions and operates dev sessions using standard Pod/PVC resources -- no operators, no CRDs, no cluster-side components. |
7 | 6 |
|
8 | | -- PodSpec-driven environment definition |
9 | | -- Multi-session workflow per repo/branch/user |
10 | | -- Session setup via `okdev up` (SSH config, managed forwards, sync bootstrap) |
11 | | -- Syncthing-based workspace synchronization |
12 | | -- Reattach from any machine with kube access |
| 7 | +--- |
| 8 | + |
| 9 | +## How it works |
| 10 | + |
| 11 | +``` |
| 12 | +.okdev.yaml --> okdev up --> Pod + PVC + SSH + Sync |
| 13 | +``` |
| 14 | + |
| 15 | +1. Define your environment in `.okdev.yaml` (image, volumes, ports, sync paths). |
| 16 | +2. Run `okdev up` to create the pod, configure SSH, and start file sync. |
| 17 | +3. Connect with `ssh okdev-<session>` or `okdev connect`. |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## Key features |
| 22 | + |
| 23 | +| | | |
| 24 | +|---|---| |
| 25 | +| **One-command setup** | `okdev up` handles pod creation, SSH config, port forwarding, and sync | |
| 26 | +| **Persistent sessions** | tmux-backed shells survive disconnects by default | |
| 27 | +| **File sync** | Bidirectional Syncthing sync with exclude patterns | |
| 28 | +| **Port forwarding** | Declare ports in config, get automatic SSH `LocalForward` entries | |
| 29 | +| **Multi-session** | Run multiple environments per repo with named sessions | |
| 30 | +| **No cluster deps** | Works with any Kubernetes cluster -- RBAC for Pods and PVCs is all you need | |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## Quick start |
| 35 | + |
| 36 | +```bash |
| 37 | +# Install |
| 38 | +curl -fsSL https://raw.githubusercontent.com/acmore/okdev/main/scripts/install.sh | sh |
| 39 | + |
| 40 | +# Initialize config |
| 41 | +okdev init |
| 42 | + |
| 43 | +# Start session |
| 44 | +okdev up |
| 45 | + |
| 46 | +# Connect |
| 47 | +ssh okdev-<session> |
| 48 | +``` |
| 49 | + |
| 50 | +See the [Quickstart guide](quickstart.md) for details. |
| 51 | + |
| 52 | +--- |
13 | 53 |
|
14 | 54 | ## Documentation |
15 | 55 |
|
16 | | -- [Quickstart](quickstart.md) |
17 | | -- [Config Manifest](config-manifest.md) |
18 | | -- [Command Reference](command-reference.md) |
19 | | -- [Troubleshooting](troubleshooting.md) |
20 | | -- [Release & Versioning](release.md) |
21 | | -- [Repository](https://github.com/acmore/okdev) |
| 56 | +- [Quickstart](quickstart.md) -- install, configure, and launch your first session |
| 57 | +- [Config Manifest](config-manifest.md) -- full `.okdev.yaml` field reference |
| 58 | +- [Command Reference](command-reference.md) -- every CLI command and flag |
| 59 | +- [Troubleshooting](troubleshooting.md) -- common issues and fixes |
| 60 | +- [Release & Versioning](release.md) -- release process and image tags |
0 commit comments