initrd

Documentation

Overview

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

Package initrd is a package that is used for the dynamic construction of CPIO archives which are used as initramfs for a unikernel instance.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2024, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2024, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

Index

• Constants
• type Initrd
  • func New(ctx context.Context, path string, opts ...InitrdOption) (Initrd, error)
  • func NewFromDirectory(_ context.Context, path string, opts ...InitrdOption) (Initrd, error)
  • func NewFromDockerfile(ctx context.Context, path string, opts ...InitrdOption) (Initrd, error)
  • func NewFromFile(_ context.Context, path string, opts ...InitrdOption) (Initrd, error)
  • func NewFromOCIImage(ctx context.Context, path string, opts ...InitrdOption) (Initrd, error)
• type InitrdOption
  • func WithArchitecture(arch string) InitrdOption
  • func WithCacheDir(dir string) InitrdOption
  • func WithCompression(compress bool) InitrdOption
  • func WithOutput(output string) InitrdOption
  • func WithWorkdir(dir string) InitrdOption
• type InitrdOptions

Constants

const (
	// DefaultInitramfsFileName is the default filename used when creating or
	// serializing a CPIO archive.
	DefaultInitramfsFileName = "initramfs.cpio"

	// DefaultInitramfsArchFileName is the default filename used when creating
	// or serializing a CPIO archive based on a specific architecture
	DefaultInitramfsArchFileName = "initramfs-%s.cpio"
)

Types

type Initrd

type Initrd interface {
	// Build the rootfs and return the location of the result or error.
	Build(context.Context) (string, error)

	// All directories and files that are contained within the initramfs.
	Files() []string

	// All environment variables that are set within.
	Env() []string

	// All arguments that are passed to the initramfs.
	Args() []string
}

Initrd is an interface that is used to allow for different underlying implementations to construct a CPIO archive.

func New

func New(ctx context.Context, path string, opts ...InitrdOption) (Initrd, error)

New attempts to return the builder for a supplied path which will allow the provided ...

func NewFromDirectory

func NewFromDirectory(_ context.Context, path string, opts ...InitrdOption) (Initrd, error)

NewFromDirectory returns an instantiated Initrd interface which is is able to serialize a rootfs from a given directory.

func NewFromDockerfile

func NewFromDockerfile(ctx context.Context, path string, opts ...InitrdOption) (Initrd, error)

NewFromDockerfile accepts an input path which represents a Dockerfile that can be constructed via buildkit to become a CPIO archive.

func NewFromFile

func NewFromFile(_ context.Context, path string, opts ...InitrdOption) (Initrd, error)

NewFromFile accepts an input file which already represents a CPIO archive and is provided as a mechanism for satisfying the Initrd interface.

func NewFromOCIImage

func NewFromOCIImage(ctx context.Context, path string, opts ...InitrdOption) (Initrd, error)

NewFromOCIImage creates a new initrd from a remote container image.

type InitrdOption

type InitrdOption func(*InitrdOptions) error

func WithArchitecture

func WithArchitecture(arch string) InitrdOption

WithArchitecture sets the architecture of the file contents of binaries in the initramfs. Files may not always be architecture specific, this option simply indicates the target architecture if any binaries are compiled by the implementing initrd builder.

func WithCacheDir

func WithCacheDir(dir string) InitrdOption

WithCacheDir sets the path of an internal location that's used during the serialization of the initramfs as a mechanism for storing temporary files used as cache.

func WithCompression

func WithCompression(compress bool) InitrdOption

WithCompression sets the compression of the resulting CPIO archive file.

func WithOutput

func WithOutput(output string) InitrdOption

WithOutput sets the location of the output location of the resulting CPIO archive file.

func WithWorkdir

func WithWorkdir(dir string) InitrdOption

WithWorkdir sets the working directory of the initramfs builder. This is used as a mechanism for storing temporary files and directories during the serialization of the initramfs.

type InitrdOptions

type InitrdOptions struct {
	// contains filtered or unexported fields
}