f9d6b57f0f
The docs lived on one lineage and the fleet code on another. That is why six pages described a shared fleet key as how an agent authenticates, why COLLECTOR-AUTH had to warn that the per-PC credential code was not in the repository it sat in, and why ADR-019 recorded a decision whose implementation was somewhere else. Documentation that cannot see the code it documents goes stale by construction, and no amount of editing fixes that. So the corpus moves here: 84 files, 56 pages, 20 ADRs, the proposals, INDEX.md, llms.txt and both gates. Filenames are unchanged, because a wiki page name is derived from the filename and a rename breaks every link anybody saved. THE POINT OF THE MOVE IS THE CORRECTION IT ENABLES. Every caveat that said "not in this tree" was false the moment the files landed beside the code, so each was rewritten from what is actually here: - COLLECTOR-AUTH gained the real enroll request body, the two bounds on the unauthenticated route (per-IP rate limit, pending cap with stale rows dropped before a real PC is refused), and the rejected pending reason that binds to the endpoint identity rather than the nonce. - ADR-019 now describes an implementation that is present, including its tests, and says plainly that what remains is the FLEET migration, not the code. - proposals/device-identity claimed phase 1 was unbuilt. plugins/computers declares deviceid on the collector schema and prefers it over the older fallbacks. Corrected in the page, its summary and the index. WINDOWS/IIS IS NOW DOCUMENTED AS THE LEGACY PATH, per the product decision, and carefully: it is what production runs today. Every Windows page opens by saying it is supported, not for a new site, and where a new site should go instead. No procedure was cut - an operator on an IIS box at 2am needs these pages to work exactly as well tomorrow. MIGRATE-TOPOLOGY stops being a footnote and becomes the off-ramp, which is why it nearly doubled: what was there did not match how the Docker stack really works here. The Docker material that already lived on this line was kept and given ownership rather than buried under the ported Windows-centric prose: DEPLOY now describes the four services, the migrate service that runs the upgrade chain before api starts, TLS terminated by nginx, and the plugin count corrected from thirteen to seventeen - a number both lineages had wrong. ROADMAP is rewritten from evidence rather than memory: what has shipped, read out of the changelog, the ADRs and the manifests, and ahead of it exactly two items - finalize a distributed release and polish the setup wizard. PROJECT-MAP is generated and was stale; the GENERATOR was what was wrong. --check passes now. API-REFERENCE is retired to a pointer. /api/docs serves 573 operations with derived auth, query parameters and harvested examples, and a hand-written page competing with that is a liability. The file stays so its wiki page and its inbound links survive. AND THE MOVE TURNED ON A SCRUB THAT HAD NEVER RUN HERE. test_docs_publishable keys on docs/*.md, which this line did not have, so it skipped - its own comment predicted what would surface. Porting the corpus activated it and it found 48 lines that must not reach a published wiki: branch names abbreviating the site, assistant-tooling paths, the site name in two deployment pages, and an employee ID in a Windows path that the scrub does not even look for.
88 lines
3.6 KiB
Markdown
88 lines
3.6 KiB
Markdown
<!-- docmeta
|
|
purpose: howto
|
|
audience: adopter, developer
|
|
status: current
|
|
summary: Build the Docker image where npm cannot reach the registry, by compiling the frontend on the host first.
|
|
loadwith: none
|
|
-->
|
|
# Building the image with a pre-built frontend
|
|
|
|
> **Where this sits:** a variant of Step 2 of [DEPLOY](../DEPLOY.md), not a
|
|
> separate deployment. Everything else on that page still applies.
|
|
|
|
The shipped `Dockerfile` is a multi-stage build: stage 1 runs `npm ci` and
|
|
`npm run build` under Node, stage 2 copies the compiled SPA into the Python
|
|
image. Behind a proxy that re-signs HTTPS, stage 1 is where it dies - npm inside
|
|
the container does not trust the corporate root CA, and the failure reads
|
|
`npm ci failed` or the unhelpful `Exit handler never called`.
|
|
|
|
The fix is to build the frontend where npm already works - the host, which has
|
|
the corporate CA in its trust store - and give the image the finished
|
|
`frontend/dist/`.
|
|
|
|
It is also much faster: two to three minutes instead of fifteen. A site with no
|
|
proxy problem at all may want it for that reason alone.
|
|
|
|
## Do it
|
|
|
|
```bash
|
|
# 1. Build the frontend on the host
|
|
cd frontend
|
|
npm ci
|
|
npm run build # writes frontend/dist/
|
|
cd ..
|
|
|
|
# 2. Build and start the stack from the pre-built dist
|
|
docker compose -f docker-compose.prebuilt.yml build
|
|
docker compose -f docker-compose.prebuilt.yml up -d
|
|
```
|
|
|
|
The rest is [DEPLOY](../DEPLOY.md) unchanged: the `migrate` service runs the
|
|
schema, the plugin bootstrap and the seeders before `api` starts, nginx
|
|
terminates TLS on `API_PORT`, and the first admin comes from `/setup` or
|
|
`flask seed admin`.
|
|
|
|
## The files this uses
|
|
|
|
| File | What it is |
|
|
|---|---|
|
|
| `Dockerfile.prebuilt` | single-stage: Python dependencies plus a copy of `frontend/dist/`. No Node, no npm |
|
|
| `docker-compose.prebuilt.yml` | the same stack, building from `Dockerfile.prebuilt` |
|
|
| `.dockerignore.prebuilt` | permits `frontend/dist/` to be copied, which the normal `.dockerignore` excludes |
|
|
|
|
## What it costs
|
|
|
|
- **npm has to exist on the build host.** That is the whole trade: the trust
|
|
problem moves from the container to a machine that has already solved it.
|
|
- **It is two steps, and forgetting the first one ships a stale UI.** The image
|
|
copies whatever is in `frontend/dist/` at build time. A frontend change that
|
|
was not rebuilt is simply not in the image, and nothing warns you. If the UI
|
|
does not show your change, rebuild `dist/` before debugging anything else.
|
|
- **`frontend/dist/` has to reach the build.** Either it is committed, or the
|
|
pipeline builds it immediately before the image.
|
|
|
|
## The version of this that scales
|
|
|
|
The pre-built approach is a workaround for building at the deployment site. The
|
|
end state is not building there at all:
|
|
|
|
```yaml
|
|
# CI: build the frontend, build the image, push it
|
|
- run: cd frontend && npm ci && npm run build
|
|
- run: docker build -f Dockerfile.prebuilt -t shopdb:$GIT_SHA .
|
|
- run: docker push <registry>/shopdb:$GIT_SHA
|
|
```
|
|
|
|
A site then pulls a tagged image and runs it - seconds, no build step, no npm
|
|
anywhere near the facility. `docker-compose.pull.yml` is the compose file for
|
|
that shape today, and `docker-compose.airgap.yml` is the same idea for a site
|
|
that loads an image tarball off removable media
|
|
([DEPLOY-AIRGAP](../DEPLOY-AIRGAP.md)). Finishing that path is the distributed
|
|
release item on [ROADMAP](../ROADMAP.md).
|
|
|
|
| Approach | Build time | Behind a re-signing proxy | Where it belongs |
|
|
|---|---|---|---|
|
|
| Multi-stage `Dockerfile` | 15+ min | fails unless the CA is staged | a developer box with a clean network |
|
|
| Pre-built frontend (this page) | 2-3 min | works | a site that must build locally |
|
|
| Pull a published image | seconds | works | where every site should end up |
|