helm

Documentation

Overview

* © 2023 Snyk Limited * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Index

• func TemplateChart(path string, values map[string]interface{}) ([]runtime.Object, error)
• func UpdateIndexYAML(indexFile FileOverwriter, charts ...*UploadedChart) error
• type FileOverwriter
• type PackagedChart
  • func PackageChart(name string, version string, path string) (*PackagedChart, error)
  • func (ch *PackagedChart) Metadata() *helmchart.Metadata
  • func (ch *PackagedChart) OpenFile() (*os.File, error)
  • func (ch *PackagedChart) UploadedTo(urls ...string) *UploadedChart
• type UploadedChart

Functions

func TemplateChart

func TemplateChart(path string, values map[string]interface{}) ([]runtime.Object, error)

TemplateChart templates the helm chart at the given path with the given values and returns the decoded manifests. Note that CRDs cannot be decoded into their typed representation, and will instead be returned as `unstructured.Unstructured` resources.

func UpdateIndexYAML

func UpdateIndexYAML(indexFile FileOverwriter, charts ...*UploadedChart) error

UpdateIndexYAML updates the given index.yaml file to include the new uploadedCharts. The index.yaml file is the file that indicates which charts are available in a Chart Repo.

Types

type FileOverwriter

type FileOverwriter interface {
	// yes, we need all of these methods to read the file and then overwrite it.
	io.Reader
	io.Writer
	io.Seeker
	io.Closer
	Truncate(int64) error
}

FileOverwriter is a subset of os.File methods that allow us to overwrite the whole file.

type PackagedChart

type PackagedChart struct {
	Name    string
	Version string
	File    string
}

func PackageChart

func PackageChart(name string, version string, path string) (*PackagedChart, error)

PackageChart packages the chart at the given path with the given name and version.

func (*PackagedChart) Metadata

func (ch *PackagedChart) Metadata() *helmchart.Metadata

func (*PackagedChart) OpenFile

func (ch *PackagedChart) OpenFile() (*os.File, error)

func (*PackagedChart) UploadedTo

func (ch *PackagedChart) UploadedTo(urls ...string) *UploadedChart

type UploadedChart

type UploadedChart struct {
	*PackagedChart
	URLs []string
}