Problem
Testing the quickstart guide end-to-end in a fresh Ubuntu 22.04 Docker container revealed several documentation inaccuracies and missing information. The guide doesn't match what the actual CLI, Core, and UI repos expect.
Issues Found
Documentation Inaccuracies
-
Incomplete prerequisites — Only Docker, Docker Compose, and Git are listed. Missing:
- Node.js 20+ (required for frontend-only dev and manual UI setup)
- Go 1.25+ (required for full-stack dev and manual backend setup)
-
Manual setup MongoDB connection mismatch — The docker run command starts MongoDB without authentication, but config.yaml.example defaults to an auth-based URI (mongodb://username:password@...). Users following the guide must know to change it to mongodb://localhost:27017/kubeorch.
-
Development mode explanations lack clarity — Each dev mode doesn't explain what orchcli start -d actually starts in Docker vs what runs on the host.
-
Missing config.yaml setup guidance — The manual setup says "Edit config.yaml" but doesn't show the minimal working config values for the Docker-based MongoDB instance.
CLI Bugs (tracked separately)
The following CLI bugs were found and are being fixed in KubeOrch/cli#45 / KubeOrch/cli#46:
orchcli init doesn't generate docker-compose files — blocks entire quickstart
start.go / exec.go reference PostgreSQL instead of MongoDB
orchcli --version shows dev — Go module path mismatch in ldflags
- Go auto-install fails on Linux
Expected Outcome
- Quickstart guide should accurately reflect prerequisites for each setup path
- Manual setup section should have copy-pasteable commands that work end-to-end
- Each development mode should clearly state what runs in Docker vs on the host
Problem
Testing the quickstart guide end-to-end in a fresh Ubuntu 22.04 Docker container revealed several documentation inaccuracies and missing information. The guide doesn't match what the actual CLI, Core, and UI repos expect.
Issues Found
Documentation Inaccuracies
Incomplete prerequisites — Only Docker, Docker Compose, and Git are listed. Missing:
Manual setup MongoDB connection mismatch — The
docker runcommand starts MongoDB without authentication, butconfig.yaml.exampledefaults to an auth-based URI (mongodb://username:password@...). Users following the guide must know to change it tomongodb://localhost:27017/kubeorch.Development mode explanations lack clarity — Each dev mode doesn't explain what
orchcli start -dactually starts in Docker vs what runs on the host.Missing
config.yamlsetup guidance — The manual setup says "Edit config.yaml" but doesn't show the minimal working config values for the Docker-based MongoDB instance.CLI Bugs (tracked separately)
The following CLI bugs were found and are being fixed in KubeOrch/cli#45 / KubeOrch/cli#46:
orchcli initdoesn't generate docker-compose files — blocks entire quickstartstart.go/exec.goreference PostgreSQL instead of MongoDBorchcli --versionshowsdev— Go module path mismatch in ldflagsExpected Outcome