Skip to content

Commit bcfeabc

Browse files
committed
feat(kraftfile): Information about specifying tarball rootfs
Signed-off-by: Alexander Jung <alex@unikraft.cloud>
1 parent ff98062 commit bcfeabc

File tree

1 file changed

+13
-0
lines changed
  • content/docs/cli/reference/kraftfile

1 file changed

+13
-0
lines changed

content/docs/cli/reference/kraftfile/v0.6.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ The provided path to the `rootfs` element can be one of the following:
157157
- [A path to a directory](#specifying-a-directory) which is then dynamically serialized into a CPIO archive; or,
158158
- [A path to a `Dockerfile`](#specifying-a-dockerfile) which will be constructed via [BuildKit](https://github.com/moby/buildkit) and then dynamically serialized into a CPIO archive.
159159
[Learn more about how to enable this feature in KraftKit](/docs/cli/filesystem#using-a-dockerfile-as-a-static-root-filesystem).
160+
- [A path to a tarball](#specifying-a-tarball) which will extract and repackage the tarball as a CPIO archive. In the future we plan to support [tarballs and other file system types directly as initramfs](https://github.com/unikraft/unikraft/issues/1571).
160161

161162
When invoking `kraft build` or `kraft run` and the provided path of the `rootfs` is either a directory or a `Dockerfile`, the resulting filesystem will be dynamically serialized and stored in `.unikraft/build/initramfs.cpio`.
162163

@@ -184,6 +185,18 @@ spec: v0.6
184185
rootfs: ./Dockerfile
185186
```
186187

188+
### Specifying a tarball
189+
190+
```yaml ln={3-4,6-7}
191+
spec: v0.6
192+
193+
# An uncompressed tarball
194+
rootfs: ./rootfs.tar
195+
196+
# A compressed tarball
197+
rootfs: ./rootfs.tar.gz
198+
```
199+
187200

188201
## Top-level `unikraft` attribute
189202

0 commit comments

Comments
 (0)