template

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.

Package template implements the interface through which templates can be edited and configured.

Index

• type Template
  • func NewTemplateFromOptions(opts ...TemplateOption) (Template, error)
• type TemplateConfig
  • func (tc TemplateConfig) KConfig() kconfig.KeyValueMap
  • func (tc TemplateConfig) KConfigTree(env ...*kconfig.KeyValue) (*kconfig.KConfigFile, error)
  • func (tc TemplateConfig) Name() string
  • func (tc TemplateConfig) Path() string
  • func (tc TemplateConfig) PrintInfo(ctx context.Context) string
  • func (tc TemplateConfig) Source() string
  • func (tc TemplateConfig) Type() unikraft.ComponentType
  • func (tc TemplateConfig) Version() string
• type TemplateOption
  • func WithName(name string) TemplateOption
  • func WithSource(source string) TemplateOption
  • func WithVersion(version string) TemplateOption

Types

type Template

type Template interface {
	component.Component
}

Template interfaces with the standard component in Unikraft

func NewTemplateFromOptions

func NewTemplateFromOptions(opts ...TemplateOption) (Template, error)

NewTemplateFromOptions creates a new template configuration

type TemplateConfig

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

TemplateConfig is the configuration of a template. It is identical to the component configuration

func (TemplateConfig) KConfig

func (tc TemplateConfig) KConfig() kconfig.KeyValueMap

func (TemplateConfig) KConfigTree

func (tc TemplateConfig) KConfigTree(env ...*kconfig.KeyValue) (*kconfig.KConfigFile, error)

KConfigTree returns the path to the kconfig file of the template

func (TemplateConfig) Name

func (tc TemplateConfig) Name() string

Name returns the name of the template

func (TemplateConfig) Path

func (tc TemplateConfig) Path() string

func (TemplateConfig) PrintInfo

func (tc TemplateConfig) PrintInfo(ctx context.Context) string

PrintInfo prints information about the template

func (TemplateConfig) Source

func (tc TemplateConfig) Source() string

Source returns the source of the template

func (TemplateConfig) Type

func (tc TemplateConfig) Type() unikraft.ComponentType

Type returns the type of the template

func (TemplateConfig) Version

func (tc TemplateConfig) Version() string

Version returns the version of the template

type TemplateOption

type TemplateOption func(*TemplateConfig) error

TemplateOption is a function that modifies a TemplateConfig.

func WithName

func WithName(name string) TemplateOption

WithName sets the name of the template.

func WithSource

func WithSource(source string) TemplateOption

WithSource sets the source of the template.

func WithVersion

func WithVersion(version string) TemplateOption

WithVersion sets the version of the template.