Merge "Update the TPM doc" into stable/zed

vexxhost · Jan 17, 2025 · f7258f9 · f7258f9
2 parents 4300601 + 0c0ffa2
commit f7258f9
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/doc/source/admin/emulated-tpm.rst b/doc/source/admin/emulated-tpm.rst
@@ -59,14 +59,15 @@ the CRB model:
 Image configuration
 -------------------
 
-You can also configure the vTPM on an image using the same properties. For example,
-to configure an image to use the TPM 2.0 with CRB model:
+You can also configure the vTPM on an image using the ``hw_tpm_version`` and
+``hw_tpm_model`` image metadata properties. For example, to configure an image
+to use the TPM 2.0 with CRB model:
 
 .. code-block:: console
 
  $ openstack image set <image-name-or-uuid> \
-     --property hw:tpm_version=2.0 \
-     --property hw:tpm_model=tpm-crb
+     --property hw_tpm_version=2.0 \
+     --property hw_tpm_model=tpm-crb
 
 This can be useful if you need to enable the vTPM feature without having operator
 access to the cloud or for specific images such as Windows versions that require

diff --git a/releasenotes/notes/fix-tpm-docs-d4cc722764f61032.yaml b/releasenotes/notes/fix-tpm-docs-d4cc722764f61032.yaml
@@ -0,0 +1,5 @@
+---
+fixes:
+  - The documentation for using the vTPM was pointing to the incorrect
+    metadata properties for images.  This has been corrected to point to the
+    correct metadata properties.