Repository navigation
Clarify setup requirements and organize demos - #56
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Removing the workspace manifest breaks fresh-checkout installs, CI setup, and reopening existing installations without a migration path, while the release prerequisites also omit required authenticated GitHub CLI setup.
1 open issue
What changed in this PR
This PR clarifies host setup requirements and separates runnable demos from the source checkout’s role as a development repository.
Changes:
- Documents Docker, kubectl, Linux KVM access, Windows WSL guidance, and the source-build
PATH. - Removes the root workspace marker and places the worker demo under
demos/local-worker-workspace. - Updates CLI documentation and the test fixture to use the demo path.
| File | Description |
|---|---|
| README.md | Clarifies prerequisites and installation guidance. |
| lampyr.workspace.yaml | Removes the checkout’s workspace marker. |
| docs/cli/dev.md | Updates worker demo commands and paths. |
| demos/local-worker-workspace/services/reused/server.js | Provides the reuse demo’s request counter. |
| demos/local-worker-workspace/services/reused/lampyr.yaml | Configures reuse mode and idle timeout. |
| demos/local-worker-workspace/services/reused/Dockerfile.rootfs | Packages the reused service source. |
| demos/local-worker-workspace/services/reused/Dockerfile | Defines the reused service artifact image. |
| demos/local-worker-workspace/services/processor/server.js | Provides HTTP and event-processing demo handlers. |
| demos/local-worker-workspace/services/processor/lampyr.yaml | Defines the processor service. |
| demos/local-worker-workspace/services/processor/Dockerfile.rootfs | Packages the processor source. |
| demos/local-worker-workspace/services/processor/Dockerfile | Defines the processor artifact image. |
| demos/local-worker-workspace/services/api/server.js | Provides ingress and downstream demo calls. |
| demos/local-worker-workspace/services/api/lampyr.yaml | Configures API service bindings. |
| demos/local-worker-workspace/services/api/Dockerfile.rootfs | Packages the API source. |
| demos/local-worker-workspace/services/api/Dockerfile | Defines the API artifact image. |
| demos/local-worker-workspace/lampyr.workspace.yaml | Defines the demo workspace and exposed API. |
| demos/local-worker-workspace/.gitignore | Ignores generated local workspace state. |
| cli/tests/dev.rs | Points the fixture at the demo directory. |
Review effort: Balanced
Signed-off-by: James Sturtevant <jsturtevant@gmail.com>
There was a problem hiding this comment.
🔵 Needs a closer look
Deleting the workspace marker breaks fresh checkout-root installs and the new-developer-workflow CI job because the affected commands do not select a replacement workspace.
No open issues 🎉
1 resolved since last review
Review effort: Balanced
There was a problem hiding this comment.
🔵 Needs a closer look
Removing the workspace marker breaks just cluster-install on fresh checkouts and the new-developer-workflow CI job, so a replacement workspace must be configured consistently across recipes, CI, smoke paths, and installation docs.
No open issues 🎉
Review effort: Balanced
Signed-off-by: James Sturtevant <jsturtevant@gmail.com>
Signed-off-by: James Sturtevant <jsturtevant@gmail.com>
|
Fixed and simplified in 3e92ad9. The guides now explicitly scaffold a Workspace, enter it, and run ordinary ly commands. Checkout recipes and CI do the same in build/workspace, so the root manifest stays removed without workspace flags or environment plumbing throughout the workflows. The original regression failed in CI before the fix. All 39 workflow policy tests, real workspace preparation, CI shell syntax checks, and the site check pass locally. The latest full CI results are not yet verified. |
There was a problem hiding this comment.
🔵 Needs a closer look
Removing the manifest breaks Workspace discovery in three Kind suites; the remaining health/uninstall calls need explicit workspace targeting, and the checkout-root walkthrough needs a scaffolded Workspace.
No open issues 🎉
Review effort: Balanced
Signed-off-by: James Sturtevant <jsturtevant@gmail.com>
There was a problem hiding this comment.
🔵 Needs a closer look
Removing the workspace manifest breaks both kind-cluster-lifecycle CI shards and fresh Azure Event Grid walkthrough installations because affected commands neither create nor explicitly select a Workspace.
No open issues 🎉
Review effort: Balanced
Signed-off-by: James Sturtevant <jsturtevant@gmail.com>
Signed-off-by: James Sturtevant <jsturtevant@gmail.com>
|
Fixed the remaining Kind lifecycle failure in f899111. The shared integration script now enters its scaffolded Workspace after preparing repository-relative inputs, so health and uninstall no longer search from the checkout root. The new regression failed in CI before the fix. All 40 workflow tests pass locally; the two previously failing lifecycle jobs still need verification on this commit. |
Signed-off-by: James Sturtevant <jsturtevant@gmail.com>
There was a problem hiding this comment.
🔵 Needs a closer look
Human assessment is needed because an unpublished finding identifies that removing the workspace manifest breaks the documented Azure Event Grid setup before AKS provisioning.
No open issues 🎉
1 resolved since last review
Review effort: Balanced
Clarify the host setup requirements and keep runnable demos separate from the source repository, so new users can follow the install steps without treating the checkout as a customer workspace.
The worker demo is unchanged; its documented paths and test fixture now point to
demos/local-worker-workspace.All 12 focused CLI tests and
just site-checkpassed. Self-review found no issues.