Skip to content

docs: add container runtime scenario to E2E test documentation#675

Open
bfjelds wants to merge 6 commits into
mainfrom
user/bfjelds/e2e-docs-container-scenario
Open

docs: add container runtime scenario to E2E test documentation#675
bfjelds wants to merge 6 commits into
mainfrom
user/bfjelds/e2e-docs-container-scenario

Conversation

@bfjelds

@bfjelds bfjelds commented Jun 8, 2026

Copy link
Copy Markdown
Member

Add comprehensive coverage of the container runtime alongside the existing host runtime documentation in E2E-Tests.md.

Changes

  • Intro section explaining host vs container runtime differences
  • Container COSI image types table (container-testimage, container-verity, container-usrverity)
  • Build step for Trident Docker container image (docker-build + tarball export)
  • Container-specific COSI image build commands
  • Container installer ISO download instructions (downloaded from pipeline, not built locally)
  • VM memory requirements for container (11+ GiB for Docker overhead)
  • Container netlaunch target (
    un-netlaunch-container-images)
  • Host Configuration \�dditionalFiles\ entry for container tarball
  • Pytest -R container\ flag usage
  • Storm-trident A/B update with \container\ runtime type
  • Pipeline scheduling showing container entries in target-configurations.yaml
  • SELinux check note (host-only)

Derived from the actual pipeline definitions (\�2e-template.yml,
etlaunch-testing.yml, \download-test-images.yml, \ rident-prep.yml, \ rident-container.yml) and Makefile targets.

Add comprehensive coverage of the container runtime alongside the existing
host runtime documentation. Key additions:

- Intro section explaining host vs container runtime differences
- Container COSI image types table (container-testimage, container-verity,
  container-usrverity) alongside host images
- Build step for Trident Docker container image (docker-build + tarball)
- Container-specific COSI image build commands
- Container installer ISO download instructions
- VM memory requirements for container (11+ GiB for Docker overhead)
- Container netlaunch target (run-netlaunch-container-images)
- Host Configuration additionalFiles entry for container tarball
- Pytest -R container flag usage
- Storm-trident ab-update with container runtime type
- Pipeline scheduling showing container entries in target-configurations.yaml
- SELinux check note (host-only)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Comment thread docs/Development/Testing/E2E-Tests.md Outdated
Comment thread docs/Development/Testing/E2E-Tests.md Outdated
bfjelds and others added 2 commits June 8, 2026 09:53
- Change 'host OS' to 'servicing OS' for accuracy
- Replace pipeline download with local build for container installer ISO
  (testimages.py build trident-container-installer) — no pipeline access needed
- Consolidate QEMU VM creation to one command with a note about --mem 12
  being required only for container runtime

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The pipeline storm-trident helper prepare-images renames all COSI images
to the same output filenames regardless of runtime. Align the manual build
instructions to match so Host Configuration image URLs work unchanged for
both runtimes.

Also:
- Add explicit SSH public key injection step (configs ship with empty
  sshPublicKeys list, which blocks pytest SSH access)
- Restructure Host Configuration section with subheadings for clarity

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bfjelds bfjelds marked this pull request as ready for review June 8, 2026 18:31
@bfjelds bfjelds requested a review from a team as a code owner June 8, 2026 18:31
Copilot AI review requested due to automatic review settings June 8, 2026 18:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR expands the E2E test documentation to cover running scenarios where Trident executes inside a Docker container, alongside the existing host-runtime workflow, aligning the doc with pipeline/runtime distinctions used by storm-trident and netlaunch.

Changes:

  • Adds an introduction explaining host vs container runtime artifacts and behavioral differences.
  • Documents container-specific COSI image types and build steps (including container tarball handling and netlaunch target).
  • Updates run instructions/examples for pytest and A/B update flows to include container runtime flags and scheduling examples.

Comment thread docs/Development/Testing/E2E-Tests.md
bfjelds and others added 2 commits June 8, 2026 11:51
Update container runtime section to recommend the Make target
(download from pipeline) as the primary method, with testimages.py
as a local-build alternative.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 8, 2026 18:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread docs/Development/Testing/E2E-Tests.md Outdated
The Makefile target uses zstd compression (docker save | zstd), not gzip.
Update the docs to match the actual build behavior.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread docs/Development/Testing/E2E-Tests.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants