mirror of
https://github.com/komodorio/helm-dashboard.git
synced 2026-03-24 11:48:04 +00:00
6b8d959491
* Don't offer rollback for the first revision * Fix the rollback bug * Cosmetics * Errors shown as alerts
87 lines
2.2 KiB
Markdown
87 lines
2.2 KiB
Markdown
# <img src="pkg/dashboard/static/logo.png" height=30 style="height: 2rem"> Helm Dashboard
|
|
|
|
A simplified way of working with Helm.
|
|
|
|
[<img src="screenshot.png" style="width: 100%; border: 1px solid silver">](screenshot.png)
|
|
|
|
## Local Testing
|
|
|
|
Prerequisites: `helm` and `kubectl` binaries installed and operational.
|
|
|
|
Until we make our repo public, we have to use a custom way to install the plugin.
|
|
|
|
There is a need to build binary for plugin to function, run:
|
|
|
|
```shell
|
|
go build -o bin/dashboard .
|
|
```
|
|
|
|
To install, checkout the source code and run from source dir:
|
|
|
|
```shell
|
|
helm plugin install .
|
|
```
|
|
|
|
Local install of plugin just creates a symlink, so making the changes and rebuilding the binary would not require to
|
|
reinstall a plugin.
|
|
|
|
To use the plugin, run in your terminal:
|
|
|
|
```shell
|
|
helm dashboard
|
|
```
|
|
|
|
Then, use the web UI.
|
|
|
|
## Uninstalling
|
|
|
|
To uninstall, run:
|
|
|
|
```shell
|
|
helm plugin uninstall dashboard
|
|
```
|
|
|
|
## Support Channels
|
|
|
|
We have two main channels for supporting the Helm Dashboard users: [Slack community](#TODO) for general conversations
|
|
and [GitHub issues](https://github.com/komodorio/helm-dashboard/issues) for real bugs.
|
|
|
|
## Roadmap
|
|
|
|
### First Public Version
|
|
|
|
- Helm Plugin Packaging
|
|
- CLI launcher
|
|
- Web Server with REST API
|
|
- Listing the installed applications
|
|
- View k8s resources created by the application (describe, status)
|
|
- Viewing revision history for application
|
|
- View manifest diffs between revisions, also changelogs etc
|
|
- Analytics reporting (telemetry)
|
|
- Rollback to a revision
|
|
- Check for repo updates & upgrade flow
|
|
- Uninstalling the app completely
|
|
- Switch clusters
|
|
- Show manifest/describe upon clicking on resource
|
|
|
|
### Further Ideas
|
|
- Have cleaner idea on the web API structure
|
|
- Recognise & show ArgoCD-originating charts/objects, those `helm ls` does not show
|
|
- Recognise the revisions that are rollbacks by their description and mark in timeline
|
|
|
|
#### Topic "Validating Manifests"
|
|
|
|
- Validate manifests before deploy and get better errors
|
|
- See if we can build in Chechov or Validkube validation
|
|
|
|
#### Iteration "Value Setting"
|
|
|
|
- Setting parameter values and installing
|
|
- Reconfiguring the application
|
|
|
|
#### Iteration "Repo View"
|
|
|
|
- Browsing repositories
|
|
- Adding new repository
|
|
- Installing new app from repo
|