chartrenderer

Documentation

Index

• func DiscoverCapabilities(disc discovery.DiscoveryInterface) (*chartutil.Capabilities, error)
• func SortByKind(manifests []manifest.Manifest) []manifest.Manifest
• 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]string
  • func (c *RenderedChart) Manifest() []byte
• type SortOrder

Functions

func DiscoverCapabilities

func DiscoverCapabilities(disc discovery.DiscoveryInterface) (*chartutil.Capabilities, error)

DiscoverCapabilities discovers the capabilities required for chart renderers using the given DiscoveryInterface.

func SortByKind

func SortByKind(manifests []manifest.Manifest) []manifest.Manifest

SortByKind sorts manifests in InstallOrder

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 {
	// Deprecated: Use RenderEmbeddedFS for new code!
	Render(chartPath, releaseName, namespace string, values interface{}) (*RenderedChart, error)
	RenderEmbeddedFS(embeddedFS embed.FS, chartPath, releaseName, namespace string, values interface{}) (*RenderedChart, error)
	RenderArchive(archive []byte, releaseName, namespace string, values interface{}) (*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 []manifest.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]string

Files returns all rendered manifests mapping their names to their content.

func (*RenderedChart) Manifest

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

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

type SortOrder

type SortOrder []string

SortOrder is an ordering of Kinds.

var InstallOrder SortOrder = []string{
	"Namespace",
	"ResourceQuota",
	"LimitRange",
	"PodSecurityPolicy",
	"PodDisruptionBudget",
	"Secret",
	"ConfigMap",
	"StorageClass",
	"PersistentVolume",
	"PersistentVolumeClaim",
	"ServiceAccount",
	"CustomResourceDefinition",
	"ClusterRole",
	"ClusterRoleBinding",
	"Role",
	"RoleBinding",
	"Service",
	"DaemonSet",
	"Pod",
	"ReplicationController",
	"ReplicaSet",
	"Deployment",
	"StatefulSet",
	"Job",
	"CronJob",
	"Ingress",
	"APIService",
}

InstallOrder is the order in which manifests should be installed (by Kind).

Those occurring earlier in the list get installed before those occurring later in the list.