Index of /


../
libs/                                              31-Jan-2025 18:34                   -
index.yaml                                         31-Jan-2025 18:34                6308
unikraft.yaml                                      31-Jan-2025 18:34                3564

Unikraft Component Index

This repository contains the complete and up-to-date list of official Unikraft microlibraries as well as the meta information about the Unikraft core repository. Each microlibrary and the unikraft core form a component with the build-system of Unikraft itself. Along for use with kraft, this list is used to retrieve information about available repositories which can be used in the Unikraft ecosystem.

Component Structure

Each component manifest is structured in a YAML file using the following metadata attributes:

Attribute Requirement Description
name Required The name of the component.
type Required The type of component. One of [core, arch, plat, lib and app].
description Optional A short description of the component.
provider Required The provider type. This indicates the origin type. One of [github, git, tarball, index, dir and manifest].
channels Required List of channels for the component. See Channels.
versions Required List of versions for the component. See Versions.
manifest Optional Pointer to an alternative path representing this component manifest.

Channels

Each component can have multiple channels but at least one and one default one, typically these are stable and staging and represent the active branches or “channels of the remote repository which one can “subscribe” to instead of specifying a specific version. For each channel, the following attributes are set:

Attribute Requirement Description
name Required The name of the distribution, e.g. stable.
default Optional Whether this is the default channel in the list of channels.
resource Required The path, typically a URL, pointing to the source code of this component on this channel.
sha256 Optional The SHA256 sum of the remote resource.

Versions

A specific version of the component. For each version, the following attributes are set:

Attribute Requirement Description
version Required The version “name”.
type Optional The format of the version. One of [gitsha, semver].
resource Required The path, typically a URL, pointing to the source code of this component at this version.
sha256 Optional The SHA256 sum of the remote resource.
unikraft Optional The lowest version of Unikraft which this component is compatible in semver format.

Index

An index file contains the complete list of components and acts as a

Attribute Requirement Description
last_updated Required When the index was last updated in RFC3339 (with nano precision).
manifests Required List of component manifests in this index. See Component Structure.