mirror of
https://github.com/komodorio/helm-dashboard.git
synced 2026-03-24 03:38:04 +00:00
1580c2e9a0
* Add logo * Refactor out structs * Data layer context-awareness * Mod * Data layer improvements * Progress * Progress * Progress * Figured the time format shorter * Statuses colors * Sticky URL * Calculate some diffs inside * Separate checks * Scrap gofmt * Skip custom test in GH * Shows some colorful diff
67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
# Helm Dashboard
|
|
|
|
A simplified way of working with Helm.
|
|
|
|
## Local Testing
|
|
|
|
Until we make our repo public, we have to use a custom way to install the plugin.
|
|
|
|
To install, checkout the source code and run from source dir:
|
|
```shell
|
|
helm plugin install .
|
|
```
|
|
|
|
There is a need to build binary for plugin to function, run:
|
|
```shell
|
|
go build -o bin/dashboard .
|
|
```
|
|
|
|
Local install of plugin just creates a symlink, so making the changes and rebuilding the binary would not require reinstall of 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 tool users: [Slack community](#TODO) for general conversations and [GitHub issues](https://github.com/komodorio/helm-dashboard/issues) for real bugs.
|
|
|
|
## Roadmap
|
|
|
|
### Internal Milestone 1
|
|
- Helm Plugin Packaging
|
|
- CLI launcher
|
|
- Web Server with REST API
|
|
|
|
|
|
### First Public Version
|
|
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)
|
|
|
|
### Further Ideas
|
|
Setting parameter values and installing
|
|
Installing new app from repo
|
|
Uninstalling the app completely
|
|
Reconfiguring the application
|
|
Rollback a revision
|
|
|
|
Validate manifests before deploy and get better errors
|
|
Switch clusters (?)
|
|
Browsing repositories
|
|
Adding new repository
|
|
|
|
Recognise & show ArgoCD-originating charts/objects
|
|
Have cleaner idea on the web API structure |