Add Helm values support (#1518)

* working get values and get all valeus

* less verbose variable naming

* addressing comments and refactored to have a single view that has toggleable values

* better returns and logging

* returning event instead of nil

Co-authored-by: Joshua Ward <joshua.l.ward@leidos.com>
mine
Joshua Ward 2022-05-19 11:17:49 -04:00 committed by GitHub
parent 25e02db101
commit 1c29fcaf61
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 261 additions and 0 deletions

View File

@ -8,6 +8,7 @@ import (
"github.com/derailed/k9s/internal/client"
"github.com/derailed/k9s/internal/render"
"github.com/rs/zerolog/log"
"gopkg.in/yaml.v2"
"helm.sh/helm/v3/pkg/action"
"k8s.io/apimachinery/pkg/runtime"
)
@ -58,6 +59,23 @@ func (c *Helm) Get(_ context.Context, path string) (runtime.Object, error) {
return render.HelmRes{Release: resp}, nil
}
// GetValues returns values for a release
func (c *Helm) GetValues(path string, allValues bool) ([]byte, error) {
ns, n := client.Namespaced(path)
cfg, err := c.EnsureHelmConfig(ns)
if err != nil {
return nil, err
}
vals := action.NewGetValues(cfg)
vals.AllValues = allValues
resp, err := vals.Run(n)
if err != nil {
return nil, err
}
return yaml.Marshal(resp)
}
// Describe returns the chart notes.
func (c *Helm) Describe(path string) (string, error) {
ns, n := client.Namespaced(path)

209
internal/model/values.go Normal file
View File

@ -0,0 +1,209 @@
package model
import (
"context"
"regexp"
"strings"
"sync/atomic"
"time"
backoff "github.com/cenkalti/backoff/v4"
"github.com/derailed/k9s/internal/client"
"github.com/derailed/k9s/internal/dao"
"github.com/rs/zerolog/log"
"github.com/sahilm/fuzzy"
)
// Values tracks Helm values representations.
type Values struct {
gvr client.GVR
inUpdate int32
path string
query string
lines []string
allValues bool
listeners []ResourceViewerListener
options ViewerToggleOpts
}
// NewValues return a new Helm values resource model.
func NewValues(gvr client.GVR, path string) *Values {
return &Values{
gvr: gvr,
path: path,
allValues: false,
lines: getValues(path, false),
}
}
func getHelmDao() *dao.Helm {
return Registry["helm"].DAO.(*dao.Helm)
}
func getValues(path string, allValues bool) []string {
vals, err := getHelmDao().GetValues(path, allValues)
if err != nil {
log.Error().Err(err).Msgf("Failed to get Helm values")
}
return strings.Split(string(vals), "\n")
}
// ToggleValues toggles between user supplied values and computed values.
func (v *Values) ToggleValues() {
v.allValues = !v.allValues
lines := getValues(v.path, v.allValues)
v.lines = lines
}
// GetPath returns the active resource path.
func (v *Values) GetPath() string {
return v.path
}
// SetOptions toggle model options.
func (v *Values) SetOptions(ctx context.Context, opts ViewerToggleOpts) {
v.options = opts
if err := v.refresh(ctx); err != nil {
v.fireResourceFailed(err)
}
}
// Filter filters the model.
func (v *Values) Filter(q string) {
v.query = q
v.filterChanged(v.lines)
}
func (v *Values) filterChanged(lines []string) {
v.fireResourceChanged(lines, v.filter(v.query, lines))
}
func (v *Values) filter(q string, lines []string) fuzzy.Matches {
if q == "" {
return nil
}
if dao.IsFuzzySelector(q) {
return v.fuzzyFilter(strings.TrimSpace(q[2:]), lines)
}
return v.rxFilter(q, lines)
}
func (*Values) fuzzyFilter(q string, lines []string) fuzzy.Matches {
return fuzzy.Find(q, lines)
}
func (*Values) rxFilter(q string, lines []string) fuzzy.Matches {
rx, err := regexp.Compile(`(?i)` + q)
if err != nil {
return nil
}
matches := make(fuzzy.Matches, 0, len(lines))
for i, l := range lines {
if loc := rx.FindStringIndex(l); len(loc) == 2 {
matches = append(matches, fuzzy.Match{Str: q, Index: i, MatchedIndexes: loc})
}
}
return matches
}
func (v *Values) fireResourceChanged(lines []string, matches fuzzy.Matches) {
for _, l := range v.listeners {
l.ResourceChanged(lines, matches)
}
}
func (v *Values) fireResourceFailed(err error) {
for _, l := range v.listeners {
l.ResourceFailed(err)
}
}
// ClearFilter clear out the filter.
func (v *Values) ClearFilter() {
v.query = ""
}
// Peek returns the current model data.
func (v *Values) Peek() []string {
return v.lines
}
// Refresh updates model data.
func (v *Values) Refresh(ctx context.Context) error {
return v.refresh(ctx)
}
// Watch watches for Values changes.
func (v *Values) Watch(ctx context.Context) error {
if err := v.refresh(ctx); err != nil {
return err
}
go v.updater(ctx)
return nil
}
func (v *Values) updater(ctx context.Context) {
defer log.Debug().Msgf("YAML canceled -- %q", v.gvr)
backOff := NewExpBackOff(ctx, defaultReaderRefreshRate, maxReaderRetryInterval)
delay := defaultReaderRefreshRate
for {
select {
case <-ctx.Done():
return
case <-time.After(delay):
if err := v.refresh(ctx); err != nil {
v.fireResourceFailed(err)
if delay = backOff.NextBackOff(); delay == backoff.Stop {
log.Error().Err(err).Msgf("giving up retrieving chart values")
return
}
} else {
backOff.Reset()
delay = defaultReaderRefreshRate
}
}
}
}
func (v *Values) refresh(ctx context.Context) error {
if !atomic.CompareAndSwapInt32(&v.inUpdate, 0, 1) {
log.Debug().Msgf("Dropping update...")
return nil
}
defer atomic.StoreInt32(&v.inUpdate, 0)
if err := v.reconcile(ctx); err != nil {
return err
}
return nil
}
func (v *Values) reconcile(ctx context.Context) error {
v.fireResourceChanged(v.lines, v.filter(v.query, v.lines))
return nil
}
// AddListener adds a new model listener.
func (v *Values) AddListener(l ResourceViewerListener) {
v.listeners = append(v.listeners, l)
}
// RemoveListener delete a listener from the list.
func (v *Values) RemoveListener(l ResourceViewerListener) {
victim := -1
for i, lis := range v.listeners {
if lis == l {
victim = i
break
}
}
if victim >= 0 {
v.listeners = append(v.listeners[:victim], v.listeners[victim+1:]...)
}
}

View File

@ -3,7 +3,9 @@ package view
import (
"context"
"github.com/derailed/k9s/internal"
"github.com/derailed/k9s/internal/client"
"github.com/derailed/k9s/internal/model"
"github.com/derailed/k9s/internal/render"
"github.com/derailed/k9s/internal/ui"
"github.com/gdamore/tcell/v2"
@ -12,6 +14,8 @@ import (
// Helm represents a helm chart view.
type Helm struct {
ResourceViewer
Values *model.Values
}
// NewHelm returns a new alias view.
@ -38,5 +42,35 @@ func (c *Helm) bindKeys(aa ui.KeyActions) {
ui.KeyShiftN: ui.NewKeyAction("Sort Name", c.GetTable().SortColCmd(nameCol, true), false),
ui.KeyShiftS: ui.NewKeyAction("Sort Status", c.GetTable().SortColCmd(statusCol, true), false),
ui.KeyShiftA: ui.NewKeyAction("Sort Age", c.GetTable().SortColCmd(ageCol, true), false),
ui.KeyV: ui.NewKeyAction("Values", c.getValsCmd(), true),
})
}
func (c *Helm) getValsCmd() func(evt *tcell.EventKey) *tcell.EventKey {
return func(evt *tcell.EventKey) *tcell.EventKey {
path := c.GetTable().GetSelectedItem()
if path == "" {
return evt
}
c.Values = model.NewValues(c.GVR(), path)
v := NewLiveView(c.App(), "Values", c.Values)
v.actions.Add(ui.KeyActions{
ui.KeyV: ui.NewKeyAction("Toggle All Values", c.toggleValuesCmd, true),
})
if err := v.app.inject(v); err != nil {
v.app.Flash().Err(err)
}
return nil
}
}
func (c *Helm) toggleValuesCmd(evt *tcell.EventKey) *tcell.EventKey {
c.Values.ToggleValues()
c.Values.Refresh(c.defaultCtx())
c.App().Flash().Infof("Values toggled")
return nil
}
func (c *Helm) defaultCtx() context.Context {
return context.WithValue(context.Background(), internal.KeyFactory, c.App().factory)
}