From 0c0ffa2bb90f45794d5df4ac91d90edf4ea2abd3 Mon Sep 17 00:00:00 2001 From: Dong Ma Date: Fri, 17 Jan 2025 00:08:01 +0000 Subject: [PATCH] Update the TPM doc Change-Id: I9b93a3f7b1a6a8a523dfa131fb45c9aa877ad6fd (cherry picked from commit c9be709ba482f5dcff1c915243d9d2ffcafb8f3e) --- doc/source/admin/emulated-tpm.rst | 9 +++++---- releasenotes/notes/fix-tpm-docs-d4cc722764f61032.yaml | 5 +++++ 2 files changed, 10 insertions(+), 4 deletions(-) create mode 100644 releasenotes/notes/fix-tpm-docs-d4cc722764f61032.yaml diff --git a/doc/source/admin/emulated-tpm.rst b/doc/source/admin/emulated-tpm.rst index 5c1ea34e7..58f836dbe 100644 --- 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 \ - --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 new file mode 100644 index 000000000..59861b806 --- /dev/null +++ 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.