29 lines
1.0 KiB
Markdown
29 lines
1.0 KiB
Markdown
|
# @serve.zone/corebuild
|
||
|
|
|
||
|
|
CoreBuild is the serve.zone worker service for heavy artifact generation jobs such as BaseOS ISO builds.
|
||
|
|
|
||
|
|
Cloudly owns orchestration and user-facing downloads. CoreBuild runs on suitable builder nodes, executes `isocreator`, uploads artifacts to S3-compatible storage, and returns artifact metadata to Cloudly.
|
||
|
|
|
||
|
|
## Runtime
|
||
|
|
|
||
|
|
Required environment:
|
||
|
|
|
||
|
|
- `COREBUILD_PORT`: HTTP port, defaults to `3060`.
|
||
|
|
- `COREBUILD_TOKEN`: shared worker token expected from Cloudly.
|
||
|
|
- `COREBUILD_WORKDIR`: temp workspace, defaults to `.nogit/workdir`.
|
||
|
|
- `ISO_CREATOR_COMMAND`: command used to run isocreator, defaults to `isocreator`.
|
||
|
|
|
||
|
|
For local development against the workspace checkout:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
ISO_CREATOR_COMMAND="deno run --allow-all ../isocreator/mod.ts" pnpm run startTs
|
||
|
|
```
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
- `GET /health`
|
||
|
|
- `GET /corebuild/v1/capabilities`
|
||
|
|
- `POST /corebuild/v1/jobs/baseos-image`
|
||
|
|
|
||
|
|
The BaseOS image job expects Cloudly to provide the S3 descriptor and a one-time provisioning token. CoreBuild never stores those values beyond the build workspace.
|