Skip to content

docs(kms): require admin TLS for onboarding handover - #1558

Merged
kvinwang merged 3 commits into
nextfrom
docs/kms-admin-handover-tls
Nov 11, 2026
Merged

kvinwang merged 3 commits into
nextfrom
docs/kms-admin-handover-tls

Conversation

@kvinwang

Copy link
Copy Markdown
Collaborator

Onboarding through Admin.GetKmsKey only works when the source's admin listener has [core.admin.tls]: on plain HTTP the new KMS cannot present its RA-TLS certificate, so the call fails with No attestation provided (and Onboard.Onboard with No TLS info in response). The docs did not say so, and the defaults (admin off, loopback, TLS commented out) leave operators to discover it from errors.

  • docs/deployment.md: add the source-side admin config (TLS, reachable address, token); fix the onboarding example to https://<source-kms>:8001 with a required token.
  • dstack/kms/README.md: use https in the admin example that configures TLS; state the onboarding requirements.
  • dstack/kms/kms.toml: note that onboarding needs admin TLS and a reachable address.

Verified against feat/kms-epochs-combined @ ba34bd9e with the #841 kms-onboard fixture: without admin TLS all three handover paths fail and no root key is written; with it, the calls pass attestation and token checks.

Admin.GetKmsKey needs the caller's RA-TLS certificate, which a plain-HTTP
admin listener cannot receive: without [core.admin.tls] the call fails
with "No attestation provided" and the onboarding client fails to verify
the source. Document the source-side admin setup (TLS, a reachable
address, the token), fix the onboarding example's port (8001, not the
gateway's 9202), and use https in the README admin example that already
configures TLS.

Signed-off-by: Kevin Wang <wy721@qq.com>
@kvinwang
kvinwang merged commit 741bfa2 into next Nov 11, 2026
12 checks passed
@kvinwang
kvinwang deleted the docs/kms-admin-handover-tls branch November 11, 2026 12:09
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.

1 participant