From e7024669a619f4fff2eac1e7c7daf8793ad105cf Mon Sep 17 00:00:00 2001 From: Bun K Tan Date: Fri, 15 Nov 2024 01:14:59 +0000 Subject: [PATCH 1/4] Add troubleshooting tips section Signed-off-by: Bun K Tan --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6d9b653..dc083e0 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ * [10. Build Packages From Source](#build-packages-from-source) * [11. Build Kernel From Source](#build-kernel-from-source) * [12. Run Tests](#sanity-functional-tests) +* [13. Troubleshooting Tips](#troubleshooting-tips) @@ -31,7 +32,9 @@ The host OS and TD setup can be cutomized by editing the global configuration fi ## 2. Report an Issue -Please submit issues [here](https://github.com/canonical/tdx/issues) and we'll get back to you ASAP. +First, check the [Troubleshooting Tips](#troubleshooting-tips) section. + +If your issue can't be resolved, then submit an issue [here](https://github.com/canonical/tdx/issues) and we'll get back to you ASAP. To help us with the debugging process, run the `system-report.sh` tool and attach the report. @@ -78,7 +81,7 @@ Download and install [Ubuntu 24.04 server](https://releases.ubuntu.com/24.04/) o 4. Reboot. -### 4.3 Enable Intel TDX in the Host's BIOS +### 4.3 Enable Intel TDX in the Host's BIOS 1. Go into the host's BIOS. @@ -663,3 +666,12 @@ Here are example instructions for building QEMU (for normal user with sudo right ## 12. Run Tests Please follow [tests/README](tests/README.md) to run Intel TDX tests. + + +## 13. Troubleshooting Tips + +| Issue # | Description | Suggestions | +| - | - | - | +| 1 | Performance is poor | Ensure you're using the latest TDX module. See [link](https://cc-enabling.trustedservices.intel.com/intel-tdx-enabling-guide/04/hardware_setup/#deploy-specific-intel-tdx-module-version) on ways to update your TDX module. | +| 2 | TDX is not enabled on the host | 1. Ensure your installation of the TDX host components using `setup-tdx-host.sh` did not have any errors.
2. Ensure BIOS settings are correct. See [step 4.3](#step-4.3) | +| 3 | Installation seems to hang | 1. Verify you can get out to the Internet.
2. If you're being a proxy, make sure you have proper proxy settings.
3. If you're being a proxy, use `sudo -E` to preserve user environment. | From 6e7cfe7b349da892cdec6c4f4c9cea9e4d513a58 Mon Sep 17 00:00:00 2001 From: Bun K Tan Date: Wed, 20 Nov 2024 21:01:32 -0800 Subject: [PATCH 2/4] Update README.md Co-authored-by: Hector Cao <122458375+hector-cao@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dc083e0..2d89c63 100644 --- a/README.md +++ b/README.md @@ -674,4 +674,4 @@ Please follow [tests/README](tests/README.md) to run Intel TDX tests. | - | - | - | | 1 | Performance is poor | Ensure you're using the latest TDX module. See [link](https://cc-enabling.trustedservices.intel.com/intel-tdx-enabling-guide/04/hardware_setup/#deploy-specific-intel-tdx-module-version) on ways to update your TDX module. | | 2 | TDX is not enabled on the host | 1. Ensure your installation of the TDX host components using `setup-tdx-host.sh` did not have any errors.
2. Ensure BIOS settings are correct. See [step 4.3](#step-4.3) | -| 3 | Installation seems to hang | 1. Verify you can get out to the Internet.
2. If you're being a proxy, make sure you have proper proxy settings.
3. If you're being a proxy, use `sudo -E` to preserve user environment. | +| 3 | Installation seems to hang | 1. Verify you can get out to the Internet.
2. If you're behind a proxy, make sure you have proper proxy settings.
3. If you're behind a proxy, use `sudo -E` to preserve user environment. | From 70e81baa744000613aa54463b550217b63a7d821 Mon Sep 17 00:00:00 2001 From: Bun K Tan Date: Wed, 20 Nov 2024 21:02:15 -0800 Subject: [PATCH 3/4] Update README.md Co-authored-by: Hector Cao <122458375+hector-cao@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2d89c63..843bc79 100644 --- a/README.md +++ b/README.md @@ -672,6 +672,6 @@ Please follow [tests/README](tests/README.md) to run Intel TDX tests. | Issue # | Description | Suggestions | | - | - | - | -| 1 | Performance is poor | Ensure you're using the latest TDX module. See [link](https://cc-enabling.trustedservices.intel.com/intel-tdx-enabling-guide/04/hardware_setup/#deploy-specific-intel-tdx-module-version) on ways to update your TDX module. | +| 1 | Performance is poor | Ensure you're using the latest TDX module. You can check the current version with `dmesg` (the version line looks like: `virt/tdx: TDX module: attributes 0x0, vendor_id 0x8086, major_version 1, minor_version 5, build_date 20240129, build_num 698`). See [link](https://cc-enabling.trustedservices.intel.com/intel-tdx-enabling-guide/04/hardware_setup/#deploy-specific-intel-tdx-module-version) on ways to update your TDX module. | | 2 | TDX is not enabled on the host | 1. Ensure your installation of the TDX host components using `setup-tdx-host.sh` did not have any errors.
2. Ensure BIOS settings are correct. See [step 4.3](#step-4.3) | | 3 | Installation seems to hang | 1. Verify you can get out to the Internet.
2. If you're behind a proxy, make sure you have proper proxy settings.
3. If you're behind a proxy, use `sudo -E` to preserve user environment. | From 71ee57ca102651c0f49f0b1e719ce284407334ec Mon Sep 17 00:00:00 2001 From: Bun K Tan Date: Tue, 26 Nov 2024 20:15:23 +0000 Subject: [PATCH 4/4] Add troubleshooting tips section Signed-off-by: Bun K Tan --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 843bc79..59f10f1 100644 --- a/README.md +++ b/README.md @@ -672,6 +672,6 @@ Please follow [tests/README](tests/README.md) to run Intel TDX tests. | Issue # | Description | Suggestions | | - | - | - | -| 1 | Performance is poor | Ensure you're using the latest TDX module. You can check the current version with `dmesg` (the version line looks like: `virt/tdx: TDX module: attributes 0x0, vendor_id 0x8086, major_version 1, minor_version 5, build_date 20240129, build_num 698`). See [link](https://cc-enabling.trustedservices.intel.com/intel-tdx-enabling-guide/04/hardware_setup/#deploy-specific-intel-tdx-module-version) on ways to update your TDX module. | +| 1 | Performance is poor | Ensure you're using the latest TDX module. You can check the current version with `dmesg` (the version line looks like: `virt/tdx: TDX module: attributes 0x0, vendor_id 0x8086, major_version 1, minor_version 5, build_date 20240129, build_num 698`). See [link](https://cc-enabling.trustedservices.intel.com/intel-tdx-enabling-guide/04/hardware_setup/#deploy-specific-intel-tdx-module-version) on ways to update your TDX module.
NOTE: If you chose to "Update Intel TDX Module via Binary Deployment", make sure you're using the correct TDX module version for your hardware. See the [Supported Hardware](#supported-hardware) table. | | 2 | TDX is not enabled on the host | 1. Ensure your installation of the TDX host components using `setup-tdx-host.sh` did not have any errors.
2. Ensure BIOS settings are correct. See [step 4.3](#step-4.3) | | 3 | Installation seems to hang | 1. Verify you can get out to the Internet.
2. If you're behind a proxy, make sure you have proper proxy settings.
3. If you're behind a proxy, use `sudo -E` to preserve user environment. |