[incubator-devlake] branch main updated: refacto: Refactor the Helm Installation Guide (#3049)

[kl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git


The following commit(s) were added to refs/heads/main by this push:
     new 1f378366 refacto: Refactor the Helm Installation Guide (#3049)
1f378366 is described below

commit 1f3783660fd02360343774ce30a8db2b0d0120e5
Author: Shubham Gupta <69...@users.noreply.github.com>
AuthorDate: Tue Sep 13 16:14:13 2022 +0530

    refacto: Refactor the Helm Installation Guide (#3049)
    
    * Helm-readMe
    
    * Helm-readMe
    
    * Helm-readMe
    
    * NodePort_add_to_Grafana
    
    * Change ReadMe
---
 deployment/helm/README.md               | 11 +++++++----
 deployment/helm/templates/services.yaml |  5 ++++-
 deployment/helm/values.yaml             |  1 +
 3 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/deployment/helm/README.md b/deployment/helm/README.md
index 81c89787..deac7903 100644
--- a/deployment/helm/README.md
+++ b/deployment/helm/README.md
@@ -8,14 +8,17 @@
 
 ## Quick Install
 
-clone the code, and enter the deployment/helm folder.
+clone the code
 ```
-helm install devlake .
+helm install devlake deployment/helm
 ```
 
-And visit your devlake from the node port (32001 by default).
+And visit your devlake Config-UI  from the nodePort (32001 by default) and Grafana Dashboard from the nodePort ( 32002 by default.)
 
-http://YOUR-NODE-IP:32001
+http://YOUR-NODE-IP:32001 for Config-UI
+http://YOUR-NODE-IP:32002 for Grafana Dashboard
+
+Note : You must provide the connection to the port through the Inbound rules of the cluster. You may found it in the cluster security group or the cluster firewall.
 
 
 ## Some example deployments
diff --git a/deployment/helm/templates/services.yaml b/deployment/helm/templates/services.yaml
index 38b15cc5..5c334e06 100644
--- a/deployment/helm/templates/services.yaml
+++ b/deployment/helm/templates/services.yaml
@@ -41,7 +41,7 @@ metadata:
   labels:
     {{- include "devlake.labels" . | nindent 4 }}
 spec:
-  type: ClusterIP
+  type: {{ .Values.service.type}}
   selector:
     {{- include "devlake.selectorLabels" . | nindent 4 }}
     devlakeComponent: grafana
@@ -50,6 +50,9 @@ spec:
       name: grafana
       port: 3000
       targetPort: 3000
+      {{- if eq .Values.service.type "NodePort" }}
+      nodePort: {{ .Values.service.grafanaPort }}
+      {{- end }}
 
 
 
diff --git a/deployment/helm/values.yaml b/deployment/helm/values.yaml
index afc29bfa..b84c2642 100644
--- a/deployment/helm/values.yaml
+++ b/deployment/helm/values.yaml
@@ -135,6 +135,7 @@ service:
   type: NodePort
   # service port for devlake-ui
   uiPort: 32001
+  grafanaPort : 32002
 
 ingress:
   enabled: false