From 8474ca80ac3e61fa395fa1809c8309b16aff06f9 Mon Sep 17 00:00:00 2001 From: Bun K Tan Date: Fri, 15 Nov 2024 01:14:59 +0000 Subject: [PATCH] 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..4e3ffa7 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://markdownlivepreview.com/) 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. |