Skip to content
Open
Changes from 1 commit
Commits
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
Prev Previous commit
docs: add build and run steps for unikernel examples
  • Loading branch information
oindrilakha12-ui committed Feb 7, 2026
commit d33d72fa11a9121f976f329050f4bdedae40c584
101 changes: 101 additions & 0 deletions docs/unikernel-examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Building and Running Example Unikernels with urunc

This document explains how to build and run example unikernels using urunc.
It is intended for users who want to quickly experiment with urunc using
real-world applications.

---

## Prerequisites

Before building any unikernel, ensure the following tools are installed:

- Git
- Build tools (make, gcc or clang)
- Docker (optional, but recommended for reproducible builds)
- A working urunc installation

---

## Redis Unikernel Example

Redis is a popular in-memory data store and a good candidate for a unikernel.

### Build Steps

1. Clone the Redis unikernel repository:
```
git clone <redis-unikernel-repository>
cd redis-unikernel
```

2. Build the unikernel image:
```
make
```

3. Verify that the image was created successfully.

### Running with urunc

```
urunc run redis.img
```

---

## Nginx Unikernel Example

Nginx can be used to demonstrate HTTP workloads running as unikernels.

### Build Steps

1. Clone the Nginx unikernel repository:
```
git clone <nginx-unikernel-repository>
cd nginx-unikernel
```

2. Build the unikernel:s
```
make
```

### Running with urunc

```
urunc run nginx.img
```

---

## Httpreply Unikernel Example

Httpreply is a minimal HTTP service useful for testing networking behavior.

### Build Steps

1. Clone the Httpreply unikernel repository:
```
git clone <httpreply-unikernel-repository>
cd httpreply-unikernel
```

2. Build the unikernel:
```
make
```

### Running with urunc

```
urunc run httpreply.img
```

---

## Notes

- Exact build steps may vary depending on the unikernel framework used.
- Docker-based builds are recommended to ensure consistent and reproducible environments.
- These examples can be extended to additional applications and frameworks supported by urunc.