Skip to content

docs: add cloud-hypervisor configuration documentation #737

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

Open
rishi-jat wants to merge 1 commit into
base: main
Choose a base branch
from
+34 −0
Open

docs: add cloud-hypervisor configuration documentation #737

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 34 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ default_memory_mb = 256
default_vcpus = 1
path = "/usr/local/bin/firecracker"

[monitors.cloud-hypervisor]
default_memory_mb = 256
default_vcpus = 1
path = "/usr/local/bin/cloud-hypervisor"

[monitors.hvt]
default_memory_mb = 256
default_vcpus = 1
Expand Down Expand Up @@ -99,9 +104,24 @@ values.

- [QEMU/KVM](./hypervisor-support#qemu) - `qemu`
- [Firecracker](./hypervisor-support#firecracker) - `firecracker`
- [Cloud Hypervisor](./hypervisor-support#cloud-hypervisor) - `cloud-hypervisor`
- [Solo5-hvt](./hypervisor-support#solo5-hvt) - `hvt` - Solo5 hvt (KVM-based tender)
- [Solo5-spt](./hypervisor-support#solo5-spt) - `spt` - Solo5 spt (Seccomp-based tender)

##### Cloud Hypervisor

Cloud Hypervisor can be configured through the
`[monitors.cloud-hypervisor]` subsection.
Comment on lines +111 to +114

Example:

```toml
[monitors.cloud-hypervisor]
default_memory_mb = 256
default_vcpus = 1
path = "/usr/local/bin/cloud-hypervisor"
```

#### Monitor Options

Each monitor subsection supports the following options:
Expand Down Expand Up @@ -130,6 +150,11 @@ data_path = "/usr/local/share/"
default_memory_mb = 512
default_vcpus = 2
path = "/opt/firecracker/firecracker"

[monitors.cloud-hypervisor]
default_memory_mb = 512
default_vcpus = 2
path = "/usr/local/bin/cloud-hypervisor"
```

### Extra binaries Configuration
Expand Down Expand Up @@ -194,6 +219,10 @@ To create a configuration file, you can:
default_memory_mb = 256
default_vcpus = 1

[monitors.cloud-hypervisor]
default_memory_mb = 256
default_vcpus = 1

[monitors.hvt]
default_memory_mb = 256
default_vcpus = 1
Expand Down Expand Up @@ -235,6 +264,11 @@ default_memory_mb = 256
default_vcpus = 1
# path is not set by default - urunc will search in PATH

[monitors.cloud-hypervisor]
default_memory_mb = 256
default_vcpus = 1
# path is not set by default - urunc will search in PATH

Comment on lines +267 to +271
[monitors.hvt]
default_memory_mb = 256
default_vcpus = 1
Expand Down