Repository navigation
Separate the source-built native image #1539
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
f45b554
a4b3b48
fe04ce1
5781382
b9e1ff2
8fef1e1
37c7fab
5d3cbeb
439ccb8
8de80f2
718bfc1
24867d1
c677a8c
866c519
d96063b
94ef18e
31981ca
224540e
8d41cb0
2eacf2d
f8d757e
c1e8eb0
aca4660
57a9777
683417f
d1240e3
ccefefd
d4ac7c3
1468d72
6e7e34f
3f7e7ae
f087ed1
6c73e7c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Allow only build inputs, never the entire operator checkout. | ||
| ** | ||
| !Cargo.toml | ||
| !Cargo.lock | ||
| !.tool-versions | ||
| !rust-toolchain.toml | ||
| !edgezero.toml | ||
| !.cargo/ | ||
| !.cargo/config.toml | ||
| !crates/ | ||
| !crates/** | ||
| # Exclude operator TOMLs even if placed below a crate. | ||
| **/*.toml | ||
| !**/Cargo.toml | ||
| !rust-toolchain.toml | ||
| !edgezero.toml | ||
| !.cargo/config.toml | ||
| !trusted-server.example.toml | ||
| **/.git | ||
| **/target | ||
| **/node_modules | ||
| **/dist | ||
| crates/trusted-server-adapter-cloudflare/build | ||
| crates/trusted-server-adapter-cloudflare/pkg | ||
| **/.env | ||
| **/.env.* | ||
| **/*.pem | ||
| **/*.key | ||
| **/*.p12 | ||
| **/*.pfx | ||
| **/keys | ||
| **/secrets | ||
| **/.aws | ||
| **/.npmrc | ||
| **/.cargo/credentials* | ||
| **/.ts-tmp | ||
| **/.tsjs-npm-ci.lock |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| name: Native RC container | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - Dockerfile | ||
| - .dockerignore | ||
| - .tool-versions | ||
| - rust-toolchain.toml | ||
| - Cargo.toml | ||
| - Cargo.lock | ||
| - edgezero.toml | ||
| - .cargo/** | ||
| - crates/trusted-server-adapter-axum/** | ||
| - crates/trusted-server-core/** | ||
| - crates/trusted-server-js/** | ||
| - crates/trusted-server-openrtb*/** | ||
| - scripts/test-native-container.mjs | ||
| - scripts/test-native-ec-image.mjs | ||
| - .github/workflows/native-container.yml | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| local-provider-image: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 30 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| persist-credentials: false | ||
| - name: Read pinned Node version | ||
| id: node | ||
| run: | | ||
| version=$(awk '$1 == "nodejs" { print $2 }' .tool-versions) | ||
| test -n "$version" | ||
| echo "version=$version" >> "$GITHUB_OUTPUT" | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: ${{ steps.node.outputs.version }} | ||
| - name: Build local-provider image | ||
| run: docker build --build-arg TRUSTED_SERVER__GIT_VERSION="${{ github.sha }}" -t ts-rc-local:test . | ||
| - name: Check real TS routes, startup rejection and drain | ||
| run: node scripts/test-native-container.mjs ts-rc-local:test | ||
|
|
||
| record-provider-image: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 30 | ||
| env: | ||
| DYNAMODB_LOCAL_IMAGE: amazon/dynamodb-local@sha256:ff89bd48ff32cd8d9be5fee8873b65b8854dc408f1afe881be6eb00247bc0dab | ||
| DYNAMODB_CONTAINER: ts-records-${{ github.run_id }}-${{ github.run_attempt }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| persist-credentials: false | ||
| - name: Read pinned Node version | ||
| id: node | ||
| run: | | ||
| version=$(awk '$1 == "nodejs" { print $2 }' .tool-versions) | ||
| test -n "$version" | ||
| echo "version=$version" >> "$GITHUB_OUTPUT" | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: ${{ steps.node.outputs.version }} | ||
| - name: Build prepared-record image locally | ||
| env: | ||
| REVISION: ${{ github.sha }} | ||
| run: | | ||
| docker build \ | ||
| --build-arg NATIVE_FEATURES=aws-dynamodb-ec,geo-cloudfront \ | ||
| --build-arg TRUSTED_SERVER__GIT_VERSION="$REVISION" \ | ||
| -t ts-rc-records:test . | ||
| - name: Start disposable DynamoDB Local | ||
| run: | | ||
| docker run -d --name "$DYNAMODB_CONTAINER" \ | ||
| -p 127.0.0.1::8000 "$DYNAMODB_LOCAL_IMAGE" \ | ||
| -jar DynamoDBLocal.jar -inMemory -sharedDb | ||
| port=$(docker port "$DYNAMODB_CONTAINER" 8000/tcp | awk -F: '{ print $NF }') | ||
| test -n "$port" | ||
| echo "DYNAMODB_ENDPOINT=http://127.0.0.1:${port}" >> "$GITHUB_ENV" | ||
| - name: Check record acknowledgement, withdrawal, faults and drain | ||
| env: | ||
| REVISION: ${{ github.sha }} | ||
| run: | | ||
| node scripts/test-native-ec-image.mjs \ | ||
| --image ts-rc-records:test \ | ||
| --dynamodb "$DYNAMODB_ENDPOINT" \ | ||
| --expected-version "$REVISION" \ | ||
| --output "$RUNNER_TEMP/record-image-proof.json" | ||
| - name: Retain record proof | ||
| if: always() | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: record-image-proof | ||
| path: ${{ runner.temp }}/record-image-proof.json | ||
| if-no-files-found: warn | ||
| - name: Remove owned DynamoDB Local container | ||
| if: always() | ||
| run: docker rm -f "$DYNAMODB_CONTAINER" | ||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,64 @@ | ||||||||||
| # syntax=docker/dockerfile:1 | ||||||||||
| # Adapted from the pinned EdgeZero RC's hardened native recipe. Build at workspace root. | ||||||||||
| FROM node:24.20.0-bookworm-slim@sha256:ba849c60be29959425b8734d57b8b4b7d56f98edd9504c9af091d5281095a71e AS node | ||||||||||
| FROM rust:1.98.1-bookworm@sha256:93ce27a88655056a51dbdd8f5f2d7ddc071c7b0070fb288a37b5a285fc83971e AS builder | ||||||||||
| COPY --from=node /usr/local/ /usr/local/ | ||||||||||
| WORKDIR /src | ||||||||||
| COPY . . | ||||||||||
| # AWS providers and CloudFront Geo are default-off. Forward them explicitly. | ||||||||||
| ARG NATIVE_FEATURES="" | ||||||||||
| # Optional existing build metadata input; .git never enters the build context. | ||||||||||
| ARG TRUSTED_SERVER__GIT_VERSION="" | ||||||||||
| RUN <<'SH' | ||||||||||
| set -eu | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ♻️ refactor — Each image build downloads three unused wasm standard libraries.
Setting
Suggested change
|
||||||||||
| export RUSTUP_TOOLCHAIN=1.98.1 CARGO_BUILD_JOBS=2 CARGO_INCREMENTAL=0 CARGO_PROFILE_RELEASE_DEBUG=0 | ||||||||||
| test "$(rustc --version | awk '{print $2}')" = 1.98.1 | ||||||||||
| test "$(node --version)" = v24.20.0 | ||||||||||
| test "$(awk '$1 == "nodejs" {print $2}' .tool-versions)" = 24.20.0 | ||||||||||
| test "$(awk '$1 == "rust" {print $2}' .tool-versions)" = 1.98.1 | ||||||||||
| grep -Eq '^channel = "1.98.1"$' rust-toolchain.toml | ||||||||||
| feature_ifs=$IFS | ||||||||||
| IFS=, | ||||||||||
| for feature in $NATIVE_FEATURES; do | ||||||||||
| case "$feature" in | ||||||||||
| aws-appconfig-agent|aws-secrets-manager|aws-dynamodb-ec|celld-ec|geo-cloudfront) ;; | ||||||||||
| *) echo 'Only the declared native store, EC and Geo features are supported' >&2; exit 1 ;; | ||||||||||
| esac | ||||||||||
| done | ||||||||||
| IFS=$feature_ifs | ||||||||||
| unset feature feature_ifs | ||||||||||
| apt-get update | ||||||||||
| apt-get install -y --no-install-recommends cmake | ||||||||||
| rm -rf /var/lib/apt/lists/* | ||||||||||
| npm --prefix crates/trusted-server-js/lib ci --no-audit --no-fund | ||||||||||
| # No host target, node_modules or prebuilt dist enters this context. build.rs | ||||||||||
| # builds and validates new bundles in Cargo's private OUT_DIR before embedding. | ||||||||||
| host=$(rustc -vV | awk '$1 == "host:" {print $2}') | ||||||||||
| set -- | ||||||||||
| if test -n "$NATIVE_FEATURES"; then set -- --features "$NATIVE_FEATURES"; fi | ||||||||||
| cargo build -p trusted-server-adapter-axum --bin trusted-server-axum --release --locked --target "$host" "$@" | ||||||||||
| mkdir /out | ||||||||||
| cp "target/$host/release/trusted-server-axum" /out/app | ||||||||||
| strip --strip-debug /out/app | ||||||||||
| SH | ||||||||||
|
|
||||||||||
| # Retain an auditable hash list of the exact context, not host working-tree state. | ||||||||||
| RUN find . -type d \( -name target -o -name node_modules \) -prune -o -type f ! -name .tsjs-npm-ci.lock -print0 \ | ||||||||||
| | sort -z | xargs -0 sha256sum > /out/build-inputs.sha256 | ||||||||||
|
|
||||||||||
| FROM debian:bookworm-slim@sha256:7c7b2c966bc9ee8cedfeef67e0e279108992c77681fa595db4a9d65c06ccc587 AS runtime | ||||||||||
| RUN apt-get update \ | ||||||||||
| && apt-get upgrade -y --no-install-recommends \ | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤔 thinking — The base images are digest-pinned and the image records a hash of its build inputs. But |
||||||||||
| && apt-get install -y --no-install-recommends ca-certificates libgcc-s1 \ | ||||||||||
| && rm -rf /var/lib/apt/lists/* | ||||||||||
| WORKDIR /app | ||||||||||
| COPY --from=builder /out/app /usr/local/bin/app | ||||||||||
| COPY --from=builder /out/build-inputs.sha256 /usr/local/share/ts-build-inputs.sha256 | ||||||||||
| ENV EDGEZERO__ADAPTER__HOST=0.0.0.0 \ | ||||||||||
| EDGEZERO__ADAPTER__PORT=8787 \ | ||||||||||
| EDGEZERO__ADAPTER__CONFIG_DIR=/config \ | ||||||||||
| EDGEZERO__ADAPTER__DATA_DIR=/data | ||||||||||
| USER 10001:10001 | ||||||||||
| EXPOSE 8787 | ||||||||||
| STOPSIGNAL SIGTERM | ||||||||||
| ENTRYPOINT ["/usr/local/bin/app"] | ||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Native container | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 note — Nothing links to this page. It isn't in the |
||
|
|
||
| Build the Axum adapter as a native Linux container from the workspace root: | ||
|
|
||
| ```sh | ||
| docker build \ | ||
| --build-arg TRUSTED_SERVER__GIT_VERSION="$(git rev-parse HEAD)" \ | ||
| -t ts-native:local . | ||
| ``` | ||
|
|
||
| The multi-stage build uses pinned Rust 1.98.1 and Node 24.20.0 images. The build checks both versions against `.tool-versions`. It installs JS dependencies with `npm ci` and builds fresh bundles through Cargo. Host `target`, `node_modules` and `dist` directories never enter the build context. | ||
|
|
||
| ```mermaid | ||
| flowchart TD | ||
| A[Workspace build inputs] --> B[Rust and Node builder] | ||
| B --> C[Native binary and input hashes] | ||
| C --> D[Non-root Debian runtime] | ||
| ``` | ||
|
|
||
| The runtime image contains the application binary, CA roots and runtime libraries, without Rust or Node. It runs as UID and GID `10001`, listens on port `8787` on all container interfaces, and uses `/config` and `/data` for runtime configuration and data. Mount configuration read-only and provide writable storage for `/data` and `/tmp` when using a read-only root filesystem. Supply configuration and secrets at runtime, never as image build arguments or files in the source checkout. | ||
|
|
||
| The `.dockerignore` file limits the build context to workspace build inputs. It excludes operator TOMLs, environment files, credentials and host build outputs. The image stores an input hash list at `/usr/local/share/ts-build-inputs.sha256`. `TRUSTED_SERVER__GIT_VERSION` supplies optional build metadata because `.git` is excluded. | ||
|
|
||
| ## Optional AWS providers | ||
|
|
||
| Local providers are the default. Enable only the native AWS providers needed by the application: | ||
|
|
||
| ```sh | ||
| docker build \ | ||
| --build-arg NATIVE_FEATURES=aws-appconfig-agent,aws-secrets-manager \ | ||
| -t ts-native:aws . | ||
| ``` | ||
|
|
||
| `NATIVE_FEATURES` accepts an empty value or a comma-separated selection of `aws-appconfig-agent`, `aws-secrets-manager`, `aws-dynamodb-ec`, `celld-ec` and `geo-cloudfront`. Compiling a connector does not select it. For EC, set `TS_EC_RECORDS_ENABLED=true` at boot to declare the layout before preparation, select the connector in `EDGEZERO__STORE_BINDINGS_FILE`, and reference logical `trusted_server_kv` with `ec.storage.provider="records"` in published application configuration. A separate boot profile selects protected CloudFront Geo. Credentials and provider settings are runtime inputs, never image build arguments. See [Native EC persistence](./native-ec-persistence.md). The local-provider smoke below does not validate AWS access. | ||
|
|
||
| ## Local smoke test | ||
|
|
||
| With Docker available, use the host Node version pinned in `.tool-versions`: | ||
|
|
||
| ```sh | ||
| node scripts/test-native-container.mjs ts-native:local | ||
| ``` | ||
|
|
||
| The test creates a private Docker network, a synthetic publisher origin and temporary local configuration. It checks startup rejection for invalid configuration and missing secrets, the published listener, HTML rewriting, embedded JS, non-root execution, CA roots, writable mounts and SIGTERM draining with a request in flight. Fixtures use only `example.com` identities and synthetic secrets. The test removes its containers, network and temporary files on completion. | ||
|
|
||
| The `Native container` workflow builds the local-provider image and runs this test on relevant pull requests or manual dispatch. It does not publish an image or deploy a service. | ||
|
|
||
| ## Local record persistence proof | ||
|
|
||
| Build with `NATIVE_FEATURES=aws-dynamodb-ec,geo-cloudfront`, then run against a disposable DynamoDB Local endpoint: | ||
|
|
||
| ```sh | ||
| node scripts/test-native-ec-image.mjs \ | ||
| --image ts-native:records \ | ||
| --dynamodb http://127.0.0.1:8000 | ||
| ``` | ||
|
|
||
| The same fixture accepts `--binary /absolute/path/trusted-server-axum` instead of an image. It supplies a prepared record binding, dummy AWS credentials, synthetic Geo/consent and an isolated table. It observes the SDK's native keys instead of reconstructing partition encoding. Checks cover acknowledgement-before-cookie, restart, withdrawal, a present past-TTL row racing a delayed CAS, denied and lost acknowledgements, and draining while storage waits. TTL eligibility is not a physical-deletion deadline. | ||
|
|
||
| The fixture never builds/pulls or publishes an image, contacts hosted AWS, or runs a deployment wrapper. Binary-mode proof does not qualify the container build; image-mode proof does not qualify hosted IAM, release security, capacity or real browser consent transport. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤔 thinking: On
pull_requesteventsgithub.shais the synthetic merge commit, not the PR head, so the image's bakedx-ts-versionnames a commit that exists on neither branch. The guide builds with$(git rev-parse HEAD), so CI should label the image with the head commit too.workflow_dispatchstill falls back togithub.sha.