Update Helm Chart info (#496)

* 🏷️ update chart info Signed-off-by: Rintaro Okamura <[email protected]> * ✅ fix tests Signed-off-by: Rintaro Okamura <[email protected]> * 🏷️ add more keywords Signed-off-by: Rintaro Okamura <[email protected]>
vdaas · Jun 19, 2020 · 1ad8de1 · 1ad8de1
1 parent eef0ea5
commit 1ad8de1
Show file tree

Hide file tree

Showing 19 changed files with 1,682 additions and 151 deletions.
diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fvdaas%2Fvald.svg?type=small&style=flat-square)](https://app.fossa.com/projects/git%2Bgithub.com%2Fvdaas%2Fvald?ref=badge_small)
 [![DeepSource](https://static.deepsource.io/deepsource-badge-light-mini.svg)](https://deepsource.io/gh/vdaas/vald/?ref=repository-badge)
 [![CLA](https://cla-assistant.io/readme/badge/vdaas/vald?&style=flat-square)](https://cla-assistant.io/vdaas/vald)
+[![Artifact Hub](https://img.shields.io/badge/chart-ArtifactHub-informational?logo=helm&style=flat-square)](https://artifacthub.io/packages/chart/vald/vald)
 [![Slack](https://img.shields.io/badge/slack-join-brightgreen?logo=slack&style=flat-square)](https://join.slack.com/t/vald-community/shared_invite/zt-db2ky9o4-R_9p2sVp8xRwztVa8gfnPA)
 [![Twitter](https://img.shields.io/badge/twitter-follow-blue?logo=twitter&style=flat-square)](https://twitter.com/vdaas_vald)
 <!--[![codecov](https://img.shields.io/codecov/c/github/vdaas/vald.svg?style=flat-square&logo=codecov)](https://codecov.io/gh/vdaas/vald) -->

diff --git a/charts/vald-helm-operator/Chart.yaml b/charts/vald-helm-operator/Chart.yaml
@@ -22,14 +22,26 @@ type: application
 keywords:
   - Vald
   - NGT
-home: https://vdaas.org
+  - vector
+  - search
+  - approximate-nearest-neighbor-search
+  - nearest-neighbor-search
+  - vector-search-engine
+  - similarity-search
+  - image-search
+  - operator
+  - Kubernetes
+  - k8s
+  - AI
+  - artificial-intelligence
+home: https://vald.vdaas.org
 icon: https://raw.githubusercontent.com/vdaas/vald/master/assets/image/svg/icon_color.svg
 sources:
   - https://github.com/vdaas/vald
 maintainers:
   - name: kpango
-    email: [email protected]
+    email: [email protected]
   - name: rinx
-    email: [email protected]
+    email: [email protected]
   - name: kmrmt
-    email: [email protected]
+    email: [email protected]
diff --git a/charts/vald-helm-operator/README.md.gotmpl b/charts/vald-helm-operator/README.md.gotmpl
@@ -5,6 +5,15 @@ This is a Helm chart to install vald-helm-operator.
 
 {{ template "chart.versionLine" . }}
 
+Table of Contents
+---
+
+- [Install](#install)
+- [Custom Resources](#custom-resources)
+    - [ValdRelease](#valdrelease)
+    - [ValdHelmOperatorRelease](#valdhelmoperatorrelease)
+- [Configuration](#configuration)
+
 Install
 ---
 

diff --git a/charts/vald/Chart.yaml b/charts/vald/Chart.yaml
@@ -22,14 +22,25 @@ type: application
 keywords:
   - Vald
   - NGT
-home: https://vdaas.org
+  - vector
+  - search
+  - approximate-nearest-neighbor-search
+  - nearest-neighbor-search
+  - vector-search-engine
+  - similarity-search
+  - image-search
+  - Kubernetes
+  - k8s
+  - AI
+  - artificial-intelligence
+home: https://vald.vdaas.org
 icon: https://raw.githubusercontent.com/vdaas/vald/master/assets/image/svg/icon_color.svg
 sources:
   - https://github.com/vdaas/vald
 maintainers:
   - name: kpango
-    email: [email protected]
+    email: [email protected]
   - name: rinx
-    email: [email protected]
+    email: [email protected]
   - name: kmrmt
-    email: [email protected]
+    email: [email protected]
diff --git a/charts/vald/README.md.gotmpl b/charts/vald/README.md.gotmpl
@@ -5,6 +5,16 @@ This is a Helm chart to install Vald components.
 
 {{ template "chart.versionLine" . }}
 
+Table of Contents
+---
+
+- [Install](#install)
+- [Configuration](#configuration)
+    - [Overview](#overview)
+    - [Parameters](#parameters)
+- [Miscellaneous](#miscellaneous)
+    - [Standalone Vald agent NGT deployment](#standalone-vald-agent-ngt-deployment)
+
 Install
 ---
 

diff --git a/internal/config/observability_test.go b/internal/config/observability_test.go
@@ -27,11 +27,12 @@ import (
 
 func TestObservability_Bind(t *testing.T) {
 	type fields struct {
-		Enabled    bool
-		Collector  *Collector
-		Trace      *Trace
-		Prometheus *Prometheus
-		Jaeger     *Jaeger
+		Enabled     bool
+		Collector   *Collector
+		Trace       *Trace
+		Prometheus  *Prometheus
+		Jaeger      *Jaeger
+		Stackdriver *Stackdriver
 	}
 	type want struct {
 		want *Observability
@@ -61,6 +62,7 @@ func TestObservability_Bind(t *testing.T) {
 		           Trace: Trace{},
 		           Prometheus: Prometheus{},
 		           Jaeger: Jaeger{},
+		           Stackdriver: Stackdriver{},
 		       },
 		       want: want{},
 		       checkFunc: defaultCheckFunc,
@@ -78,6 +80,7 @@ func TestObservability_Bind(t *testing.T) {
 		           Trace: Trace{},
 		           Prometheus: Prometheus{},
 		           Jaeger: Jaeger{},
+		           Stackdriver: Stackdriver{},
 		           },
 		           want: want{},
 		           checkFunc: defaultCheckFunc,
@@ -88,6 +91,7 @@ func TestObservability_Bind(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.name, func(tt *testing.T) {
+			defer goleak.VerifyNone(tt)
 			if test.beforeFunc != nil {
 				test.beforeFunc()
 			}
@@ -98,11 +102,12 @@ func TestObservability_Bind(t *testing.T) {
 				test.checkFunc = defaultCheckFunc
 			}
 			o := &Observability{
-				Enabled:    test.fields.Enabled,
-				Collector:  test.fields.Collector,
-				Trace:      test.fields.Trace,
-				Prometheus: test.fields.Prometheus,
-				Jaeger:     test.fields.Jaeger,
+				Enabled:     test.fields.Enabled,
+				Collector:   test.fields.Collector,
+				Trace:       test.fields.Trace,
+				Prometheus:  test.fields.Prometheus,
+				Jaeger:      test.fields.Jaeger,
+				Stackdriver: test.fields.Stackdriver,
 			}
 
 			got := o.Bind()
@@ -114,9 +119,88 @@ func TestObservability_Bind(t *testing.T) {
 	}
 }
 
+func TestCollector_Bind(t *testing.T) {
+	type fields struct {
+		Duration string
+		Metrics  *Metrics
+	}
+	type want struct {
+		want *Collector
+	}
+	type test struct {
+		name       string
+		fields     fields
+		want       want
+		checkFunc  func(want, *Collector) error
+		beforeFunc func()
+		afterFunc  func()
+	}
+	defaultCheckFunc := func(w want, got *Collector) error {
+		if !reflect.DeepEqual(got, w.want) {
+			return errors.Errorf("got = %v, want %v", got, w.want)
+		}
+		return nil
+	}
+	tests := []test{
+		// TODO test cases
+		/*
+		   {
+		       name: "test_case_1",
+		       fields: fields {
+		           Duration: "",
+		           Metrics: Metrics{},
+		       },
+		       want: want{},
+		       checkFunc: defaultCheckFunc,
+		   },
+		*/
+
+		// TODO test cases
+		/*
+		   func() test {
+		       return test {
+		           name: "test_case_2",
+		           fields: fields {
+		           Duration: "",
+		           Metrics: Metrics{},
+		           },
+		           want: want{},
+		           checkFunc: defaultCheckFunc,
+		       }
+		   }(),
+		*/
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(tt *testing.T) {
+			defer goleak.VerifyNone(tt)
+			if test.beforeFunc != nil {
+				test.beforeFunc()
+			}
+			if test.afterFunc != nil {
+				defer test.afterFunc()
+			}
+			if test.checkFunc == nil {
+				test.checkFunc = defaultCheckFunc
+			}
+			c := &Collector{
+				Duration: test.fields.Duration,
+				Metrics:  test.fields.Metrics,
+			}
+
+			got := c.Bind()
+			if err := test.checkFunc(test.want, got); err != nil {
+				tt.Errorf("error = %v", err)
+			}
+
+		})
+	}
+}
+
 func TestStackdriver_Bind(t *testing.T) {
 	type fields struct {
 		ProjectID string
+		Client    *StackdriverClient
 		Exporter  *StackdriverExporter
 		Profiler  *StackdriverProfiler
 	}
@@ -144,6 +228,7 @@ func TestStackdriver_Bind(t *testing.T) {
 		       name: "test_case_1",
 		       fields: fields {
 		           ProjectID: "",
+		           Client: StackdriverClient{},
 		           Exporter: StackdriverExporter{},
 		           Profiler: StackdriverProfiler{},
 		       },
@@ -159,6 +244,7 @@ func TestStackdriver_Bind(t *testing.T) {
 		           name: "test_case_2",
 		           fields: fields {
 		           ProjectID: "",
+		           Client: StackdriverClient{},
 		           Exporter: StackdriverExporter{},
 		           Profiler: StackdriverProfiler{},
 		           },
@@ -183,6 +269,7 @@ func TestStackdriver_Bind(t *testing.T) {
 			}
 			sd := &Stackdriver{
 				ProjectID: test.fields.ProjectID,
+				Client:    test.fields.Client,
 				Exporter:  test.fields.Exporter,
 				Profiler:  test.fields.Profiler,
 			}