Categorygithub.com/jorgeperezc/go-helm-client
modulepackage
1.0.0
Repository: https://github.com/jorgeperezc/go-helm-client.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
33
Dependents
1
Files
965 SLOC

# README

Go Helm Client

Go client library for accessing Helm, enabling the user to programmatically change helm charts and releases.

This library is build upon helm and available under the MIT License.

Compile & Test GitHub license Go Report Card Documentation

Installation

Install this library using go get:

$ go get github.com/mittwald/go-helm-client

Usage

Example usage of the client can be found in the package examples.

Private chart repository

When working with private repositories, you can utilize the Username and Password parameters of a chart entry to specify credentials.

An example of this can be found in the corresponding example.

Mock Client

This library includes a mock client mock/interface_mock.go which is generated by mockgen.

Example usage of the mocked client can be found in mock/mock_test.go.

If you made changes to interface.go, you should issue the go generate ./... command to trigger code generation.

Documentation

For more specific documentation, please refer to the godoc of this library.

# Packages

Package mockhelmclient is a generated GoMock package.

# Functions

New returns a new Helm client with the provided options.
NewClientFromKubeConf returns a new Helm client constructed with the provided kubeconfig options.
NewClientFromRestConf returns a new Helm client constructed with the provided REST config options.
NewRESTClientGetter returns a RESTClientGetter using the provided 'namespace', 'kubeConfig' and 'restConfig'.

# Structs

ChartSpec defines the values of a helm chart.
HelmClient Client defines the values of a helm client.
KubeConfClientOptions defines the options used for constructing a client via kubeconfig.
Options defines the options of a client.
RESTClientGetter defines the values of a helm REST client.
RestConfClientOptions defines the options used for constructing a client via REST config.

# Interfaces

Client holds the method signatures for a Helm client.