Skip to content

Commit 94c03e8

Browse files
committed
docs: Remove duplicate TPM extra spec info
We have a perfectly good TPM guide. Enhance that, allowing us to remove the special section dedicated to this from the generic flavor docs. Change-Id: If484074c01595f747f9201b5ec12164779195b61 Signed-off-by: Stephen Finucane <[email protected]>
1 parent 777c024 commit 94c03e8

File tree

2 files changed

+17
-30
lines changed

2 files changed

+17
-30
lines changed

doc/source/admin/emulated-tpm.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@ feature:
2222
* A `key manager service`__, such as `barbican`__, must be configured to store
2323
secrets used to encrypt the virtual device files at rest.
2424

25-
* QEMU version >= 2.11 (>= 2.12 is recommended)
26-
27-
* Libvirt version >= 5.6.0
28-
2925
* The swtpm__ binary and associated libraries__.
3026

3127
* Set the :oslo.config:option:`libvirt.swtpm_enabled` config option to
@@ -50,8 +46,10 @@ traits on the compute node's resource provider:
5046
Configuring a flavor or image
5147
-----------------------------
5248

53-
A vTPM can be requested on a server via :ref:`flavor extra_specs <vtpm-flavor>`
54-
or image metadata properties.
49+
A vTPM can be requested on a server via flavor extra specs or image metadata
50+
properties. There are two versions supported - 1.2 and 2.0 - and two models -
51+
TPM Interface Specification (TIS) and Command-Response Buffer (CRB). The CRB
52+
model is only supported with version 2.0.
5553

5654
.. list-table::
5755
:header-rows: 1
@@ -68,6 +66,14 @@ or image metadata properties.
6866
- Specify the TPM model, ``tpm-tis`` (the default) or ``tpm-crb`` (only
6967
valid with version ``2.0``.
7068

69+
For example, to configure a flavor to use the TPM 2.0 with the CRB model:
70+
71+
.. code-block:: console
72+
73+
$ openstack flavor set $FLAVOR \
74+
--property hw:tpm_version=2.0 \
75+
--property hw:tpm_model=tpm-crb
76+
7177
Scheduling will fail if flavor and image supply conflicting values, or if model
7278
``tpm-crb`` is requested with version ``1.2``.
7379

@@ -112,10 +118,14 @@ beyond the scope of this document.
112118
References
113119
----------
114120

121+
* `TCG PC Client Specific TPM Interface Specification (TIS)`__
122+
* `TCG PC Client Platform TPM Profile (PTP) Specification`__
115123
* `QEMU docs on tpm`__
116124
* `Libvirt XML to request emulated TPM device`__
117125
* `Libvirt secret for usage type ``vtpm```__
118126
119-
.. __: https://github.com/qemu/qemu/blob/stable-2.12/docs/specs/tpm.txt
127+
.. __: https://trustedcomputinggroup.org/resource/pc-client-work-group-pc-client-specific-tpm-interface-specification-tis/
128+
.. __: https://trustedcomputinggroup.org/resource/pc-client-platform-tpm-profile-ptp-specification/
129+
.. __: https://qemu.readthedocs.io/en/latest/specs/tpm.html
120130
.. __: https://libvirt.org/formatdomain.html#elementsTpm
121131
.. __: https://libvirt.org/formatsecret.html#vTPMUsageType

doc/source/user/flavors.rst

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -454,26 +454,3 @@ Numbered groupings of resource classes and traits
454454
__ https://specs.openstack.org/openstack/nova-specs/specs/rocky/implemented/granular-resource-requests.html
455455

456456
.. versionadded:: 18.0.0 (Rocky)
457-
458-
.. _vtpm-flavor:
459-
460-
Emulated Virtual TPM
461-
If supported by the compute host, you can add an :doc:`emulated trusted
462-
platform module (TPM) </admin/emulated-tpm>` to the guest OS.
463-
464-
.. code:: console
465-
466-
$ openstack flavor set FLAVOR-NAME \
467-
--property hw:tpm_version=$VERSION \
468-
--property hw:tpm_model=$MODEL
469-
470-
``hw:tpm_version`` is required to enable support. Valid ``$VERSION`` values
471-
are:
472-
473-
- ``1.2`` : Selects TPM version 1.2 support.
474-
- ``2.0`` : Selects TPM version 2.0 support.
475-
476-
``hw:tpm_model`` is optional. Valid ``$MODEL`` values are:
477-
478-
- ``tpm-tis``: Selects TIS device model. This is the default value.
479-
- ``tpm-crb``: Selects CRB device model. Only valid for TPM version 2.0.

0 commit comments

Comments
 (0)