go/firecracker-netns
1
0
Fork 0
Code Pull Requests Actions Packages Releases Activity

doc: complete docs with manual note

Browse Source
This commit is contained in:
RouxAntoine 2024-01-04 16:05:40 +01:00
parent e128f29785
commit 99ca371839
Signed by: antoine
GPG Key ID: 098FB66FC0475E70
1 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/README.md
View File

@ -1,9 +1,41 @@
# documentations
local :
### local :
linter required
```shell
$ brew install golangci-lint
```
firecracker on archlinux
```shell
pacman -S firecracker
```
### build
```shell
make build
```
### get rootfs and necessary stuff
```shell
ARCH="$(uname -m)"
# Download a linux kernel binary
wget https://s3.amazonaws.com/spec.ccfc.min/firecracker-ci/v1.7/${ARCH}/vmlinux-5.10.204
# Download a rootfs
wget https://s3.amazonaws.com/spec.ccfc.min/firecracker-ci/v1.7/${ARCH}/ubuntu-22.04.ext4
# Download the ssh key for the rootfs
wget https://s3.amazonaws.com/spec.ccfc.min/firecracker-ci/v1.7/${ARCH}/ubuntu-22.04.id_rsa
# Set user read permission on the ssh key
chmod 400 ./ubuntu-22.04.id_rsa
```
cf [Official firecracker getting started](https://github.com/firecracker-microvm/firecracker/blob/main/docs/getting-started.md#getting-started-with-firecracker)