runtime

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.

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.

Index

• Constants
• func TransformFromSchema(ctx context.Context, props interface{}) (interface{}, error)
• type Runtime
  • func NewRuntime(ctx context.Context, name string, pbopts ...RuntimeOption) (*Runtime, error)
  • func (runtime *Runtime) AddRootfs(path string) error
  • func (runtime *Runtime) Architecture() arch.Architecture
  • func (runtime *Runtime) Columns() []tableprinter.Column
  • func (runtime *Runtime) Command() []string
  • func (runtime *Runtime) ConfigFilename() string
  • func (runtime *Runtime) Delete(ctx context.Context) error
  • func (runtime *Runtime) Format() pack.PackageFormat
  • func (runtime *Runtime) ID() string
  • func (runtime *Runtime) Initrd() initrd.Initrd
  • func (runtime *Runtime) Kernel() string
  • func (runtime *Runtime) KernelDbg() string
  • func (elfloader *Runtime) MarshalYAML() (interface{}, error)
  • func (runtime *Runtime) Metadata() interface{}
  • func (elfloader *Runtime) Name() string
  • func (runtime *Runtime) Platform() plat.Platform
  • func (runtime *Runtime) Pull(ctx context.Context, opts ...pack.PullOption) error
  • func (runtime *Runtime) PulledAt(ctx context.Context) (bool, time.Time, error)
  • func (runtime *Runtime) Push(ctx context.Context, opts ...pack.PushOption) error
  • func (runtime *Runtime) Save(ctx context.Context) error
  • func (elfloader *Runtime) SetName(name string)
  • func (runtime *Runtime) Size() int64
  • func (elfloader *Runtime) Source() string
  • func (ocipack *Runtime) String() string
  • func (elfloader *Runtime) Type() unikraft.ComponentType
  • func (runtime *Runtime) Unpack(ctx context.Context, dir string) error
  • func (elfloader *Runtime) Version() string
• type RuntimeOption
  • func WithArchitecture(architecture string) RuntimeOption
  • func WithKernel(kernel string) RuntimeOption
  • func WithName(name string) RuntimeOption
  • func WithPlatform(platform string) RuntimeOption
  • func WithRootfs(rootfs string) RuntimeOption
  • func WithSource(source string) RuntimeOption

Constants

const (
	PrebuiltRegistry         = "unikraft.org"
	DefaultRuntime           = "unikraft.org/base:latest"
	DefaultKraftCloudRuntime = "index.unikraft.io/official/base:latest"
)

Functions

func TransformFromSchema

func TransformFromSchema(ctx context.Context, props interface{}) (interface{}, error)

TransformFromSchema parses an input schema and returns an instantiated runtime.

Types

type Runtime

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

func NewRuntime

func NewRuntime(ctx context.Context, name string, pbopts ...RuntimeOption) (*Runtime, error)

NewRuntime prepares a pre-built unikernel application for use.

func (*Runtime) AddRootfs

func (runtime *Runtime) AddRootfs(path string) error

func (*Runtime) Architecture

func (runtime *Runtime) Architecture() arch.Architecture

Architecture implements kraftkit.sh/unikraft.target.Target

func (*Runtime) Columns

func (runtime *Runtime) Columns() []tableprinter.Column

Columns implements kraftkit.sh/pack.Package

func (*Runtime) Command

func (runtime *Runtime) Command() []string

Command implements kraftkit.sh/unikraft.target.Target

func (*Runtime) ConfigFilename

func (runtime *Runtime) ConfigFilename() string

ConfigFilename implements kraftkit.sh/unikraft.target.Target

func (*Runtime) Delete

func (runtime *Runtime) Delete(ctx context.Context) error

func (*Runtime) Format

func (runtime *Runtime) Format() pack.PackageFormat

Format implements kraftkit.sh/unikraft.component.Component

func (*Runtime) ID

func (runtime *Runtime) ID() string

ID implements kraftkit.sh/pack.Package

func (*Runtime) Initrd

func (runtime *Runtime) Initrd() initrd.Initrd

Initrd implements kraftkit.sh/unikraft.target.Target

func (*Runtime) Kernel

func (runtime *Runtime) Kernel() string

Kernel implements kraftkit.sh/unikraft.target.Target

func (*Runtime) KernelDbg

func (runtime *Runtime) KernelDbg() string

KernelDbg implements kraftkit.sh/unikraft.target.Target

func (*Runtime) MarshalYAML

func (elfloader *Runtime) MarshalYAML() (interface{}, error)

func (*Runtime) Metadata

func (runtime *Runtime) Metadata() interface{}

Metadata implements kraftkit.sh/pack.Package

func (*Runtime) Name

func (elfloader *Runtime) Name() string

Name implements kraftkit.sh/unikraft.Nameable

func (*Runtime) Platform

func (runtime *Runtime) Platform() plat.Platform

Platform implements kraftkit.sh/unikraft.target.Target

func (*Runtime) Pull

func (runtime *Runtime) Pull(ctx context.Context, opts ...pack.PullOption) error

Pull implements kraftkit.sh/pack.Package

func (*Runtime) PulledAt

func (runtime *Runtime) PulledAt(ctx context.Context) (bool, time.Time, error)

Pull implements kraftkit.sh/pack.Package

func (*Runtime) Push

func (runtime *Runtime) Push(ctx context.Context, opts ...pack.PushOption) error

Push implements kraftkit.sh/pack.Package

func (*Runtime) Save

func (runtime *Runtime) Save(ctx context.Context) error

Save implements kraftkit.sh/pack.Package

func (*Runtime) SetName

func (elfloader *Runtime) SetName(name string)

SetName overwrites the name of the runtime.

func (*Runtime) Size

func (runtime *Runtime) Size() int64

Size implements kraftkit.sh/pack.Package

func (*Runtime) Source

func (elfloader *Runtime) Source() string

Source of the ELF Loader runtime.

func (*Runtime) String

func (ocipack *Runtime) String() string

String implements fmt.Stringer

func (*Runtime) Type

func (elfloader *Runtime) Type() unikraft.ComponentType

Type implements kraftkit.sh/unikraft.Nameable

func (*Runtime) Unpack

func (runtime *Runtime) Unpack(ctx context.Context, dir string) error

Unpack implements kraftkit.sh/pack.Package

func (*Runtime) Version

func (elfloader *Runtime) Version() string

Version implements kraftkit.sh/unikraft.Nameable

type RuntimeOption

type RuntimeOption func(*Runtime) error

RuntimeOption are method-driven options that are used to configure the instantiation of a pre-built unikernel application "runtime".

func WithArchitecture

func WithArchitecture(architecture string) RuntimeOption

WithArchitecture sets the architecture of the runtime.

func WithKernel

func WithKernel(kernel string) RuntimeOption

WithKernel sets the specific path to the runtime.

func WithName

func WithName(name string) RuntimeOption

WithName sets the name of the runtime.

func WithPlatform

func WithPlatform(platform string) RuntimeOption

WithPlatform sets the platform of the runtime.

func WithRootfs

func WithRootfs(rootfs string) RuntimeOption

WithRootfs sets the rootfs to be mounted to the runtime

func WithSource

func WithSource(source string) RuntimeOption

WithSource sets the source location of the runtime