chart

Documentation

Index

• func InjectImages(values map[string]any, v imagevector.ImageVector, names []string, ...) (map[string]any, error)
• type Chart
  • func (c *Chart) Apply(ctx context.Context, chartApplier kubernetesclient.ChartApplier, ...) error
  • func (c *Chart) Delete(ctx context.Context, client client.Client, namespace string) error
  • func (c *Chart) Render(chartRenderer chartrenderer.Interface, namespace string, ...) (string, []byte, error)
• type Interface
• type Object
  • func (o *Object) Delete(ctx context.Context, c client.Client, namespace string) error

Functions

func InjectImages

func InjectImages(values map[string]any, v imagevector.ImageVector, names []string, opts ...imagevector.FindOptionFunc) (map[string]any, error)

InjectImages finds the images with the given names and opts, makes a shallow copy of the given Values and injects a name to image string mapping at the `images` key of that map and returns it.

Types

type Chart

type Chart struct {
	Name       string
	Path       string
	EmbeddedFS embed.FS
	Images     []string
	Objects    []*Object
	SubCharts  []*Chart
}

Chart represents a Helm chart (and its sub-charts) that can be applied and deleted.

func (*Chart) Apply

func (c *Chart) Apply(
	ctx context.Context,
	chartApplier kubernetesclient.ChartApplier,
	namespace string,
	imageVector imagevector.ImageVector,
	runtimeVersion, targetVersion string,
	additionalValues map[string]any,
) error

Apply applies this chart in the given namespace using the given ChartApplier. Before applying the chart, it collects its values, injecting images and merging the given values as needed.

func (*Chart) Delete

func (c *Chart) Delete(ctx context.Context, client client.Client, namespace string) error

Delete deletes this chart's objects from the given namespace using the given client.

func (*Chart) Render

func (c *Chart) Render(
	chartRenderer chartrenderer.Interface,
	namespace string,
	imageVector imagevector.ImageVector,
	runtimeVersion, targetVersion string,
	additionalValues map[string]any,
) (
	string,
	[]byte,
	error,
)

Render renders this chart in the given namespace using the given chartRenderer. Before rendering the chart, it collects its values, injecting images and merging the given values as needed.

type Interface

type Interface interface {
	// Apply applies this chart in the given namespace using the given ChartApplier. Before applying the chart,
	// it collects its values, injecting images and merging the given values as needed.
	Apply(context.Context, kubernetesclient.ChartApplier, string, imagevector.ImageVector, string, string, map[string]any) error
	// Render renders this chart in the given namespace using the given chartRenderer. Before rendering the chart,
	// it collects its values, injecting images and merging the given values as needed.
	Render(chartrenderer.Interface, string, imagevector.ImageVector, string, string, map[string]any) (string, []byte, error)
	// Delete deletes this chart's objects from the given namespace.
	Delete(context.Context, client.Client, string) error
}

Interface represents a Helm chart that can be applied and deleted.

type Object

type Object struct {
	Type client.Object
	Name string
}

Object represents an object deployed by a Chart.

func (*Object) Delete

func (o *Object) Delete(ctx context.Context, c client.Client, namespace string) error

Delete deletes this object from the given namespace using the given client.