merge transparent & tag => annotations

Signed-off-by: Gang Liu <gang.liu@daocloud.io>

Author: izturn

client.go

@@ -10,8 +10,6 @@ import (
 	"reflect"
 	"strings"
 
-	"k8s.io/apimachinery/pkg/api/errors"
-
 	"github.com/spf13/pflag"
 	"helm.sh/helm/v3/pkg/action"
 	"helm.sh/helm/v3/pkg/chart"
@@ -25,6 +23,7 @@ import (
 	v1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
 	"k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset"
+	"k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/yaml"
 	"k8s.io/cli-runtime/pkg/genericclioptions"
@@ -274,20 +273,25 @@ func (c *HelmClient) ListReleases(opts ListOptions) ([]*release.Release, error)
 		filterByName = true
 		filter = strings.ToLower(opts.Filter)
 	}
-	for _, v := range rels {
-		if filterByName && !strings.Contains(strings.ToLower(v.Name), filter) {
-			continue
-		}
 
-		t, ok := v.Config[walkAroundCustomTagKey]
-		if !ok {
+	// TODO: go routine it ?
+	for _, rel := range rels {
+		if filterByName && !strings.Contains(strings.ToLower(rel.Name), filter) {
 			continue
 		}
-		tag := strings.TrimSpace(t.(string))
-		if tag != opts.Selector {
-			continue
+
+		for key, val := range opts.Selectors {
+			sel, ok := rel.Config[key]
+			if !ok {
+				continue
+			}
+
+			if strings.TrimSpace(sel.(string)) != val {
+				continue
+			}
 		}
-		rr = append(rr, v)
+
+		rr = append(rr, rel)
 	}
 	return rr, nil
 }
@@ -302,24 +306,28 @@ func (c *HelmClient) GetRelease(name string) (*release.Release, error) {
 	return c.getRelease(name)
 }
 
-// Transparent returns the transparent value if not existed, returns ""
-func (c *HelmClient) Transparent(releaseName string) string {
-	r, err := c.getRelease(releaseName)
-	if err != nil {
-		return ""
-	}
-	return c.TransparentWithRelease(r)
+func toAnnotationKey(origin string) string {
+	return fmt.Sprintf(fmtAnnoationKey, origin)
 }
 
-// TransparentWithRelease returns the transparent value bind to the release if not existed, returns ""
-func (c *HelmClient) TransparentWithRelease(rel *release.Release) string {
-	if v, ok := rel.Config[transparentKey]; !ok {
+// AnnotationWithRelease get the annoation from release by key
+func (c *HelmClient) AnnotationWithRelease(rel *release.Release, key string) string {
+	if v, ok := rel.Config[toAnnotationKey(key)]; !ok {
 		return ""
 	} else {
 		return v.(string)
 	}
 }
 
+// Annotation  get the Annotation with the key from the release
+func (c *HelmClient) Annotation(releaseName, key string) string {
+	r, err := c.getRelease(releaseName)
+	if err != nil {
+		return ""
+	}
+	return c.AnnotationWithRelease(r, key)
+}
+
 // RollbackRelease implicitly rolls back a release to the last revision.
 func (c *HelmClient) RollbackRelease(spec *ChartSpec) error {
 	return c.rollbackRelease(spec)

interface.go

@@ -34,11 +34,8 @@ type Client interface {
 	ListReleaseHistory(name string, max int) ([]*release.Release, error)
 	GetChart(chartName string, chartPathOptions *action.ChartPathOptions) (*chart.Chart, string, error)
 
-	// Transparent returns the transparent in the release, if not existed, returns ""
-	Transparent(name string) string
-
-	// TransparentWithRelease returns the transparent value bind to the release if not existed, returns ""
-	TransparentWithRelease(rel *release.Release) string
+	// AnnotationWithRelease returns the annotation value bind to the key in the release if not existed, returns ""
+	AnnotationWithRelease(rel *release.Release, key string) string
 }
 
 type RollBack interface {

mock/interface.go

@@ -9,8 +9,8 @@ type ListOptions struct {
 	Namespace string
 	States    action.ListStates
 
-	// label.Selector
-	Selector string
+	//label.Selector
+	Selectors map[string]string
 
 	// name filter  case-insensitive
 	Filter string

options.go

@@ -4,11 +4,16 @@ import (
 	"sigs.k8s.io/yaml"
 )
 
-// transparentKey represents the key for save transparent values
-const transparentKey = "transparent__go-helm-client"
+const fmtAnnoationKey = "g0-he1m-c1ient__%s"
 
-// walkAroundCustomTagKey walkaround & wait for https://github.com/helm/helm/issues/11049
-const walkAroundCustomTagKey = "walk-around-custom-tag__go-helm-client"
+// common annoation's key
+const (
+	// walkaround & wait for https://github.com/helm/helm/issues/11049
+	ManagedBy = "manged-by"
+
+	// the user defined transparent values, will retrieve in future
+	Transparent = "transparent"
+)
 
 // GetValuesMap returns the mapped out values of a chart
 func (spec *ChartSpec) GetValuesMap() (map[string]interface{}, error) {
@@ -19,11 +24,8 @@ func (spec *ChartSpec) GetValuesMap() (map[string]interface{}, error) {
 		return nil, err
 	}
 
-	if spec.Transparent != "" {
-		values[transparentKey] = spec.Transparent
-	}
-	if spec.Tag != "" {
-		values[walkAroundCustomTagKey] = spec.Tag
+	for k, v := range spec.Annotations {
+		values[toAnnotationKey(k)] = v
 	}
 
 	return values, nil

spec.go

@@ -82,13 +82,9 @@ type ChartSpec struct {
 	// +optional
 	ValuesYaml string `json:"valuesYaml,omitempty"`
 
-	// Transparent the user defined transparent values, will retrieve in future
+	// Annotations save the all user defined data
 	// +optional
-	Transparent string `json:"transparent,omitempty"`
-
-	// Tag the tempoary walkaround & wait for https://github.com/helm/helm/pull/10533
-	// +optional
-	Tag string `json:"tag,omitempty"`
+	Annotations map[string]string
 
 	// Version of the chart release.
 	// +optional