release guac v0.1.0 (#32)

Signed-off-by: Sunny Yip <[email protected]>
kusaridev · May 23, 2023 · 9f53560 · 9f53560
1 parent 8fb3ef7
commit 9f53560
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 43 deletions.
diff --git a/charts/guac/Chart.yaml b/charts/guac/Chart.yaml
@@ -8,26 +8,9 @@ maintainers:
     url: https://github.com/kusaridev/guac-helm-charts
     email: [email protected]
 
-# A chart can be either an 'application' or a 'library' chart.
-#
-# Application charts are a collection of templates that can be packaged into versioned archives
-# to be deployed.
-#
-# Library charts provide useful utilities or functions for the chart developer. They're included as
-# a dependency of application charts to inject those utilities and functions into the rendering
-# pipeline. Library charts do not define any templates and therefore cannot be deployed.
 type: application
-
-# This is the chart version. This version number should be incremented each time you make changes
-# to the chart and its templates, including the app version.
-# Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.4
-
-# This is the version number of the application being deployed. This version number should be
-# incremented each time you make changes to the application. Versions are not expected to
-# follow Semantic Versioning. They should reflect the version the application is using.
-# It is recommended to use it with quotes.
-appVersion: "v0.0.1"
+version: 0.1.5
+appVersion: "v0.1.0"
 
 dependencies:
 - name: nats

diff --git a/charts/guac/README.md b/charts/guac/README.md
@@ -2,8 +2,9 @@
 
 This is a [Helm Chart](https://helm.sh/docs/topics/charts/) for deploying [GUAC](https://github.com/guacsec/guac) to [Kubernetes](https://kubernetes.io/).
 
-For a complete demo on how to utilize [GUAC](https://github.com/guacsec/guac) using the services deployed by this chart, see [link to demo].
+For a complete demo on how to utilize [GUAC](https://github.com/guacsec/guac) using the services deployed by this chart, see the [guac use cases](https://docs.guac.sh/guac-use-cases/).
 
+Please visit the web site at https://guac.sh for latest news and documentation of [GUAC](https://github.com/guacsec/guac).
 
 :exclamation: **Not Production Ready** - [GUAC](https://github.com/guacsec/guac) is still under active development. This chart is provided for rapidly deploying [GUAC](https://github.com/guacsec/guac) for experiment purposes. 
 Production support will be provided when [GUAC](https://github.com/guacsec/guac) is production ready.
@@ -68,18 +69,18 @@ See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_h
 
 
 ### Accessing GUAC 
-GUAC exposes a few interfaces for user interaction - including the GraphQL Server/Playground, and the Visualizer. You can access them via ```kubectl port-forward```
+GUAC exposes a few interfaces for user interaction - including the GraphQL Server/Playground, NATS, and CollectSub service. You can access them via ```kubectl port-forward```
 ```
 kubectl port-forward svc/graphql-server 8080:8080
-kubectl port-forward svc/visualizer 3000:3000 
-```
-
-If there is a need to access the NATS and CollectSub service, you can run
-```
 kubectl port-forward svc/guac-nats 4222:4222
 kubectl port-forward svc/collectsub 2782:2782
 ```
 
+### GUAC Visualizer
+The GUAC visualizer can be set up following the documentation at https://docs.guac.sh/guac-visualizer/. 
+Note that you will need to port-forward to the graphql service for the visualizer to work.
+
+We will support deploying the Visualizer at a later release.
 
 ## Uninstall
 
@@ -156,7 +157,8 @@ This section contains parameters for configuring the different GUAC components.
 | `guac.graphqlServer.ports[0].targetPort`                       | Port the GraphQL Server container listens on                                            | `8080`                                                    |
 | `guac.graphqlServer.backend`                                   | which backend to use - only support inmem at the moment.                                | `inmem`                                                   |
 | `guac.graphqlServer.debug`                                     | Enable debug mode for graphql server; also enable the UI                                | `true`                                                    |
-| `guac.visualizer.name`                                         | String Name of the visualizer component.                                                | `visualizer`                                              |
+| `guac.visualizer.enabled`                                      | String Whether to deploy the visualizer.                                                | `false`                                                   |
+| `guac.visualizer.name`                                         | String Name of the visualizer.                                                          | `visualizer`                                              |
 | `guac.visualizer.annotations.reloader.stakater.com/auto`       | Boolean for deploying [stakater/Reloader] (https://github.com/stakater/Reloader)        | `""`                                                      |
 | `guac.visualizer.replicas`                                     | Number of replicas for visualizer deployment                                            | `1`                                                       |
 | `guac.visualizer.image.repository`                             | Path to the Ingestor image                                                              | `ghcr.io/kusaridev/guac-visualizer`                       |

diff --git a/charts/guac/schema.json b/charts/guac/schema.json
@@ -53,7 +53,7 @@
                                 "digest": {
                                     "type": "string",
                                     "description": "Sha256 Image Digest.  It is strongly recommended to use this for verification.",
-                                    "default": "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+                                    "default": ""
                                 },
                                 "pullPolicy": {
                                     "type": "string",
@@ -106,7 +106,7 @@
                                 "digest": {
                                     "type": "string",
                                     "description": "Sha256 Image Digest.  It is strongly recommended to use this for verification.",
-                                    "default": "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+                                    "default": ""
                                 },
                                 "pullPolicy": {
                                     "type": "string",
@@ -159,7 +159,7 @@
                                 "digest": {
                                     "type": "string",
                                     "description": "Sha256 Image Digest.  It is strongly recommended to use this for verification.",
-                                    "default": "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+                                    "default": ""
                                 },
                                 "pullPolicy": {
                                     "type": "string",
@@ -212,7 +212,7 @@
                                 "digest": {
                                     "type": "string",
                                     "description": "Sha256 Image Digest.  It is strongly recommended to use this for verification.",
-                                    "default": "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+                                    "default": ""
                                 },
                                 "pullPolicy": {
                                     "type": "string",
@@ -265,7 +265,7 @@
                                 "digest": {
                                     "type": "string",
                                     "description": "Sha256 Image Digest.  It is strongly recommended to use this for verification.",
-                                    "default": "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+                                    "default": ""
                                 },
                                 "pullPolicy": {
                                     "type": "string",
@@ -339,7 +339,7 @@
                                 "digest": {
                                     "type": "string",
                                     "description": "Sha256 Image Digest.  It is strongly recommended to use this for verification.",
-                                    "default": "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+                                    "default": ""
                                 },
                                 "pullPolicy": {
                                     "type": "string",
@@ -396,9 +396,14 @@
                 "visualizer": {
                     "type": "object",
                     "properties": {
+                        "enabled": {
+                            "type": "boolean",
+                            "description": "String Whether to deploy the visualizer.",
+                            "default": false
+                        },
                         "name": {
                             "type": "string",
-                            "description": "String Name of the visualizer component.",
+                            "description": "String Name of the visualizer.",
                             "default": "visualizer"
                         },
                         "replicas": {

diff --git a/charts/guac/templates/visualizer-deployment.yaml b/charts/guac/templates/visualizer-deployment.yaml
@@ -1,5 +1,6 @@
 # Copyright Kusari, Inc. and contributors
 # Licensed under the MIT license. See LICENSE file in the project root for details.
+{{ if .Values.guac.visualizer.enabled }}
 ---
 apiVersion: apps/v1
 kind: Deployment
@@ -46,4 +47,5 @@ spec:
 {{- if .Values.imagePullSecrets }}
       imagePullSecrets:
 {{ toYaml .Values.imagePullSecrets | indent 8 }}
-{{- end }}
+{{- end }}
+{{- end }}
diff --git a/charts/guac/templates/visualizer-service.yaml b/charts/guac/templates/visualizer-service.yaml
@@ -1,5 +1,6 @@
 # Copyright Kusari, Inc. and contributors
 # Licensed under the MIT license. See LICENSE file in the project root for details.
+{{ if .Values.guac.visualizer.enabled }}
 {{- if .Values.guac.visualizer.ports }}
 ---
 apiVersion: v1
@@ -18,4 +19,5 @@ spec:
   {{- range .Values.guac.visualizer.ports }}
     - {{ . | toYaml | indent 6 | trim }}
   {{- end }}
-{{- end }}
+{{- end }}
+{{- end }}
diff --git a/charts/guac/values.yaml b/charts/guac/values.yaml
@@ -68,7 +68,8 @@ imagePullSecrets:
 ## @param guac.graphqlServer.ports[0].targetPort Port the GraphQL Server container listens on
 ## @param guac.graphqlServer.backend which backend to use - only support inmem at the moment.
 ## @param guac.graphqlServer.debug Enable debug mode for graphql server; also enable the UI
-## @param guac.visualizer.name String Name of the visualizer component.
+## @param guac.visualizer.enabled String Whether to deploy the visualizer.
+## @param guac.visualizer.name String Name of the visualizer.
 ## @param guac.visualizer.annotations.reloader.stakater.com/auto [string] Boolean for deploying [stakater/Reloader] (https://github.com/stakater/Reloader)
 ## @param guac.visualizer.replicas Number of replicas for visualizer deployment
 ## @param guac.visualizer.image.repository Path to the Ingestor image
@@ -94,7 +95,7 @@ guac:
       # if not set appVersion field from Chart.yaml is used
       tag: ""
       # When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value).
-      digest: "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+      digest: ""
       pullPolicy: IfNotPresent
       command: ['sh', '-c', '/cnb/process/guaccollect image']
 
@@ -108,7 +109,7 @@ guac:
       # if not set appVersion field from Chart.yaml is used
       tag: ""
       # When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value).
-      digest: "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+      digest: ""
       pullPolicy: IfNotPresent
       command: ['sh', '-c', '/cnb/process/guaccollect deps_dev']
 
@@ -122,7 +123,7 @@ guac:
       # if not set appVersion field from Chart.yaml is used
       tag: ""
       # When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value).
-      digest: "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+      digest: ""
       pullPolicy: IfNotPresent
       command: ['sh', '-c', '/cnb/process/guacone certifier osv --poll']
 
@@ -136,7 +137,7 @@ guac:
       # if not set appVersion field from Chart.yaml is used
       tag: ""
       # When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value).
-      digest: "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+      digest: ""
       pullPolicy: IfNotPresent
       command: ['sh', '-c', '/cnb/process/guacingest']
 
@@ -150,7 +151,7 @@ guac:
       # if not set appVersion field from Chart.yaml is used
       tag: ""
       # When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value).
-      digest: "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+      digest: ""
       pullPolicy: IfNotPresent
       command: ['sh', '-c', '/cnb/process/guaccsub']
     ports:
@@ -168,7 +169,7 @@ guac:
       # if not set appVersion field from Chart.yaml is used
       tag: ""
       # When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value).
-      digest: "sha256:088e2b7a90a3af363a88e78a9dff1caa0b8c3671fe42a50a5ce0202557f625a3"
+      digest: ""
       pullPolicy: IfNotPresent
       command: ['sh', '-c', '/cnb/process/guacgql']
     ports:
@@ -179,6 +180,7 @@ guac:
     debug: true
 
   visualizer:
+    enabled: false
     name: visualizer
     annotations:
       reloader.stakater.com/auto: "true"