add NOTES.txt (#6)

* add NOTES.txt * incrmenet chart ver * fix typo
treeverse · Aug 20, 2020 · be8d393 · be8d393
1 parent c48748b
commit be8d393
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 7 deletions.
diff --git a/charts/lakefs/Chart.yaml b/charts/lakefs/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: lakefs
 description: A Helm chart for Kubernetes
 type: application
-version: 0.2.3
+version: 0.2.4
 appVersion: 0.8.2
 
 home: https://lakefs.io

diff --git a/charts/lakefs/templates/NOTES.txt b/charts/lakefs/templates/NOTES.txt
@@ -0,0 +1,19 @@
+Thank you for installing lakeFS!
+
+1. Run the following to get a url to start setting up lakeFS:
+{{- if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "lakefs.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT/setup
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get svc -w {{ template "lakefs.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "lakefs.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+  echo http://$SERVICE_IP:{{ .Values.service.port }}/setup
+{{- else if contains "ClusterIP"  .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "lakefs.fullname" . }}" -o jsonpath="{.items[0].metadata.name}")
+  echo "Visit http://127.0.0.1:{{ .Values.deployment.port }}/setup to use your application"
+  kubectl port-forward $POD_NAME {{ .Values.deployment.port }}:{{ .Values.deployment.port }} --namespace {{ .Release.Namespace }}
+{{- end }}
+
+2. See the docs on how to create your first repository: https://docs.lakefs.io/quickstart.html#setting-up-a-repository
diff --git a/charts/lakefs/templates/_helpers.tpl b/charts/lakefs/templates/_helpers.tpl
@@ -47,6 +47,7 @@ app.kubernetes.io/managed-by: {{ .Release.Service }}
 Selector labels
 */}}
 {{- define "lakefs.selectorLabels" -}}
+app: {{ include "lakefs.name" . }}
 app.kubernetes.io/name: {{ include "lakefs.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}

diff --git a/charts/lakefs/templates/configmap.yaml b/charts/lakefs/templates/configmap.yaml
@@ -1,7 +1,7 @@
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: {{ .Values.configmap.name }}
+  name: {{ include "lakefs.fullname" . }}
 {{- with .Values.lakefsConfig }}
 data:
   config.yaml:

diff --git a/charts/lakefs/templates/deployment.yaml b/charts/lakefs/templates/deployment.yaml
@@ -33,7 +33,7 @@ spec:
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
             - name: http
-              containerPort: 8000
+              containerPort: {{ .Values.deployment.port }}
               protocol: TCP
           livenessProbe:
             httpGet:
@@ -93,7 +93,7 @@ spec:
         {{- else }}
         - name: config-volume
           configMap:
-            name: {{ .Values.configmap.name }}
+            name: {{ include "lakefs.fullname" . }}
             items:
               - key: config.yaml
                 path: config.yaml

diff --git a/charts/lakefs/values.yaml b/charts/lakefs/values.yaml
@@ -27,6 +27,9 @@ ingress:
 
 podAnnotations: {}
 
+deployment:
+  port: 8000
+
 service:
   type: ClusterIP
   port: 80
@@ -38,6 +41,3 @@ nodeSelector: {}
 tolerations: []
 
 affinity: {}
-
-configmap:
-  name: lakefs-config