module

Documentation

Index

• Constants
• func ComposeValuesFromSchemas(m *Module, globalSchema *spec.Schema) (chartutil.Values, error)
• func GetModuleName(moduleYamlFile *ModuleYaml, chartYamlFile *ChartYaml) string
• func IsSymlink(fi os.FileInfo) bool
• func LoadModuleAsChart(moduleName, dir string) (*chart.Chart, error)
• func RenderModuleWithValues(modulePath string, userValues map[string]any) (map[string]string, error)
• func RunRender(m *Module, values chartutil.Values, ...) error
• func ToCamel(s string) string
• func ToLowerCamel(s string) string
• func Walk(root string, walkFn filepath.WalkFunc) error
• type ChartYaml
  • func ParseChartFile(path string) (*ChartYaml, error)
• type Module
  • func NewModule(path string, vals *chartutil.Values, globalSchema *spec.Schema, ...) (*Module, error)
  • func (m *Module) GetChart() *chart.Chart
  • func (m *Module) GetMetadata() *chart.Metadata
  • func (m *Module) GetModuleConfig() *pkg.LintersSettings
  • func (m *Module) GetName() string
  • func (m *Module) GetNamespace() string
  • func (m *Module) GetObjectStore() *storage.UnstructuredObjectStore
  • func (m *Module) GetPath() string
  • func (m *Module) GetStorage() map[storage.ResourceIndex]storage.StoreObject
  • func (m *Module) GetWerfFile() string
  • func (m *Module) String() string
• type ModuleList
• type ModuleYaml
  • func ParseModuleConfigFile(path string) (*ModuleYaml, error)
• type OpenAPIValuesGenerator
  • func NewOpenAPIValuesGenerator(schema *spec.Schema) *OpenAPIValuesGenerator
  • func (g *OpenAPIValuesGenerator) Do() (map[string]any, error)

Constants

const (
	ChartConfigFilename  = "Chart.yaml"
	ModuleConfigFilename = "module.yaml"
)

const (
	DmtDefault      = "x-dmt-default"
	ExamplesDefault = "x-examples"
	ExampleDefault  = "x-example"
	ArrayObject     = "array"
	ObjectKey       = "object"
)

Functions

func ComposeValuesFromSchemas

func ComposeValuesFromSchemas(m *Module, globalSchema *spec.Schema) (chartutil.Values, error)

func GetModuleName

func GetModuleName(moduleYamlFile *ModuleYaml, chartYamlFile *ChartYaml) string

func IsSymlink

func IsSymlink(fi os.FileInfo) bool

IsSymlink is used to determine if the fileinfo is a symbolic link.

func LoadModuleAsChart

func LoadModuleAsChart(moduleName, dir string) (*chart.Chart, error)

LoadModuleAsChart loads a module as a chart default helm loader couldn't be used without Chart.yaml, but deckhouse module could exist without this file, deckhouse will create it automatically

func RenderModuleWithValues

func RenderModuleWithValues(modulePath string, userValues map[string]any) (map[string]string, error)

RenderModuleWithValues renders the module at modulePath with the supplied user values (the ".Values" tree, e.g. holding "global" and the module's own section) and returns the rendered manifests keyed by chart-relative source file path.

Unlike the linter render path, value generation is deterministic: only the provided values plus dmt's fixed image/registry stubs are used, so the output is suitable for golden-snapshot template testing. Rendering is strict (LintMode is off), so `required` and `fail` calls fail the render.

func RunRender

func RunRender(m *Module, values chartutil.Values, objectStore *storage.UnstructuredObjectStore, errorList *dmtErrors.LintRuleErrorsList) error

func ToCamel

func ToCamel(s string) string

ToCamel converts a string to CamelCase

func ToLowerCamel

func ToLowerCamel(s string) string

ToLowerCamel converts a string to lowerCamelCase

func Walk

func Walk(root string, walkFn filepath.WalkFunc) error

Walk walks the file tree rooted at root, calling walkFn for each file or directory in the tree, including root. All errors that arise visiting files and directories are filtered by walkFn. The files are walked in lexical order, which makes the output deterministic but means that for very large directories Walk can be inefficient. Walk follows symbolic links.

Types

type ChartYaml

type ChartYaml struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

func ParseChartFile

func ParseChartFile(path string) (*ChartYaml, error)

type Module

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

func NewModule

func NewModule(path string, vals *chartutil.Values, globalSchema *spec.Schema, rootConfig *config.RootConfig, errorList *dmtErrors.LintRuleErrorsList) (*Module, error)

func (*Module) GetChart

func (m *Module) GetChart() *chart.Chart

func (*Module) GetMetadata

func (m *Module) GetMetadata() *chart.Metadata

func (*Module) GetModuleConfig

func (m *Module) GetModuleConfig() *pkg.LintersSettings

func (*Module) GetName

func (m *Module) GetName() string

func (*Module) GetNamespace

func (m *Module) GetNamespace() string

func (*Module) GetObjectStore

func (m *Module) GetObjectStore() *storage.UnstructuredObjectStore

func (*Module) GetPath

func (m *Module) GetPath() string

func (*Module) GetStorage

func (m *Module) GetStorage() map[storage.ResourceIndex]storage.StoreObject

func (*Module) GetWerfFile

func (m *Module) GetWerfFile() string

func (*Module) String

func (m *Module) String() string

type ModuleList

type ModuleList []*Module

type ModuleYaml

type ModuleYaml struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace"`
}

func ParseModuleConfigFile

func ParseModuleConfigFile(path string) (*ModuleYaml, error)

type OpenAPIValuesGenerator

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

func NewOpenAPIValuesGenerator

func NewOpenAPIValuesGenerator(schema *spec.Schema) *OpenAPIValuesGenerator

func (*OpenAPIValuesGenerator) Do

func (g *OpenAPIValuesGenerator) Do() (map[string]any, error)