helm

Documentation

Index

• func NormalizeChartRepositoryURL(repo string) string
• func SelectChartVersion(ctx context.Context, repoURL string, chart string, semverConstraint string, ...) (string, error)
• func UpdateChartDependencies(homePath, chartPath string) error
• type Credentials

Functions

func NormalizeChartRepositoryURL

func NormalizeChartRepositoryURL(repo string) string

NormalizeChartRepositoryURL normalizes a chart repository URL for purposes of comparison. Crucially, this function removes the oci:// prefix from the URL if there is one.

func SelectChartVersion

func SelectChartVersion(
	ctx context.Context,
	repoURL string,
	chart string,
	semverConstraint string,
	creds *Credentials,
) (string, error)

SelectChartVersion connects to the Helm chart repository specified by repoURL and retrieves all available versions of the chart found therein. The repository can be either a classic chart repository (using HTTP/S) or a repository within an OCI registry. Classic chart repositories can contain differently named charts. When repoURL points to such a repository, the name argument must specify the name of the chart within the repository. In the case of a repository within an OCI registry, the URL implicitly points to a specific chart and the name argument must be empty. If no semverConstraint is provided (empty string is passed), then the version that is semantically greatest will be returned. If a semverConstraint is specified, then the semantically greatest version satisfying that constraint will be returned. If no version satisfies the constraint, the empty string is returned. Provided credentials may be nil for public repositories, but must be non-nil for private repositories.

func UpdateChartDependencies

func UpdateChartDependencies(homePath, chartPath string) error

Types

type Credentials

type Credentials struct {
	// Username identifies a principal, which combined with the value of the
	// Password field, can be used for reading from some remote repository.
	Username string
	// Password, when combined with the principal identified by the Username
	// field, can be used for both reading from some remote repository.
	Password string
}

Credentials represents the credentials for connecting to a private Helm chart repository.