helm

Documentation

Index

• type KubernetesResourceTemplate
• type ProfileYamlClient
  • func ProcessProfileYaml(fpath string, manifestFileName string) (ProfileYamlClient, error)
  • func (p ProfileYamlClient) CopyConfigurationOverrides(chartPath string) error
  • func (p ProfileYamlClient) GetValues() string
  • func (p ProfileYamlClient) Print()
• type Resolver
• type Template
• type TemplateClient
  • func NewTemplateClient(k8sversion, namespace, releasename, manifestFileName string) *TemplateClient
  • func (h *TemplateClient) GenerateKubernetesArtifacts(inputPath string, valueFiles []string, values []string) ([]KubernetesResourceTemplate, error)
  • func (h *TemplateClient) Resolve(appContent []byte, appProfileContent []byte, overrideValuesOfAppStr []string, ...) ([]KubernetesResourceTemplate, error)

Types

type KubernetesResourceTemplate

type KubernetesResourceTemplate struct {
	// Tracks the apiVersion and Kind of the resource
	GVK schema.GroupVersionKind
	// Path to the file that contains the resource info
	FilePath string
}

KubernetesResourceTemplate - Represents the template that is used to create a particular resource in Kubernetes

type ProfileYamlClient

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

func ProcessProfileYaml

func ProcessProfileYaml(fpath string, manifestFileName string) (ProfileYamlClient, error)

ProcessProfileYaml parses the manifest.yaml file that is part of the profile package and creates the appropriate structures out of it.

func (ProfileYamlClient) CopyConfigurationOverrides

func (p ProfileYamlClient) CopyConfigurationOverrides(chartPath string) error

CopyConfigurationOverrides copies the various files that are provided as overrides to their corresponding locations within the destination chart.

func (ProfileYamlClient) GetValues

func (p ProfileYamlClient) GetValues() string

GetValues returns a path to the override values.yam that was part of the profile

func (ProfileYamlClient) Print

func (p ProfileYamlClient) Print()

type Resolver

type Resolver interface {
	Resolve(appContent, appProfileContent []byte, overrideValuesOfAppStr []string, appName string) ([]KubernetesResourceTemplate, error)
}

Resolver is an interface exposes the helm related functionalities

type Template

type Template interface {
	GenerateKubernetesArtifacts(
		chartPath string,
		valueFiles []string,
		values []string) (map[string][]string, error)
}

Template is the interface for all helm templating commands Any backend implementation will implement this interface and will access the functionality via this.

type TemplateClient

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

TemplateClient implements the Template interface It will also be used to maintain any localized state

func NewTemplateClient

func NewTemplateClient(k8sversion, namespace, releasename, manifestFileName string) *TemplateClient

NewTemplateClient returns a new instance of TemplateClient

func (*TemplateClient) GenerateKubernetesArtifacts

func (h *TemplateClient) GenerateKubernetesArtifacts(inputPath string, valueFiles []string,
	values []string) ([]KubernetesResourceTemplate, error)

GenerateKubernetesArtifacts a mapping of type to fully evaluated helm template

func (*TemplateClient) Resolve

func (h *TemplateClient) Resolve(appContent []byte, appProfileContent []byte, overrideValuesOfAppStr []string, appName string) ([]KubernetesResourceTemplate, error)

Resolve function