Categorygithub.com/nxtcoder17/go-helm-client
modulepackage
0.0.0-20230915000026-8789cfa27bf3
Repository: https://github.com/nxtcoder17/go-helm-client.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
38
Dependents
2
Files
1.1k SLOC

# README

Go Helm Client

fork of mittwald/go-helm-client.

Why use this fork ?

  • fixes issue which caused helm charts to be applied to default namespace, even when a namespace has been specified in chart spec. read more at mittwald/go-helm-client#104 reference commit

Installation

Install this library using go get:

$ go get github.com/nxtcoder17/go-helm-client@release

from upstream README.md

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

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 make 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.
No description provided by the author

# Functions

Maximum burst for throttle the created RESTClient will use DefaultBurst: 100.
New returns a new Helm client with the provided options.
NewClientFromKubeConf returns a new Helm client constructed with the provided kubeconfig & RESTClient (optional) 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'.
Timeout specifies the timeout for a RESTClient as a RESTClientOption.

# Structs

ChartSpec defines the values of a helm chart +kubebuilder:object:generate:=true.
No description provided by the author
HelmClient Client defines the values of a helm client.
No description provided by the author
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.
No description provided by the author

# Type aliases

RESTClientOption is a function that can be used to set the RESTClientOptions of a HelmClient.