An open API service indexing awesome lists of open source software.

https://github.com/mittwald/go-helm-client

Go client for accessing the Helm package manager
https://github.com/mittwald/go-helm-client

golang golang-library hacktoberfest helm kubernetes

Last synced: about 1 year ago
JSON representation

Go client for accessing the Helm package manager

Awesome Lists containing this project

README

          

# Go Helm Client
Go client library for accessing [Helm](https://github.com/helm/helm), enabling the user to programmatically change helm charts and releases.

This library is build upon [`helm`](https://github.com/helm/helm) and available under the MIT License.

![Compile & Test](https://github.com/mittwald/go-helm-client/workflows/Compile%20&%20Test/badge.svg)
[![GitHub license](https://img.shields.io/github/license/mittwald/go-helm-client.svg)](https://github.com/mittwald/go-helm-client/blob/master/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/mittwald/go-helm-client)](https://goreportcard.com/report/github.com/mittwald/go-helm-client)
[![Documentation](https://godoc.org/github.com/mittwald/go-helm-client?status.svg)](https://pkg.go.dev/github.com/mittwald/go-helm-client)

## 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](https://pkg.go.dev/github.com/mittwald/go-helm-client?tab=doc#pkg-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](https://pkg.go.dev/github.com/mittwald/go-helm-client?tab=doc#example_HelmClient_AddOrUpdateChartRepo_private).

## Mock Client
This library includes a mock client [mock/interface_mock.go](mock/interface.go) which is generated by [mockgen](https://github.com/golang/mock).

Example usage of the mocked client can be found in [mock/mock_test.go](mock/mock_test.go).

If you made changes to [interface.go](./interface.go), you should issue the `make generate` command to trigger code generation.

## Documentation
For more specific documentation, please refer to the [godoc](https://pkg.go.dev/github.com/mittwald/go-helm-client/) of this library.