helm

Documentation

Index

• type Collector
  • func DefaultConfiguration(pf action.DebugLog) (c *Collector, err error)
  • func New(sdkConfig *action.Configuration) *Collector
  • func (c *Collector) Run(ctx context.Context, _ *config.Config) (keyName string, data []interface{}, err error)
  • func (c *Collector) Source() string

Types

type Collector

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

Collector is a struct implementing the DataCollector interface. It wraps a Helm SDK configuration object.

func DefaultConfiguration

func DefaultConfiguration(pf action.DebugLog) (c *Collector, err error)

DefaultConfiguration creates a Collector instance with default configuration to use Helm on a local Kubernetes cluster. A Printf-like function can be provided so the SDK uses an application-wide logger object. If nil, the `log.Printf` function from the standard library is used. The HELM_DRIVER environment variable is also taken into account, as described in the Helm docs: https://helm.sh/docs/topics/advanced/#storage-backends

func New

func New(sdkConfig *action.Configuration) *Collector

New creates a new instance of the Collector struct. A Helm SDK configuration object must be provided.

func (*Collector) Run

func (c *Collector) Run(ctx context.Context, _ *config.Config) (
	keyName string,
	data []interface{},
	err error,
)

Run executes the collector with the provided configuration object, and returns a list of collected Helm releases from the Kubernetes cluster.

func (*Collector) Source

func (c *Collector) Source() string

Source is required by the DataCollector interface to return a name for the collector's source, in this case the Helm SDK.