Skip to content

Commit

Permalink
docs: Massive overhaul of docs
Browse files Browse the repository at this point in the history
- New logos
- Matching colourscheme
- API docs
- Up to date content
  • Loading branch information
Callisto13 committed Nov 1, 2022
1 parent 4132a20 commit 193b302
Show file tree
Hide file tree
Showing 43 changed files with 570 additions and 1,586 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Using API requests (via gRPC or HTTP):

## Documentation

See our [getting started with flintlock][quickstart] guide.
See our [getting started with flintlock][quickstart] tutorial.

## Contributing

Expand All @@ -50,21 +50,21 @@ Your feedback is always welcome!

The table below shows you which versions of Firecracker are compatible with Flintlock:

| Flintlock | Firecracker |
| ----------------- | -------------------------------- |
| v0.3.0 | Official v1.0+ or v1.0.0-macvtap |
| <= v0.2.0 | <= v0.25.2-macvtap |
| <= v0.1.0-alpha.6 | <= v0.25.2-macvtap |
| v0.1.0-alpha.7 | **Do not use** |
| v0.1.0-alpha.8 | <= v0.25.2-macvtap |
| Flintlock | Firecracker |
| ----------------- | ---------------------------------- |
| >= v0.3.0 | Official v1.0+ or >=v1.0.0-macvtap |
| <= v0.2.0 | <= v0.25.2-macvtap |
| <= v0.1.0-alpha.6 | <= v0.25.2-macvtap |
| v0.1.0-alpha.7 | **Do not use** |
| v0.1.0-alpha.8 | <= v0.25.2-macvtap |

> Note: Flintlock currently requires a custom build of Firecracker if you plan to use macvtap available [here][fc-fork].
> Note: Flintlock currently requires a custom build of Firecracker if you plan to use `macvtap` available [here][fc-fork].
## License

[MPL-2.0 License][license]

[quickstart]: ./docs/quick-start.md
[quickstart]: https://docs.flintlock.dev/docs/category/getting-started
[contrib]: ./CONTRIBUTING.md
[coc]: ./CODE_OF_CONDUCT.md
[issues]: https://github.com/weaveworks-liquidmetal/flintlock/issues
Expand Down
54 changes: 2 additions & 52 deletions docs/image-creation.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,5 @@
# Container Image Creation for MicroVM usage

These are temporary instructions on how to create container images for use by the microVM as a source for:
This doc has been superseded by the [published docs][site].

- Volumes
- Kernel
- Initrd

## Setup

Run the following command to download the Ubuntu Server cloud images:

```shell
hack/scripts/download_cloudimages.sh
```

This downloads the Ubuntu Server Cloud Image files and and processes them. The downloaded files and processed files will be available in `out/images` by default. There are a number of flags that can be used for customization:

| Flag | Description |
| --------------- | ---------------------------------------------------------------- |
| -o/--output | Specifies the output folder to use. Defaults to `./out`. |
| -v/--version | Specifies the ubuntu version to download. Defaults to `bionic`. |
| -s/--image-size | Specifies the size of the root fs to create. Defaults to `10G`. |

The processed files (i.e. root filesystem, uncompressed kernel, initrd) can be used directly with Firecracker without flintlock.

> As an alternative using the download script you can use [debootstrap](https://wiki.debian.org/Debootstrap) by running `sudo debootstrap bionic ./out/images/mount > /dev/null`. The commands in the following sections may need to be adapted.
## Building a volume container image

1. Run the following to mount the downloaded and processed root filesystem:

```shell
mkdir -p out/images/mount
sudo mount -o loop out/images/bionic/bionic.rootfs ./out/images/mount
```

2. Run the following to create the container image (replacing `myorg/ubuntu-bionic-volume:v0.0.1` with your required container image name/tag):

```shell
sudo tar -C ./out/images/mount -c . | docker import - myorg/ubuntu-bionic-volume:v0.0.1
docker push myorg/ubuntu-bionic-volume:v0.0.1
```

## Building a Kernel/Initrd container image

1. Create a Dockerfile that adds the uncompressed kernel and initrd. For example:

```dockerfile
FROM scratch

COPY vmlinux initrd-generic /
```

2. Use docker build and then push
[site]: https://docs.flintlock.dev/docs/guides/images
Loading

0 comments on commit 193b302

Please sign in to comment.