Skip to content

Commit

Permalink
docs: remove --firecracker-path option in README
Browse files Browse the repository at this point in the history
Signed-off-by: Malo Polese <malo.polese@gmail.com>
  • Loading branch information
MaloPolese committed May 9, 2023
1 parent fc04731 commit 1c171aa
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions riklet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,25 @@ Here is a list of **required** environment variables to run riklet:
To run riklet with FAAS configuration.

```bash
sudo riklet --firecracker-path ${FIRECRACKER_LOCATION} \
--kernel-path ${KERNEL_LOCATION} --ifnet ${IFACE} \
--ifnet-ip ${IFACE_IP} --script-path ${SCRIPT_LOCATION}
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 --firecracker-path $(which firecracker) --kernel-path ./vmlinux.bin --ifnet wlp2s0 --ifnet-ip 192.168.1.84 --script-path ./scripts/setup-host-tap.sh
sudo riklet --kernel-path ./vmlinux.bin \
--ifnet wlp2s0 \
--ifnet-ip 192.168.1.84 \
--script-path ./scripts/setup-host-tap.sh
```

You should see something like that :
Expand All @@ -74,7 +84,7 @@ You should see something like that :
| / | | | \ | | | __| | |
| |\ \ _| |_| |\ \| |____| |___ | |
\_| \_|\___/\_| \_/\_____/\____/ \_/
[2021-07-03T15:04:09Z INFO riklet::core] Riklet (v0.1.0) is ready to accept connections.
```

Expand Down

0 comments on commit 1c171aa

Please sign in to comment.