repo

package
v2.0.1+incompatible Latest Latest
Warning

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

Go to latest
Published: Dec 1, 2016 License: Apache-2.0 Imports: 18 Imported by: 0

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.

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 ErrRepoOutOfDate = errors.New("repository file is out of date")

ErrRepoOutOfDate indicates that the repository file is out of date, but is fixable.

Functions

func AddChartToLocalRepo

func AddChartToLocalRepo(ch *chart.Chart, path string) error

AddChartToLocalRepo saves a chart in the given path and then reindexes the index file

func DownloadIndexFile

func DownloadIndexFile(repoName, url, indexFilePath string) error

DownloadIndexFile fetches the index from a repository.

func Reindex

func Reindex(ch *chart.Chart, path string) error

Reindex adds an entry to the index file at the given path

func StartLocalRepo

func StartLocalRepo(path, address string) error

StartLocalRepo starts a web server and serves files from the given path

Types

type ChartRepository

type ChartRepository struct {
	RootPath   string
	URL        string // URL of repository
	ChartPaths []string
	IndexFile  *IndexFile
}

ChartRepository represents a chart repository

func LoadChartRepository

func LoadChartRepository(dir, url string) (*ChartRepository, error)

LoadChartRepository loads a directory of charts as if it were a repository.

It requires the presence of an index.yaml file in the directory.

This function evaluates the contents of the directory and returns a ChartRepository

func (*ChartRepository) Index

func (r *ChartRepository) Index() error

Index generates an index for the chart repository and writes an index.yaml file.

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

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 Entry

type Entry struct {
	Name  string `json:"name"`
	Cache string `json:"cache"`
	URL   string `json:"url"`
}

Entry represents one repo entry in a repositories listing.

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 LoadIndex

func LoadIndex(data []byte) (*IndexFile, error)

LoadIndex loads an index file and does minimal validity checking.

This will fail if API Version is not set (ErrNoAPIVersion) or if the unmarshal fails.

func LoadIndexFile

func LoadIndexFile(path string) (*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 highest version.

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 RepoFile

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

RepoFile represents the repositories.yaml file in $HELM_HOME

func LoadRepositoriesFile

func LoadRepositoriesFile(path string) (*RepoFile, error)

LoadRepositoriesFile takes a file at the given path and returns a RepoFile object

If this returns ErrRepoOutOfDate, it also returns a recovered RepoFile that can be saved as a replacement to the out of date file.

func NewRepoFile

func NewRepoFile() *RepoFile

NewRepoFile generates an empty repositories file.

Generated and APIVersion are automatically set.

func (*RepoFile) Add

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

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

func (*RepoFile) Has

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

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

func (*RepoFile) Remove

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

Remove removes the entry from the list of repositories.

func (*RepoFile) Update

func (r *RepoFile) 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 (*RepoFile) WriteFile

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

WriteFile writes a repositories file to the given path.

type RepositoryServer

type RepositoryServer struct {
	RepoPath string
}

RepositoryServer is an HTTP handler for serving a chart repository.

func (*RepositoryServer) ServeHTTP

func (s *RepositoryServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements the http.Handler interface.

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