Merge "Add release notes" into stable/2023.1
diff --git a/doc/source/admin/emulated-tpm.rst b/doc/source/admin/emulated-tpm.rst
index 5c1ea34..58f836d 100644
--- a/doc/source/admin/emulated-tpm.rst
+++ b/doc/source/admin/emulated-tpm.rst
@@ -59,14 +59,15 @@
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
new file mode 100644
index 0000000..59861b8
--- /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.