Skip to content

vTPM: add vm settings #490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: 4.20
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/vm-settings-uefi-secure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions source/adminguide/templates/_create_windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,17 @@ An overview of the procedure is as follows:
#. Upload your Windows ISO.

For more information, see `“Adding an
ISO” <virtual_machines.html#adding-an-iso>`_.
ISO” <../templates.html#adding-an-iso>`_.

#. Create an instance with this ISO.

For more information, see `“Creating
instances” <virtual_machines.html#creating-instances>`_.
instances” <../virtual_machines.html#creating-instances>`_.

#. Add Virtual TPM device to the instance.

For more information, see `“Instance Settings for Virtual Trusted Platform Module (vTPM)
” <../virtual_machines.html#instance-settings-for-virtual-trusted-platform-module-vtpm>`_.

#. Follow the steps in Sysprep for Windows Server 2008 R2 (below) or
Sysprep for Windows Server 2003 R2, depending on your version of
Expand Down
44 changes: 44 additions & 0 deletions source/adminguide/virtual_machines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1000,6 +1000,40 @@ An example list of settings as well as their possible values are shown on the im
|vm-settings-values-dropdown-KVM-list.png|
(KVM disk controllers)

|vm-settings-kvm-guest-cpu-model.png|
(KVM guest CPU model, available for root admin since 4.20.1.0)

Instance Settings for Virtual Trusted Platform Module (vTPM)
-----------------------------

Trusted Platform Module (TPM) is a standard for a secure cryptoprocessor, which
can securely store artifacts used to authenticate the platform, including passwords,
certificates, or encryption keys. TPM is required by recent Windows releases.

Virtual Trusted Platform Module (vTPM) is the software-based representation of physical TPM.
CloudStack supports vTPM for instances running on KVM and VMware since 4.20.1.0 .

|vm-settings-uefi-secure.png|
UEFI setting

- On Vmware, the boot type must be set to UEFI. Boot mode can be SECURE (recommended) or LEGACY.
- On KVM, it is recommended to set boot type to UEFI, and boot mode to SECURE.
- UEFI is required for some Windows versions.

|vm-settings-virtual-tpm-model-kvm.png|
TPM model for KVM. There are two options:

- tpm-tis, TIS means TPM Interface Specification;
- tpm-crb, CRB means Command-Response Buffer.

|vm-settings-virtual-tpm-version-kvm.png|
TPM version for KVM. There are two options:

- 2.0. This is the default TPM version. It is used when version is not specified or invalid.
- 1.2. This is not supported with CRB model.

|vm-settings-virtual-tpm-enabled-vmware.png|
Enable or disable vTPM for VMware.

Instance Snapshots
==================
Expand Down Expand Up @@ -1612,6 +1646,16 @@ Instance disk statistics are shown in the Metrics tab in an individual volume vi
:alt: List of possible VMware NIC models
.. |vm-settings-values-dropdown-KVM-list.png| image:: /_static/images/vm-settings-values-dropdown-KVM-list.png
:alt: List of possible KVM disk controllers
.. |vm-settings-kvm-guest-cpu-model.png| image:: /_static/images/vm-settings-kvm-guest-cpu-model.png
:alt: List of possible KVM guest CPU models
.. |vm-settings-uefi-secure.png| image:: /_static/images/vm-settings-uefi-secure.png
:alt: Set boot type to UEFI and mode to SECURE
.. |vm-settings-virtual-tpm-model-kvm.png| image:: /_static/images/vm-settings-virtual-tpm-model-kvm.png
:alt: List of TPM models for KVM
.. |vm-settings-virtual-tpm-version-kvm.png| image:: /_static/images/vm-settings-virtual-tpm-version-kvm.png
:alt: List of TPM versions for KVM
.. |vm-settings-virtual-tpm-enabled-vmware.png| image:: /_static/images/vm-settings-virtual-tpm-enabled-vmware.png
:alt: Enable vTPM or not for VMware
.. |vm-metrics-ui.png| image:: /_static/images/vm-metrics-ui.png
:alt: VM metrics UI
.. |vm-disk-metrics-ui.png| image:: /_static/images/vm-disk-metrics-ui.png
Expand Down