diff --git a/docs/ovsa/ovsa_get_started.md b/docs/ovsa/ovsa_get_started.md index f45d4bf299cff8..dfe4b49d98093b 100644 --- a/docs/ovsa/ovsa_get_started.md +++ b/docs/ovsa/ovsa_get_started.md @@ -89,7 +89,7 @@ This section is for the combined role of Model Developer and Independent Softwar Begin this step on the Intel® Core™ or Xeon® processor machine that meets the prerequisites. -> **NOTE**: As an alternative to manually following steps 1 - 11, you can run the script `install_host_deps.sh` in the `Scripts/reference directory` under the OpenVINO™ Security Add-on repository. The script stops with an error message if it identifies any issues. If the script halts due to an error, correct the issue that caused the error and restart the script. The script runs for several minutes and provides progress information. +**NOTE**: As an alternative to manually following steps 1 - 11, you can run the script `install_host_deps.sh` in the `Scripts/reference directory` under the OpenVINO™ Security Add-on repository. The script stops with an error message if it identifies any issues. If the script halts due to an error, correct the issue that caused the error and restart the script. The script runs for several minutes and provides progress information. 1. Test for Trusted Platform Module (TPM) support: ```sh @@ -133,7 +133,9 @@ Begin this step on the Intel® Core™ or Xeon® processor machine that meets th 10. Install the [`tpm2-tools`](https://github.com/tpm2-software/tpm2-tools/releases/download/4.3.0/tpm2-tools-4.3.0.tar.gz).
Installation information is at https://github.com/tpm2-software/tpm2-tools/blob/master/INSTALL.md 11. Install the [Docker packages](https://docs.docker.com/engine/install/ubuntu/). - > **NOTE**: Regardless of whether you used the `install_host_deps.sh` script, complete step 12 to finish setting up the packages on the Host Machine. + +**NOTE**: Regardless of whether you used the `install_host_deps.sh` script, complete step 12 to finish setting up the packages on the Host Machine. + 12. If you are running behind a proxy, [set up a proxy for Docker](https://docs.docker.com/config/daemon/systemd/). The following are installed and ready to use: @@ -187,6 +189,7 @@ This example in this step uses the following names. Your configuration might use ```sh sudo netplan generate ``` + ```sh sudo netplan apply ``` @@ -286,19 +289,25 @@ As an option, you can use `virsh` and the virtual machine manager to create and -vnc :1 ``` 8. Choose ONE of these options to install additional required software: - * **Option 1**: Use a script to install additional software - 1. Copy the script `install_guest_deps.sh` from the `Scripts/reference directory` of the OVSA repository to the Guest VM - 2. Run the script. - 3. Shut down the Guest VM.
- * **Option 2** : Manually install additional software - 1. Install the software tool [`tpm2-tss`](https://github.com/tpm2-software/tpm2-tss/releases/download/2.4.4/tpm2-tss-2.4.4.tar.gz). - Installation information is at https://github.com/tpm2-software/tpm2-tss/blob/master/INSTALL.md - 2. Install the software tool [`tpm2-abmrd`](https://github.com/tpm2-software/tpm2-abrmd/releases/download/2.3.3/tpm2-abrmd-2.3.3.tar.gz). - Installation information is at https://github.com/tpm2-software/tpm2-abrmd/blob/master/INSTALL.md - 3. Install the [`tpm2-tools`](https://github.com/tpm2-software/tpm2-tools/releases/download/4.3.0/tpm2-tools-4.3.0.tar.gz). - Installation information is at https://github.com/tpm2-software/tpm2-tools/blob/master/INSTALL.md - 4. Install the [Docker packages](https://docs.docker.com/engine/install/ubuntu/) - 5. Shut down the Guest VM.
+
Option 1: Use a script to install additional software + a. Copy the script `install_guest_deps.sh` from the Scripts/reference directory of the OVSA repository to the Guest VM
+ b. Run the script.
+ c. Shut down the Guest VM.

+ Click the triangled line to close Option 1 +
+ +
Option 2: Manually install additional software + a. Install the software tool [`tpm2-tss`](https://github.com/tpm2-software/tpm2-tss/releases/download/2.4.4/tpm2-tss-2.4.4.tar.gz)
+ Installation information is at https://github.com/tpm2-software/tpm2-tss/blob/master/INSTALL.md
+ b. Install the software tool [`tpm2-abmrd`](https://github.com/tpm2-software/tpm2-abrmd/releases/download/2.3.3/tpm2-abrmd-2.3.3.tar.gz)
+ Installation information is at https://github.com/tpm2-software/tpm2-abrmd/blob/master/INSTALL.md
+ c. Install the [`tpm2-tools`](https://github.com/tpm2-software/tpm2-tools/releases/download/4.3.0/tpm2-tools-4.3.0.tar.gz)
+ Installation information is at https://github.com/tpm2-software/tpm2-tools/blob/master/INSTALL.md
+ d. Install the [Docker packages](https://docs.docker.com/engine/install/ubuntu/) + e. Shut down the Guest VM.

+ Click the triangled line to close Option 2 +
+ 9. On the host, create a directory to support the virtual TPM device. Only `root` should have read/write permission to this directory: ```sh sudo mkdir -p /var/OVSA/ @@ -335,10 +344,13 @@ As an option, you can use `virsh` and the virtual machine manager to create and 12. Use a VNC client to log on to the Guest VM at `:1` + + ### Step 4: Set Up one Guest VM for the User role -1. Choose ONE of these options to create a Guest VM for the User role:
- **Option 1: Copy and Rename the `ovsa_isv_dev_vm_disk.qcow2` disk image** +1. Choose ONE of these options to create a Guest VM for the User role: + +
Option 1: Copy and Rename the `ovsa_isv_dev_vm_disk.qcow2` disk image 1. Copy the `ovsa_isv_dev_vm_disk.qcow2` disk image to a new image named `ovsa_runtime_vm_disk.qcow2`. You created the `ovsa_isv_dev_vm_disk.qcow2` disk image in Step 3. 2. Boot the new image. 3. Change the hostname from `ovsa_isv_dev` to `ovsa_runtime`. @@ -356,7 +368,11 @@ As an option, you can use `virsh` and the virtual machine manager to create and ``` 6. Shut down the Guest VM.

- **Option 2: Manually create the Guest VM** +Click the triangled line above to close Option 1. +
+ +
Option 2: Manually create the Guest VM + 1. Create an empty virtual disk image: ```sh sudo qemu-img create -f qcow2 /ovsa_ovsa_runtime_vm_disk.qcow2 20G @@ -384,21 +400,29 @@ As an option, you can use `virsh` and the virtual machine manager to create and -vnc :2 ``` 7. Choose ONE of these options to install additional required software: +
Option 1: Use a script to install additional software + a. Copy the script `install_guest_deps.sh` from the Scripts/reference directory of the OVSA repository to the Guest VM + b. Run the script. + c. Shut down the Guest VM.

- **Option 1: Use a script to install additional software** - 1. Copy the script `install_guest_deps.sh` from the `Scripts/reference` directory of the OVSA repository to the Guest VM - 2. Run the script. - 3. Shut down the Guest VM.

+Click the triangled line to close Option 2. + +
- **Option 2: Manually install additional software** - 1. Install the software tool [`tpm2-tss`](https://github.com/tpm2-software/tpm2-tss/releases/download/2.4.4/tpm2-tss-2.4.4.tar.gz)
+
Option 2: Manually install additional software + 1. Install the software tool [`tpm2-tss`](https://github.com/tpm2-software/tpm2-tss/releases/download/2.4.4/tpm2-tss-2.4.4.tar.gz)
Installation information is at https://github.com/tpm2-software/tpm2-tss/blob/master/INSTALL.md

2. Install the software tool [`tpm2-abmrd`](https://github.com/tpm2-software/tpm2-abrmd/releases/download/2.3.3/tpm2-abrmd-2.3.3.tar.gz)
Installation information is at https://github.com/tpm2-software/tpm2-abrmd/blob/master/INSTALL.md

3. Install the [`tpm2-tools`](https://github.com/tpm2-software/tpm2-tools/releases/download/4.3.0/tpm2-tools-4.3.0.tar.gz)
Installation information is at https://github.com/tpm2-software/tpm2-tools/blob/master/INSTALL.md

- 4. Install the [Docker packages](https://docs.docker.com/engine/install/ubuntu/) - 5. Shut down the Guest VM.

+ 4. Install the [Docker packages](https://docs.docker.com/engine/install/ubuntu/)

+ 5. Shut down the Guest VM.

+ +Click the triangled line to close the option to manually install additional software. +
+ +
2. Create a directory to support the virtual TPM device. Only `root` should have read/write permission to this directory: ```sh @@ -432,6 +456,8 @@ As an option, you can use `virsh` and the virtual machine manager to create and Use the QEMU runtime options in the command to change the memory amount or CPU assigned to this Guest VM. 5. Use a VNC client to log on to the Guest VM at `:` where `` corresponds to the vnc number in the `start_ovsa_isv_vm.sh` or in step 8. + + ## How to Build and Install the OpenVINO™ Security Add-on Software Follow the below steps to build and Install OpenVINO™ Security Add-on on host and different VMs.