helm

README

Access Method helm - Helm Repository Access

Synopsis

type: helm/v1

Provided blobs use the following media type: attribute application/vnd.cncf.helm.chart.content.v1.tar+gzip

Description

This method implements the access of a Helm chart stored in a Helm chart repository.

Supported specification version is v1

Specification Versions

Version v1

The type specific specification fields are:

• helmRepository string

  Helm repository URL.

• helmChart string

  The name of the Helm chart and its version separated by a colon.

• caCert string

  An optional TLS root certificate.

• keyring string

  An optional keyring used to verify the chart.

Go Bindings

The go binding can be found here

Documentation

Index

• Constants
• func AddConfig(opts flagsets.ConfigOptions, config flagsets.Config) error
• func ConfigHandler() flagsets.ConfigOptionTypeSetHandler
• type AccessSpec
  • func New(chart string, repourl string) *AccessSpec
  • func (a *AccessSpec) AccessMethod(access accspeccpi.ComponentVersionAccess) (accspeccpi.AccessMethod, error)
  • func (a *AccessSpec) Describe(ctx accspeccpi.Context) string
  • func (a *AccessSpec) GetChartName() string
  • func (a *AccessSpec) GetMimeType() string
  • func (a *AccessSpec) GetVersion() string
  • func (a *AccessSpec) GlobalAccessSpec(ctx accspeccpi.Context) accspeccpi.AccessSpec
  • func (a *AccessSpec) IsLocal(ctx accspeccpi.Context) bool

Constants

const (
	Type   = "helm"
	TypeV1 = Type + runtime.VersionSeparator + "v1"
)

Type is the access type for a blob in an OCI repository.

Functions

func AddConfig

func AddConfig(opts flagsets.ConfigOptions, config flagsets.Config) error

func ConfigHandler

func ConfigHandler() flagsets.ConfigOptionTypeSetHandler

Types

type AccessSpec

type AccessSpec struct {
	runtime.ObjectVersionedType `json:",inline"`

	// HelmRepository is the URL of the helm repository to load the chart from.
	HelmRepository string `json:"helmRepository"`

	// HelmChart if the name of the helm chart and its version separated by a colon.
	HelmChart string `json:"helmChart"`

	// Version can either be specified as part of the chart name or separately.
	Version string `json:"version,omitempty"`

	// CACert is an optional root TLS certificate
	CACert string `json:"caCert,omitempty"`

	// Keyring is an optional keyring to verify the chart.
	Keyring string `json:"keyring,omitempty"`
}

AccessSpec describes the access for a helm repository.

func New

func New(chart string, repourl string) *AccessSpec

New creates a new Helm Chart accessor for helm repositories.

func (*AccessSpec) AccessMethod

func (a *AccessSpec) AccessMethod(access accspeccpi.ComponentVersionAccess) (accspeccpi.AccessMethod, error)

func (*AccessSpec) Describe

func (a *AccessSpec) Describe(ctx accspeccpi.Context) string

func (*AccessSpec) GetChartName

func (a *AccessSpec) GetChartName() string

func (*AccessSpec) GetMimeType

func (a *AccessSpec) GetMimeType() string

func (*AccessSpec) GetVersion

func (a *AccessSpec) GetVersion() string

func (*AccessSpec) GlobalAccessSpec

func (a *AccessSpec) GlobalAccessSpec(ctx accspeccpi.Context) accspeccpi.AccessSpec

func (*AccessSpec) IsLocal

func (a *AccessSpec) IsLocal(ctx accspeccpi.Context) bool