plat

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.

Index

• func TransformFromSchema(ctx context.Context, data interface{}) (interface{}, error)
• type Platform
  • func NewPlatformFromOptions(opts ...PlatformOption) (Platform, error)
• type PlatformConfig
  • func (pc PlatformConfig) IsUnpacked() bool
  • func (pc PlatformConfig) KConfig() kconfig.KeyValueMap
  • func (pc PlatformConfig) KConfigTree(context.Context, ...*kconfig.KeyValue) (*kconfig.KConfigFile, error)
  • func (pc PlatformConfig) MarshalYAML() (interface{}, error)
  • func (pc PlatformConfig) Name() string
  • func (pc PlatformConfig) Path() string
  • func (pc PlatformConfig) PrintInfo(ctx context.Context) string
  • func (pc PlatformConfig) Source() string
  • func (pc PlatformConfig) String() string
  • func (pc PlatformConfig) Type() unikraft.ComponentType
  • func (pc PlatformConfig) Version() string
• type PlatformOption
  • func WithInternal(internal bool) PlatformOption
  • func WithKConfig(kconfig kconfig.KeyValueMap) PlatformOption
  • func WithName(name string) PlatformOption
  • func WithPath(path string) PlatformOption
  • func WithSource(source string) PlatformOption
  • func WithVersion(version string) PlatformOption

Functions

func TransformFromSchema

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

TransformFromSchema parses an input schema and returns an instantiated PlatformConfig

Types

type Platform

type Platform interface {
	component.Component
}

func NewPlatformFromOptions

func NewPlatformFromOptions(opts ...PlatformOption) (Platform, error)

NewPlatformFromOptions is a constructor that configures a platform configuration.

type PlatformConfig

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

func (PlatformConfig) IsUnpacked

func (pc PlatformConfig) IsUnpacked() bool

func (PlatformConfig) KConfig

func (pc PlatformConfig) KConfig() kconfig.KeyValueMap

func (PlatformConfig) KConfigTree

func (pc PlatformConfig) KConfigTree(context.Context, ...*kconfig.KeyValue) (*kconfig.KConfigFile, error)

func (PlatformConfig) MarshalYAML

func (pc PlatformConfig) MarshalYAML() (interface{}, error)

func (PlatformConfig) Name

func (pc PlatformConfig) Name() string

func (PlatformConfig) Path

func (pc PlatformConfig) Path() string

func (PlatformConfig) PrintInfo

func (pc PlatformConfig) PrintInfo(ctx context.Context) string

func (PlatformConfig) Source

func (pc PlatformConfig) Source() string

func (PlatformConfig) String

func (pc PlatformConfig) String() string

func (PlatformConfig) Type

func (pc PlatformConfig) Type() unikraft.ComponentType

func (PlatformConfig) Version

func (pc PlatformConfig) Version() string

type PlatformOption

type PlatformOption func(*PlatformConfig) error

PlatformOption is a function that modifies a PlatformConfig.

func WithInternal

func WithInternal(internal bool) PlatformOption

WithInternal sets the internal flag of the platform.

func WithKConfig

func WithKConfig(kconfig kconfig.KeyValueMap) PlatformOption

WithKConfig sets the kconfig of the platform.

func WithName

func WithName(name string) PlatformOption

WithName sets the name of the platform.

func WithPath

func WithPath(path string) PlatformOption

WithPath sets the path of the platform.

func WithSource

func WithSource(source string) PlatformOption

WithSource sets the source of the platform.

func WithVersion

func WithVersion(version string) PlatformOption

WithVersion sets the version of the platform.