Skip to content
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.

Sign up for GitHub

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

Add troubleshooting tips section #273

Merged
merged 4 commits into from
Nov 26, 2024
Merged

Add troubleshooting tips section #273

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e702466
Add troubleshooting tips section
bktan8 Nov 15, 2024
6e7cfe7
Update README.md
bktan8 Nov 21, 2024
70e81ba
Update README.md
bktan8 Nov 21, 2024
71ee57c
Add troubleshooting tips section
bktan8 Nov 26, 2024
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
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- headings -->
<a id="introduction"></a>
Expand All @@ -31,7 +32,9 @@ The host OS and TD setup can be cutomized by editing the global configuration fi

<a id="report-an-issue"></a>
## 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.
Expand Down Expand Up @@ -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<a id="step-4-3"></a>

1. Go into the host's BIOS.

Expand Down Expand Up @@ -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.

<a id="troubleshooting-tips"></a>
## 13. Troubleshooting Tips

| 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. <br> 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. <br> 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. <br> 2. If you're behind a proxy, make sure you have proper proxy settings. <br> 3. If you're behind a proxy, use `sudo -E` to preserve user environment. |