Issue-ID: RICAPP-169 - Inclusion of InfluxDB helm chart for KPIMON, AD, TS, QP xApps
[ric-plt/ric-dep.git] / helm / 3rdparty / influxdb / templates / NOTES.txt
1 ################################################################################
2 #   Copyright (c) 2021 HCL Technolgies Limited.                                #
3 #                                                                              #
4 #   Licensed under the Apache License, Version 2.0 (the "License");            #
5 #   you may not use this file except in compliance with the License.           #
6 #   You may obtain a copy of the License at                                    #
7 #                                                                              #
8 #       http://www.apache.org/licenses/LICENSE-2.0                             #
9 #                                                                              #
10 #   Unless required by applicable law or agreed to in writing, software        #
11 #   distributed under the License is distributed on an "AS IS" BASIS,          #
12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
13 #   See the License for the specific language governing permissions and        #
14 #   limitations under the License.                                             #
15 ################################################################################
16 InfluxDB can be accessed via port {{ include "common.serviceport.influxdb.http.bind_address" . | default 8086 }} on the following DNS name from within your cluster:
17
18   http://{{ include "common.fullname.influxdb" . }}.{{ .Release.Namespace }}:{{ include "common.serviceport.influxdb.http.bind_address" . | default 8086 }}
19
20 You can connect to the remote instance with the influx CLI. To forward the API port to localhost:8086, run the following:
21
22   kubectl port-forward --namespace {{ .Release.Namespace }} $(kubectl get pods --namespace {{ .Release.Namespace }} -l app={{ include "common.fullname.influxdb" . }} -o jsonpath='{ .items[0].metadata.name }') 8086:{{ include "common.serviceport.influxdb.http.bind_address" . | default 8086 }}
23
24 You can also connect to the influx CLI from inside the container. To open a shell session in the InfluxDB pod, run the following:
25
26   kubectl exec -i -t --namespace {{ .Release.Namespace }} $(kubectl get pods --namespace {{ .Release.Namespace }} -l app={{ include "common.fullname.influxdb" . }} -o jsonpath='{.items[0].metadata.name}') /bin/sh
27
28 To view the logs for the InfluxDB pod, run the following:
29
30   kubectl logs -f --namespace {{ .Release.Namespace }} $(kubectl get pods --namespace {{ .Release.Namespace }} -l app={{ include "common.fullname.influxdb" . }} -o jsonpath='{ .items[0].metadata.name }')
31
32 {{- if .Values.setDefaultUser.enabled }}
33
34 To retrieve the default user name:
35
36 {{- if .Values.setDefaultUser.user.existingSecret }}
37
38   echo $(kubectl get secret {{ .Values.setDefaultUser.user.existingSecret }} -o "jsonpath={.data['influxdb-user']}" --namespace {{ .Release.Namespace }} | base64 --decode)
39
40 {{- else }}
41
42   echo $(kubectl get secret {{ include "common.fullname.influxdb" . }}-auth -o "jsonpath={.data['influxdb-user']}" --namespace {{ .Release.Namespace }} | base64 --decode)
43
44 {{- end }}
45
46 To retrieve the default user password:
47
48 {{- if .Values.setDefaultUser.user.existingSecret }}
49
50   echo $(kubectl get secret {{ .Values.setDefaultUser.user.existingSecret }} -o "jsonpath={.data['influxdb-password']}" --namespace {{ .Release.Namespace }} | base64 --decode)
51
52 {{- else }}
53
54   echo $(kubectl get secret {{ include "common.fullname.influxdb" . }}-auth -o "jsonpath={.data['influxdb-password']}" --namespace {{ .Release.Namespace }} | base64 --decode)
55
56 {{- end }}
57 {{- end }}