Skip to content

Commit

Permalink
Merge pull request #204 from jacobweinstock/update-capt-doc
Browse files Browse the repository at this point in the history
Update CAPT doc:

## Description

<!--- Please describe what this PR is going to change -->
I found there was some missing requirements to get everything working.

## Why is this needed

<!--- Link to issue you have raised -->

Fixes: #

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->


## How are existing users impacted? What migration steps/scripts do we need?

<!--- Fixes a bug, unblocks installation, removes a component of the stack etc -->
<!--- Requires a DB migration script, etc. -->


## Checklist:

I have:

- [ ] updated the documentation and/or roadmap (if required)
- [ ] added unit or e2e tests
- [ ] provided instructions on how to upgrade
  • Loading branch information
jacobweinstock authored Dec 6, 2024
2 parents 9b39e81 + 06fde1d commit 0348a9f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions capt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Start by reviewing and installing the [prerequisites](#prerequisites) and unders

## Prerequisites

### Operating System

This playground has only been tested on Ubuntu 22.04 LTS. If you are using a virtual machine, ensure that you have hardware virtualization enabled.

### Binaries

- [Libvirtd](https://wiki.debian.org/KVM) >= libvirtd (libvirt) 8.0.0
Expand All @@ -22,6 +26,14 @@ Start by reviewing and installing the [prerequisites](#prerequisites) and unders
- [yq](https://github.com/mikefarah/yq/#install) >= v4.44.2
- [task](https://taskfile.dev/installation/) >= 3.37.2

### Packages

The `ovmf` package is required for the libvirt VMs to run properly. OVMF is a port of Intel's tianocore firmware to the qemu virtual machine. Install it with the following command.

```bash
sudo apt install ovmf
```

### Hardware

- at least 60GB of free and very fast disk space (etcd is very disk I/O sensitive)
Expand Down

0 comments on commit 0348a9f

Please sign in to comment.