Skip to content

docs: add Node.js deploy guide and runnable example for Datum compute#132

Open
scotwells wants to merge 1 commit into
mainfrom
docs/deploy-guide-node
Open

docs: add Node.js deploy guide and runnable example for Datum compute#132
scotwells wants to merge 1 commit into
mainfrom
docs/deploy-guide-node

Conversation

@scotwells
Copy link
Copy Markdown
Contributor

@scotwells scotwells commented Jun 2, 2026

What this delivers

A self-contained guide that takes a developer from a Node.js HTTP service in source form to a live, reachable Instance on Datum compute, plus a runnable example they can deploy as-is. It lowers the barrier to a first successful Node.js deploy: package the app as a Unikraft unikernel on the base-compat runtime, publish to the metro registry, deploy with datumctl compute deploy, and verify the HTTP response end to end.

Changes

  • Guide now lives at docs/guides/deploy-a-node-app.md (moved out of docs/compute/guides/).
  • Ready-to-deploy example at examples/hello-node/ materializes every file the guide inlines, so a reader can clone and ship without copy-pasting:
    • app.js — the Node HTTP service (responds on / and /healthz)
    • package.json
    • Dockerfile — builds the minimal scratch rootfs with the node interpreter and its shared libraries
    • Kraftfilebase-compat:latest runtime packaging
    • workload.yaml — the Datum Workload manifest
    • README.md — one-line summary, link back to the guide, and the key build + deploy commands

The guide gains a single pointer line directing readers to the example folder.

🤖 Generated with Claude Code

@scotwells scotwells force-pushed the docs/deploy-guide-node branch from a24bf18 to e767314 Compare June 2, 2026 20:43
@scotwells scotwells changed the title docs: add guide for deploying a Node.js service on Datum compute docs: add Node.js deploy guide and runnable example for Datum compute Jun 2, 2026
@scotwells scotwells force-pushed the docs/deploy-guide-node branch from e767314 to 436198a Compare June 2, 2026 20:55
@scotwells scotwells force-pushed the docs/deploy-guide-node branch from 436198a to 10a329f Compare June 2, 2026 20:57
@scotwells scotwells requested review from a team and savme June 2, 2026 21:44
@scotwells scotwells added the documentation Improvements or additions to documentation label Jun 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants