-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Malo Polese <[email protected]>
- Loading branch information
1 parent
f75615b
commit e2b5b55
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Riklet | ||
|
||
[Rust in Kube (RIK)](https://github.com/dev-sys-do/rik) node agent | ||
|
||
## Faas Configuration | ||
|
||
**Prerequisite**: You need firecracker in yout PATH. | ||
|
||
Here is a list of **required** environment variables to run riklet: | ||
|
||
| Environment Variable | Description | Default | | ||
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------- | | ||
| `IFACE` | Network interface connected to the internet | "" | | ||
| `IFACE_IP` | IP of the Network interface connected to the internet | "" | | ||
| `FIRECRACKER_LOCATION` | Path to the firecracker binary | "" | | ||
| `KERNEL_LOCATION` | Path to the kernel location | "" | | ||
| `SCRIPT_LOCATION` | Path to the [script](https://github.com/polyxia-org/rik/blob/main/scripts/setup-host-tap.sh) that create tap interface. | "" | | ||
|
||
To run riklet with FAAS configuration. | ||
|
||
```bash | ||
sudo riklet --kernel-path ${KERNEL_LOCATION} \ | ||
--ifnet ${IFACE} \ | ||
--ifnet-ip ${IFACE_IP} \ | ||
--script-path ${SCRIPT_LOCATION} | ||
``` | ||
|
||
> The firecracker binary location is determined by the following order: | ||
> | ||
> - **$FIRECRACKER_LOCATION** environment variable: direct path to the binary | ||
> - **$PATH** environment variable: search for the binary in the directories | ||
> - firecracker binary in the current working directory | ||
Exemple: | ||
|
||
```bash | ||
sudo riklet --kernel-path ./vmlinux.bin \ | ||
--ifnet wlp2s0 \ | ||
--ifnet-ip 192.168.1.84 \ | ||
--script-path ./scripts/setup-host-tap.sh | ||
``` |