docs(cli): add Verifiable Program Deployment page for aleph vprogram - #86
Conversation
Documents the aleph vprogram command group (create, list, show, call, delete): prerequisites, the --compose and --workload paths, the aleph.compose/1 subset and its rejection rules, runtime selection from the vm-images aggregate, and the attestation checks performed by call. Adds the page to the Aleph CLI sidebar next to Function Deployment.
|
Deployed on:
|
foxpatch-aleph
left a comment
There was a problem hiding this comment.
Well-structured, thorough documentation page that follows the conventions of the existing CLI command pages (e.g. program.md). The sidebar entry is correctly placed. Internal links resolve, the compose subset rejection table is clear, and security-relevant flags (--allow-debug, --allow-stale-attestation, --accept-outdated-tcb) are documented with appropriate warnings. No bugs or security issues found. A few minor nits below.
docs/devhub/sdks-and-tools/aleph-cli/commands/vprogram.md (line 220): The show command is missing an #### Options table, yet the examples on line 235 use --json. The list and delete commands both have options tables. Consider adding a small options table for consistency, even if it's just --json and --help.
docs/devhub/sdks-and-tools/aleph-cli/commands/vprogram.md (line 82): The placeholder is --memory <MIB> (mebibytes) while the sibling program.md page uses --memory <SIZE> with examples like 2GB. If the CLI accepts both formats, consider aligning the placeholder for consistency; if vprogram strictly requires MiB, a one-line note would help users coming from program create.
docs/nodes/compute/advanced/confidential/scaleway-sev-snp.md (line 301): Not in this PR's diff, but this existing page references aleph attest call while the new page documents aleph vprogram call. If attest call is the old name, consider a follow-up to update or cross-link it now that the canonical command is documented.
ghcr.io/example/fib-api does not exist; switch the walkthrough to docker.io/traefik/whoami, a real HTTP echo service that can be told to listen on 8080, and align the call examples with its routes.
foxpatch-aleph
left a comment
There was a problem hiding this comment.
Well-structured documentation page that follows existing conventions (matching the program.md pattern) and clearly explains the V-PROGRAM CLI commands. The sidebar config is correctly placed after Function Deployment. The build passes cleanly and the link checker introduces no new broken links. Anchor links (e.g., #the-compose-subset) and relative links (./credits.md) resolve correctly. Security-relevant flags (--allow-debug, --allow-stale-attestation, --expected-measurement) are documented with appropriate warnings. The PR notes caveat about runtime name examples depending on the vm-images aggregate is reasonable. Minor non-blocking observation: the show command section lacks a formal Options table for --json, but this is consistent with the existing program.md page's style.
docs/devhub/sdks-and-tools/aleph-cli/commands/vprogram.md (line 227): The show command section has no #### Options table, while list, call, and delete all do. The examples on lines 234-235 show --json is supported, but it's not formally documented in a table. Consider adding an options table for consistency, though this matches the existing pattern in program.md which also omits one for show.
docs/devhub/sdks-and-tools/aleph-cli/commands/vprogram.md (line 273): The option notation --header <"Key: Value"> puts quotes inside angle brackets, which is slightly unusual. Consider --header <KEY: VALUE> or --header <"Key: Value"> with a note that the value is quoted. Minor style nit, not blocking.
Summary
docs/devhub/sdks-and-tools/aleph-cli/commands/vprogram.mddocumenting thealeph vprogramcommand group (create,list,show,call,delete) as implemented on aleph-rsorigin/dev-vprogram(cecc189).--composeand--workloadpaths, image digest pinning and--image-archive, thealeph.compose/1subset and its rejection rules, runtime selection from thevm-imagesaggregate, and every attestation check performed bycall.Notes
compose,exec) follow the currentvm-imagesaggregate draft; adjust if the published aggregate uses versioned names.Test plan
npm run docs:buildpasses