render

Documentation

Index

• Constants
• Variables
• type LocalRenderer
  • func (lr *LocalRenderer) Init() error
  • func (lr *LocalRenderer) RenderManifest(valsYaml string) (string, error)
• type RemoteRenderer
  • func (rr *RemoteRenderer) Init() error
  • func (rr *RemoteRenderer) RenderManifest(valsYaml string) (string, error)
• type Renderer
  • func NewLocalRenderer(opts ...RendererOption) (Renderer, error)
  • func NewRemoteRenderer(opts ...RendererOption) (Renderer, error)
• type RendererOption
  • func WithDir(dir string) RendererOption
  • func WithFS(f fs.FS) RendererOption
  • func WithName(name string) RendererOption
  • func WithNamespace(ns string) RendererOption
  • func WithRepoURL(repo string) RendererOption
  • func WithVersion(version string) RendererOption
• type RendererOptions

Constants

const (
	YAMLSeparator       = "\n---\n"
	NotesFileNameSuffix = ".txt"
)

Variables

var DefaultFilters = []util.FilterFunc{
	util.LicenseFilter,
	util.FormatterFilter,
	util.SpaceFilter,
}

Types

type LocalRenderer

type LocalRenderer struct {
	Opts    *RendererOptions
	Chart   *chart.Chart
	Started bool
}

LocalRenderer load chart from local file system

func (*LocalRenderer) Init

func (lr *LocalRenderer) Init() error

func (*LocalRenderer) RenderManifest

func (lr *LocalRenderer) RenderManifest(valsYaml string) (string, error)

type RemoteRenderer

type RemoteRenderer struct {
	Opts    *RendererOptions
	Chart   *chart.Chart
	Started bool
}

func (*RemoteRenderer) Init

func (rr *RemoteRenderer) Init() error

func (*RemoteRenderer) RenderManifest

func (rr *RemoteRenderer) RenderManifest(valsYaml string) (string, error)

type Renderer

type Renderer interface {
	Init() error
	RenderManifest(valsYaml string) (string, error)
}

Renderer is responsible for rendering helm chart with new values. For using RenderManifest, we must invoke Init firstly.

func NewLocalRenderer

func NewLocalRenderer(opts ...RendererOption) (Renderer, error)

func NewRemoteRenderer

func NewRemoteRenderer(opts ...RendererOption) (Renderer, error)

type RendererOption

type RendererOption func(*RendererOptions)

func WithDir

func WithDir(dir string) RendererOption

func WithFS

func WithFS(f fs.FS) RendererOption

func WithName

func WithName(name string) RendererOption

func WithNamespace

func WithNamespace(ns string) RendererOption

func WithRepoURL

func WithRepoURL(repo string) RendererOption

func WithVersion

func WithVersion(version string) RendererOption

type RendererOptions

type RendererOptions struct {
	Name      string
	Namespace string

	// fields for LocalRenderer
	// local file system containing the target chart
	FS fs.FS
	// chart relevant path to FS
	Dir string

	// fields for RemoteRenderer
	// remote chart version
	Version string
	// remote chart repo url
	RepoURL string
}