https://github.com/bloodorangeio/octant-helm

Octant plugin for Helm
https://github.com/bloodorangeio/octant-helm

charts go golang helm kubernetes octant octant-plugin

Last synced: 6 months ago
JSON representation

Octant plugin for Helm

• Host: GitHub
• URL: https://github.com/bloodorangeio/octant-helm
• Owner: bloodorangeio
• License: apache-2.0
• Created: 2019-11-18T22:58:22.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2021-10-04T16:44:56.000Z (over 4 years ago)
• Last Synced: 2025-08-14T18:55:51.400Z (11 months ago)
• Topics: charts, go, golang, helm, kubernetes, octant, octant-plugin
• Language: Go
• Size: 1.12 MB
• Stars: 71
• Watchers: 3
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Octant Helm Plugin

[![GitHub Actions status](https://github.com/bloodorangeio/octant-helm/workflows/build/badge.svg)](https://github.com/bloodorangeio/octant-helm/actions)

This is an [Octant](https://octant.dev/) plugin for [Helm](http://helm.sh/) which provides visibility into Helm releases installed on your Kubernetes cluster.

*Note: Plugin supports only Helm 3.0.0 or higher.*

## Install

Octant should first be installed (Helm is not necessarily required).

Please see the [releases](https://github.com/bloodorangeio/octant-helm/releases) page and find the correct `tar.gz` for your platform, then run the following (replacing URL):

```

mkdir -p ~/.config/octant/plugins/ && \

  curl -L https://github.com/bloodorangeio/octant-helm/releases/download/v0.2.0/octant-helm_0.2.0_darwin_amd64.tar.gz | \

  tar xz -C ~/.config/octant/plugins/ octant-helm

```

Then, in an environment authenticated against your Kubernetes cluster containing Helm releases, run `octant`.

You may also place the plugin binary elsewhere and run octant using the `--plugin-path=` option.

## Screenshots

### List all releases

Equivalent of `helm list`.

![](./images/screenshot-1.png)

### Show release summary

Equivalent of `helm status`.

![](./images/screenshot-2.png)

## Uninstall

Run the following command to remove the plugin:

```

rm -f ~/.config/octant/plugins/octant-helm

```

## Development

Requires Go 1.17+ and [fswatch](https://github.com/emcrisostomo/fswatch).

Run `make dev` at the root of this repo, which will do the following:

- Build the binary

- Start the Octant server at http://127.0.0.1:7777

- Watch for file changes, rebuild binary, restart Octant, repeat

Contributions are welcome!