Skip to content

docs: add no-TEE swtpm development guide#803

Merged
kvinwang merged 2 commits into
masterfrom
docs/no-tee-swtpm-development
Jul 20, 2026
Merged

docs: add no-TEE swtpm development guide#803
kvinwang merged 2 commits into
masterfrom
docs/no-tee-swtpm-development

Conversation

@kvinwang

@kvinwang kvinwang commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • document how to build and identify a development guest image
  • show how to run dstack with --no-tee and key_provider=tpm
  • document encrypted-disk and restart-persistence verification
  • add the guide to the root README

Validation

Tested end-to-end on Ubuntu 24.04 with KVM, QEMU 8.2.2, and swtpm 0.7.3:

  • development TEE simulator reached Boot Progress: done
  • VMM launched QEMU together with swtpm
  • guest reported encryption=true, filesystem=Zfs
  • guest opened /dev/mapper/dstack_data_disk using the detached LUKS2 header
  • after a graceful stop/start, the instance ID remained unchanged
  • the second boot mounted the existing data disk and started the existing container

git diff --check passes.

Copilot AI review requested due to automatic review settings July 20, 2026 10:23

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 adds documentation for developing and testing dstack on machines without TEE hardware by using --no-tee plus swtpm for persistent TPM-backed keys, and links the new guide from the root README.

Changes:

  • Add a new end-to-end guide for building a development guest image and running the VMM in no-TEE mode with swtpm persistence checks.
  • Document an optional nested-KVM (libvirt) lab setup for Ubuntu 24.04.
  • Link the new guide from README.md for discoverability.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
README.md Adds a top-level link to the new no-TEE + swtpm development guide.
docs/development-without-tee.md New guide covering build, setup, launch, and persistence verification in no-TEE mode.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/development-without-tee.md Outdated
Comment thread docs/development-without-tee.md
@kvinwang
kvinwang force-pushed the docs/no-tee-swtpm-development branch from 0385b70 to 2604716 Compare July 20, 2026 10:34
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@kvinwang
kvinwang enabled auto-merge July 20, 2026 10:40
@kvinwang
kvinwang merged commit d6d12e7 into master Jul 20, 2026
15 checks passed
@kvinwang
kvinwang deleted the docs/no-tee-swtpm-development branch July 20, 2026 14:05
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