helmutil

Documentation

Index

• func Digest(in io.Reader) (string, error)
• func DigestFile(filename string) (string, error)
• func IsHelm3() bool
• func SetupHelm()
• type Chart
  • func LoadArchive(r io.Reader) (Chart, error)
  • func LoadChart(fpath string) (Chart, error)
• type ChartMetadata
  • func NewChartMetadata() ChartMetadata
• type ChartV2
  • func (c ChartV2) Metadata() ChartMetadata
  • func (c ChartV2) Name() string
  • func (c ChartV2) Version() string
• type ChartV3
  • func (c ChartV3) Metadata() ChartMetadata
  • func (c ChartV3) Name() string
  • func (c ChartV3) Version() string
• type Index
  • func LoadIndex(fpath string) (Index, error)
  • func NewIndex() Index
• type IndexV2
  • func (idx *IndexV2) Add(metadata interface{}, filename, baseURL, digest string) error
  • func (idx *IndexV2) AddOrReplace(metadata interface{}, filename, baseURL, digest string) error
  • func (idx *IndexV2) Delete(name, version string) (url string, err error)
  • func (idx *IndexV2) Has(name, version string) bool
  • func (idx *IndexV2) MarshalBinary() (data []byte, err error)
  • func (idx *IndexV2) Reader() (io.Reader, error)
  • func (idx *IndexV2) SortEntries()
  • func (idx *IndexV2) UnmarshalBinary(data []byte) error
  • func (idx *IndexV2) WriteFile(dest string, mode os.FileMode) error
• type IndexV3
  • func (idx *IndexV3) Add(metadata interface{}, filename, baseURL, digest string) error
  • func (idx *IndexV3) AddOrReplace(metadata interface{}, filename, baseURL, digest string) error
  • func (idx *IndexV3) Delete(name, version string) (url string, err error)
  • func (idx *IndexV3) Has(name, version string) bool
  • func (idx *IndexV3) MarshalBinary() (data []byte, err error)
  • func (idx *IndexV3) Reader() (io.Reader, error)
  • func (idx *IndexV3) SortEntries()
  • func (idx *IndexV3) UnmarshalBinary(data []byte) error
  • func (idx *IndexV3) WriteFile(dest string, mode os.FileMode) error
• type RepoEntry
  • func LookupRepoEntry(name string) (RepoEntry, error)
• type RepoEntryV2
  • func (r RepoEntryV2) CacheFile() string
  • func (r RepoEntryV2) IndexURL() string
  • func (r RepoEntryV2) URL() string
• type RepoEntryV3
  • func (r RepoEntryV3) CacheFile() string
  • func (r RepoEntryV3) IndexURL() string
  • func (r RepoEntryV3) URL() string

Functions

func Digest

func Digest(in io.Reader) (string, error)

Digest hashes a reader and returns a SHA256 digest.

func DigestFile

func DigestFile(filename string) (string, error)

DigestFile calculates a SHA256 hash for a given file.

func IsHelm3

func IsHelm3() bool

IsHelm3 returns true if helm is version 3+.

func SetupHelm

func SetupHelm()

Types

type Chart

type Chart interface {
	// Name returns chart name.
	// Example: "foo".
	Name() string

	// Version returns chart version.
	// Example: "0.1.0".
	Version() string

	// Metadata returns chart metadata.
	Metadata() ChartMetadata
}

Chart describes a helm chart.

func LoadArchive

func LoadArchive(r io.Reader) (Chart, error)

LoadArchive returns chart loaded from the archive file reader.

func LoadChart

func LoadChart(fpath string) (Chart, error)

LoadChart returns chart loaded from the file system by path.

type ChartMetadata

type ChartMetadata interface {
	// MarshalJSON marshals chart metadata to JSON.
	MarshalJSON() ([]byte, error)

	// UnmarshalJSON unmarshals chart metadata from JSON.
	UnmarshalJSON([]byte) error

	// Value returns underlying chart metadata value.
	Value() interface{}
}

ChartMetadata describes helm chart metadata.

func NewChartMetadata

func NewChartMetadata() ChartMetadata

NewChartMetadata returns a new helm chart metadata.

type ChartV2

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

ChartV2 implements Chart in Helm v2.

func (ChartV2) Metadata

func (c ChartV2) Metadata() ChartMetadata

func (ChartV2) Name

func (c ChartV2) Name() string

func (ChartV2) Version

func (c ChartV2) Version() string

type ChartV3

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

ChartV3 implements Chart in Helm v3.

func (ChartV3) Metadata

func (c ChartV3) Metadata() ChartMetadata

func (ChartV3) Name

func (c ChartV3) Name() string

func (ChartV3) Version

func (c ChartV3) Version() string

type Index

type Index interface {
	// Add adds chart version to the index.
	//
	// Note: this can leave the index in an unsorted state.
	Add(metadata interface{}, filename, baseURL, digest string) error

	// AddOrReplace adds chart version to the index, replacing the version if it exists instead
	// of adding it to the list of versions. Note that helm Add method does not control whether
	// the chart version exists, allowing for duplicates. This methods prevents duplicates
	// by replacing the chart.
	//
	// Note: this can leave the index in an unsorted state.
	AddOrReplace(metadata interface{}, filename, baseURL, digest string) error

	// Delete removes chart version from the index and returns url to the deleted item.
	Delete(name, version string) (url string, err error)

	// Has returns true if the index has an entry for a chart with the given name and exact version.
	Has(name, version string) bool

	// SortEntries sorts the entries by version in descending order.
	SortEntries()

	// MarshalBinary encodes index to a binary form.
	MarshalBinary() (data []byte, err error)

	// UnmarshalBinary decodes index from a binary form.
	UnmarshalBinary(b []byte) error

	// Reader returns io.Reader for index.
	Reader() (io.Reader, error)

	// WriteFile writes an index file to the given destination path.
	WriteFile(dest string, mode os.FileMode) error
}

Index describes helm chart repo index.

func LoadIndex

func LoadIndex(fpath string) (Index, error)

LoadIndex loads index from the file.

func NewIndex

func NewIndex() Index

NewIndex returns a new Index based either on Helm v2 or Helm v3.

type IndexV2

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

func (*IndexV2) Add

func (idx *IndexV2) Add(metadata interface{}, filename, baseURL, digest string) error

func (*IndexV2) AddOrReplace

func (idx *IndexV2) AddOrReplace(metadata interface{}, filename, baseURL, digest string) error

func (*IndexV2) Delete

func (idx *IndexV2) Delete(name, version string) (url string, err error)

func (*IndexV2) Has

func (idx *IndexV2) Has(name, version string) bool

func (*IndexV2) MarshalBinary

func (idx *IndexV2) MarshalBinary() (data []byte, err error)

func (*IndexV2) Reader

func (idx *IndexV2) Reader() (io.Reader, error)

func (*IndexV2) SortEntries

func (idx *IndexV2) SortEntries()

func (*IndexV2) UnmarshalBinary

func (idx *IndexV2) UnmarshalBinary(data []byte) error

func (*IndexV2) WriteFile

func (idx *IndexV2) WriteFile(dest string, mode os.FileMode) error

type IndexV3

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

func (*IndexV3) Add

func (idx *IndexV3) Add(metadata interface{}, filename, baseURL, digest string) error

func (*IndexV3) AddOrReplace

func (idx *IndexV3) AddOrReplace(metadata interface{}, filename, baseURL, digest string) error

func (*IndexV3) Delete

func (idx *IndexV3) Delete(name, version string) (url string, err error)

func (*IndexV3) Has

func (idx *IndexV3) Has(name, version string) bool

func (*IndexV3) MarshalBinary

func (idx *IndexV3) MarshalBinary() (data []byte, err error)

func (*IndexV3) Reader

func (idx *IndexV3) Reader() (io.Reader, error)

func (*IndexV3) SortEntries

func (idx *IndexV3) SortEntries()

func (*IndexV3) UnmarshalBinary

func (idx *IndexV3) UnmarshalBinary(data []byte) error

func (*IndexV3) WriteFile

func (idx *IndexV3) WriteFile(dest string, mode os.FileMode) error

type RepoEntry

type RepoEntry interface {
	// URL returns repo URL.
	// Examples:
	// - https://kubernetes-charts.storage.googleapis.com/
	// - s3://my-charts.
	URL() string

	// IndexURI returns repo index file URL.
	// Examples:
	// - https://kubernetes-charts.storage.googleapis.com/index.yaml
	// - s3://my-charts/index.yaml.
	IndexURL() string

	// CacheFile returns repo local cache file path.
	// Examples:
	// - /Users/foo/Library/Caches/helm/repository/my-charts-index.yaml (on macOS)
	// - /home/foo/.cache/helm/repository/my-charts-index.yaml (on Linux).
	CacheFile() string
}

func LookupRepoEntry

func LookupRepoEntry(name string) (RepoEntry, error)

LookupRepoEntry returns an entry from helm's repositories.yaml file by name.

type RepoEntryV2

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

RepoEntryV2 implements RepoEntry in Helm v2.

func (RepoEntryV2) CacheFile

func (r RepoEntryV2) CacheFile() string

func (RepoEntryV2) IndexURL

func (r RepoEntryV2) IndexURL() string

func (RepoEntryV2) URL

func (r RepoEntryV2) URL() string

type RepoEntryV3

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

RepoEntryV2 implements RepoEntry in Helm v3.

func (RepoEntryV3) CacheFile

func (r RepoEntryV3) CacheFile() string

func (RepoEntryV3) IndexURL

func (r RepoEntryV3) IndexURL() string

func (RepoEntryV3) URL

func (r RepoEntryV3) URL() string