chartrenderer

Documentation

Index

• type Factory
  • func DefaultFactory() Factory
• type FactoryFunc
  • func (f FactoryFunc) NewForConfig(config *rest.Config) (Interface, error)
• type Interface
  • func NewForConfig(cfg *rest.Config) (Interface, error)
  • func NewWithServerVersion(serverVersion *version.Info) Interface
• type RenderedChart
  • func (c *RenderedChart) AsSecretData() map[string][]byte
  • func (c *RenderedChart) FileContent(filename string) string
  • func (c *RenderedChart) Files() map[string]map[string]string
  • func (c *RenderedChart) Manifest() []byte

Types

type Factory

type Factory interface {
	NewForConfig(config *rest.Config) (Interface, error)
}

Factory is a factory that is able to produce Interface.

func DefaultFactory

func DefaultFactory() Factory

DefaultFactory returns the default Factory.

type FactoryFunc

type FactoryFunc func(config *rest.Config) (Interface, error)

FactoryFunc implements the Factory interface.

func (FactoryFunc) NewForConfig

func (f FactoryFunc) NewForConfig(config *rest.Config) (Interface, error)

NewForConfig implements Factory.

type Interface

type Interface interface {
	RenderEmbeddedFS(embeddedFS embed.FS, chartPath, releaseName, namespace string, values any) (*RenderedChart, error)
	RenderArchive(archive []byte, releaseName, namespace string, values any) (*RenderedChart, error)
}

Interface is an interface for rendering Helm Charts from path, name, namespace and values.

func NewForConfig

func NewForConfig(cfg *rest.Config) (Interface, error)

NewForConfig creates a new ChartRenderer object. It requires a Kubernetes client as input which will be injected in the Tiller environment.

func NewWithServerVersion

func NewWithServerVersion(serverVersion *version.Info) Interface

NewWithServerVersion creates a new chart renderer with the given server version.

type RenderedChart

type RenderedChart struct {
	ChartName string
	Manifests []releaseutil.Manifest
}

RenderedChart holds a map of rendered templates file with template file name as key and rendered template as value.

func (*RenderedChart) AsSecretData

func (c *RenderedChart) AsSecretData() map[string][]byte

AsSecretData returns all rendered manifests that is capable for used as data of a secret

func (*RenderedChart) FileContent

func (c *RenderedChart) FileContent(filename string) string

FileContent returns explicitly the content of the provided <filename>.

func (*RenderedChart) Files

func (c *RenderedChart) Files() map[string]map[string]string

Files returns a map representing the files associated with the RenderedChart. The map has the file names as keys and their content represented as a nested map. The nested map has keys in the format of strings.ToLower(manifest.Head.Kind+"/"+manifest.Head.Metadata.Name) and values as the content of the corresponding file.

func (*RenderedChart) Manifest

func (c *RenderedChart) Manifest() []byte

Manifest returns the manifest of the rendered chart as byte array.