repo

package
v0.29.13 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 16, 2024 License: Apache-2.0 Imports: 44 Imported by: 15

Documentation

Overview

Package repo implements the Helm Chart Repository.

A chart repository is an HTTP server that provides information on charts. A local repository cache is an on-disk representation of a chart repository.

There are two important file formats for chart repositories.

The first is the 'index.yaml' format, which is expressed like this: 

apiVersion: v1
entries:
  frobnitz:
  - created: 2016-09-29T12:14:34.830161306-06:00
	description: This is a frobniz.
	digest: 587bd19a9bd9d2bc4a6d25ab91c8c8e7042c47b4ac246e37bf8e1e74386190f4
	home: http://example.com
	keywords:
	- frobnitz
	- sprocket
	- dodad
	maintainers:
	- email: helm@example.com
	  name: The Helm Team
	- email: nobody@example.com
	  name: Someone Else
	name: frobnitz
	urls:
	- http://example-charts.com/testdata/repository/frobnitz-1.2.3.tgz
	version: 1.2.3
  sprocket:
  - created: 2016-09-29T12:14:34.830507606-06:00
	description: This is a sprocket"
	digest: 8505ff813c39502cc849a38e1e4a8ac24b8e6e1dcea88f4c34ad9b7439685ae6
	home: http://example.com
	keywords:
	- frobnitz
	- sprocket
	- dodad
	maintainers:
	- email: helm@example.com
	  name: The Helm Team
	- email: nobody@example.com
	  name: Someone Else
	name: sprocket
	urls:
	- http://example-charts.com/testdata/repository/sprocket-1.2.0.tgz
	version: 1.2.0
generated: 2016-09-29T12:14:34.829721375-06:00

An index.yaml file contains the necessary descriptive information about what charts are available in a repository, and how to get them.

The second file format is the repositories.yaml file format. This file is for facilitating local cached copies of one or more chart repositories.

The format of a repository.yaml file is: 

apiVersion: v1
generated: TIMESTAMP
repositories:
  - name: stable
    url: http://example.com/charts
	cache: stable-index.yaml
  - name: incubator
    url: http://example.com/incubator
	cache: incubator-index.yaml

This file maps three bits of information about a repository:

  • The name the user uses to refer to it
  • The fully qualified URL to the repository (index.yaml will be appended)
  • The name of the local cachefile

The format for both files was changed after Helm v2.0.0-Alpha.4. Helm is not backwards compatible with those earlier versions.

nolint:unused

Index

Constants

View Source 
const APIVersionV1 = "v1"

APIVersionV1 is the v1 API version for index and repository files.

Variables

View Source 
var (
	// ErrNoAPIVersion indicates that an API version was not specified.
	ErrNoAPIVersion = errors.New("no API version specified")
	// ErrNoChartVersion indicates that a chart with the given version is not found.
	ErrNoChartVersion = errors.New("no chart version found")
	// ErrNoChartName indicates that a chart with the given name is not found.
	ErrNoChartName = errors.New("no chart name found")
)
View Source 
var DefaultNamer = NewCachedRepoNamer()

Functions

func AddBypassChartRegistriesFlag added in v0.5.9 

func AddBypassChartRegistriesFlag(fs *pflag.FlagSet)

AddBypassChartRegistriesFlag is for explicitly initializing the --bypass-chart-registries flag

func DefaultDiskCache added in v0.5.4 

func DefaultDiskCache() httpcache.Cache

func ResolveReferenceURL 

func ResolveReferenceURL(baseURL, refURL string) (string, error)

ResolveReferenceURL resolves refURL relative to baseURL. If refURL is absolute, it simply returns refURL.

Types

type ChartExtended 

type ChartExtended struct {
	*chart.Chart
	URLs    []string  `json:"urls"`
	Created time.Time `json:"created,omitempty"`
	Removed bool      `json:"removed,omitempty"`
	Digest  string    `json:"digest,omitempty"`
}

ChartExtended represents a chart with metadata from its entry in the IndexFile

type ChartRepository 

type ChartRepository struct {
	Config     *Entry
	ChartPaths []string
	IndexFile  *IndexFile
	Client     getter.Getter
}

ChartRepository represents a chart repository

func NewChartRepository 

func NewChartRepository(cfg *Entry, getters getter.Providers) (*ChartRepository, error)

NewChartRepository constructs ChartRepository

func (*ChartRepository) DownloadIndexFile 

func (r *ChartRepository) DownloadIndexFile() (*bytes.Reader, error)

DownloadIndexFile fetches the index from a repository.

func (*ChartRepository) ListCharts 

func (r *ChartRepository) ListCharts() []string

func (*ChartRepository) ListVersions 

func (r *ChartRepository) ListVersions(name string) []VersionView

func (*ChartRepository) Load 

func (r *ChartRepository) Load() error

Load loads the index for the chart repository

type ChartVersion 

type ChartVersion struct {
	*chart.Metadata
	URLs    []string  `json:"urls"`
	Created time.Time `json:"created,omitempty"`
	Removed bool      `json:"removed,omitempty"`
	Digest  string    `json:"digest,omitempty"`
}

ChartVersion represents a chart entry in the IndexFile

func FindChartInAuthRepoURL 

func FindChartInAuthRepoURL(rc *Entry, chartName, chartVersion string, getters getter.Providers) (*ChartVersion, error)

FindChartInAuthRepoURL finds chart in chart repository pointed by repoURL without adding repo to repositories, like FindChartInRepoURL, but it also receives credentials for the chart repository.

type ChartVersions 

type ChartVersions []*ChartVersion

ChartVersions is a list of versioned chart references. Implements a sorter on Version.

func (ChartVersions) Len 

func (c ChartVersions) Len() int

Len returns the length.

func (ChartVersions) Less 

func (c ChartVersions) Less(a, b int) bool

Less returns true if the version of entry a is less than the version of entry b.

func (ChartVersions) Swap 

func (c ChartVersions) Swap(i, j int)

Swap swaps the position of two items in the versions slice.

type EmbeddedRegistry 

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

func (EmbeddedRegistry) GetChart 

func (r EmbeddedRegistry) GetChart(srcRef releasesapi.ChartSourceRef) (*ChartExtended, error)

func (EmbeddedRegistry) GetHelmRepository added in v0.7.1 

func (r EmbeddedRegistry) GetHelmRepository(obj releasesapi.ChartSourceRef) (*fluxsrc.HelmRepository, error)

type Entry 

type Entry struct {
	// Deprecated
	Name string `json:"name"`

	URL      string `json:"url"`
	Username string `json:"username"`
	Password string `json:"password"`
	CertFile string `json:"certFile"`
	KeyFile  string `json:"keyFile"`
	CAFile   string `json:"caFile"`

	Cache httpcache.Cache `json:"-"`
}

Entry represents a collection of parameters for chart repository

type File 

type File struct {
	APIVersion   string    `json:"apiVersion"`
	Generated    time.Time `json:"generated"`
	Repositories []*Entry  `json:"repositories"`
}

File represents the repositories.yaml file

func LoadFile 

func LoadFile(path string) (*File, error)

LoadFile takes a file at the given path and returns a File object

func NewFile 

func NewFile() *File

NewFile generates an empty repositories file.

Generated and APIVersion are automatically set.

func (*File) Add 

func (r *File) Add(re ...*Entry)

Add adds one or more repo entries to a repo file.

func (*File) Get 

func (r *File) Get(name string) *Entry

Get returns an entry with the given name if it exists, otherwise returns nil

func (*File) Has 

func (r *File) Has(name string) bool

Has returns true if the given name is already a repository name.

func (*File) Remove 

func (r *File) Remove(name string) bool

Remove removes the entry from the list of repositories.

func (*File) Update 

func (r *File) Update(re ...*Entry)

Update attempts to replace one or more repo entries in a repo file. If an entry with the same name doesn't exist in the repo file it will add it.

func (*File) WriteFile 

func (r *File) WriteFile(path string, perm os.FileMode) error

WriteFile writes a repositories file to the given path.

type Hub 

type Hub struct {
	Repositories []Repository `json:"repositories"`
}

type IRegistry 

type IRegistry interface {
	GetChart(srcRef releasesapi.ChartSourceRef) (*ChartExtended, error)
	GetHelmRepository(srcRef releasesapi.ChartSourceRef) (*fluxsrc.HelmRepository, error)
}

func NewEmbeddedRegistry 

func NewEmbeddedRegistry(fsys fs.FS) IRegistry

type IndexFile 

type IndexFile struct {
	APIVersion string                   `json:"apiVersion"`
	Generated  time.Time                `json:"generated"`
	Entries    map[string]ChartVersions `json:"entries"`
	PublicKeys []string                 `json:"publicKeys,omitempty"`
}

IndexFile represents the index file in a chart repository

func IndexDirectory 

func IndexDirectory(dir, baseURL string) (*IndexFile, error)

IndexDirectory reads a (flat) directory and generates an index.

It indexes only charts that have been packaged (*.tgz).

The index returned will be in an unsorted state

func LoadIndexFile 

func LoadIndexFile(reader *bytes.Reader) (*IndexFile, error)

LoadIndexFile takes a file at the given path and returns an IndexFile object

func NewIndexFile 

func NewIndexFile() *IndexFile

NewIndexFile initializes an index.

func (IndexFile) Add 

func (i IndexFile) Add(md *chart.Metadata, filename, baseURL, digest string)

Add adds a file to the index This can leave the index in an unsorted state

func (IndexFile) Get 

func (i IndexFile) Get(name, version string) (*ChartVersion, error)

Get returns the ChartVersion for the given name.

If version is empty, this will return the chart with the latest stable version, prerelease versions will be skipped.

func (IndexFile) Has 

func (i IndexFile) Has(name, version string) bool

Has returns true if the index has an entry for a chart with the given name and exact version.

func (*IndexFile) Merge 

func (i *IndexFile) Merge(f *IndexFile)

Merge merges the given index file into this index.

This merges by name and version.

If one of the entries in the given index does _not_ already exist, it is added. In all other cases, the existing record is preserved.

This can leave the index in an unsorted state

func (IndexFile) SortEntries 

func (i IndexFile) SortEntries()

SortEntries sorts the entries by version in descending order.

In canonical form, the individual version records should be sorted so that the most recent release for every version is in the 0th slot in the Entries.ChartVersions array. That way, tooling can predict the newest version without needing to parse SemVers.

func (IndexFile) WriteFile 

func (i IndexFile) WriteFile(dest string, mode os.FileMode) error

WriteFile writes an index file to the given destination path.

The mode on the file is set to 'mode'.

type Registry 

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

func NewDiskCacheRegistry 

func NewDiskCacheRegistry() *Registry

func NewMemoryCacheRegistry 

func NewMemoryCacheRegistry() *Registry

func NewRegistry 

func NewRegistry(kc client.Reader, cache httpcache.Cache) *Registry

func (*Registry) Get 

func (r *Registry) Get(url string) (*Entry, bool, error)

func (*Registry) GetChart 

func (r *Registry) GetChart(obj releasesapi.ChartSourceRef) (*ChartExtended, error)

func (*Registry) GetHelmRepository added in v0.7.1 

func (r *Registry) GetHelmRepository(obj releasesapi.ChartSourceRef) (*fluxsrc.HelmRepository, error)

type RepoNamer 

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

func NewCachedRepoNamer 

func NewCachedRepoNamer() *RepoNamer

func (*RepoNamer) ListHelmHubRepositories 

func (r *RepoNamer) ListHelmHubRepositories() ([]Repository, error)

func (*RepoNamer) Name 

func (r *RepoNamer) Name(chartURL string) (string, error)

type Repository 

type Repository struct {
	Name string `json:"name"`
	URL  string `json:"url"`
}

type VersionView 

type VersionView struct {
	// A SemVer 2 conformant version string of the chart
	Version string `json:"version,omitempty"`
	// The version of the application enclosed inside of this chart.
	AppVersion string `json:"appVersion,omitempty"`
	// Whether or not this chart is deprecated
	Deprecated bool `json:"deprecated,omitempty"`
	// KubeVersion is a SemVer constraint specifying the version of Kubernetes required.
	KubeVersion string    `json:"kubeVersion,omitempty"`
	Created     time.Time `json:"created,omitempty"`
	Removed     bool      `json:"removed,omitempty"`
}

VersionView represents a chart version entry in the IndexFile

Source Files

View all Source files

Directories

Path Synopsis
Package repotest provides utilities for testing.
 Package repotest provides utilities for testing.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.