Skip to content

Commit

Permalink
added more-useful NOTES.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
artntek committed Nov 2, 2023
1 parent a67a189 commit c25713c
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 4 deletions.
66 changes: 66 additions & 0 deletions helm/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
CHART NAME: {{ .Chart.Name }}
CHART VERSION: {{ .Chart.Version }}
APP VERSION: {{ .Chart.AppVersion }}

** Please be patient while the chart is being deployed **

RABBITMQ:
=========
Credentials:
echo "Username: {{ .Values.rabbitmq.auth.username }}"
echo "Password: $(kubectl get secret --namespace {{ .Release.Namespace }} {{ .Values.rabbitmq.auth.existingPasswordSecret }} -o jsonpath="{.data.rabbitmq-password}" | base64 -d)"

Note that the credentials are saved in persistent volume claims and will not be changed upon upgrade or reinstallation unless the persistent volume claim has been deleted. If this is not the first installation of this chart, the credentials may not be valid.

This is applicable when no passwords are set and therefore the random password is autogenerated. In case of using a fixed password, you should specify it when upgrading.

More information about the credentials may be found at https://docs.bitnami.com/general/how-to/troubleshoot-helm-chart-issues/#credential-errors-while-upgrading-chart-releases.

RabbitMQ can be accessed within the cluster on port {{ .Values.rabbitmq.hostport }} at {{ .Values.rabbitmq.hostname }}

Access the web console by port-forwarding:

kubectl -n {{ .Release.Namespace }} port-forward pod/{{ .Release.Name }}-rabbitmq-0 {{ .Values.rabbitmq.hostport }}:{{ .Values.rabbitmq.hostport }} &

...then login to the Rabbitmq web console: http://localhost:{{ .Values.rabbitmq.hostport }}

{{- if .Values.rabbitmq.metrics.enabled }}

To access the RabbitMQ Prometheus metrics, get the RabbitMQ Prometheus URL by running:

kubectl port-forward --namespace {{ .Release.Namespace }} svc/{{ include "common.names.fullname" . }} {{ .Values.service.ports.metrics }}:{{ .Values.service.ports.metrics }} &
echo "Prometheus Metrics URL: http://127.0.0.1:{{ .Values.service.ports.metrics }}/metrics"

Then, open the obtained URL in a browser.

{{- end }}

SOLR:
=====
Solr can be accessed via port {{ .Values.global.solrPort }} on the following DNS name from within
your cluster:

{{ .Values.solr.hostname }}:{{ .Values.global.solrPort }}

{{- if .Values.solr.auth.enabled }}

To get the Solr credentials execute the following commands:

echo Username: {{ .Values.solr.auth.adminUsername }}
echo Password: $(kubectl get secret --namespace {{ .Release.Namespace }} {{ .Values.solr.auth.existingSecret }} -o jsonpath="{.data.solr-password}" | base64 -d)

{{- end }}

Connect to the SOLR Dashboard by creating a kube proxy, and then browse to the local address:

kubectl -n {{ .Release.Namespace }} port-forward service/{{ .Release.Name }}-solr {{ .Values.global.solrPort }}:{{ .Values.rabbitmq.hostport }} &

Solr URL: http://127.0.0.1:{{ .Values.rabbitmq.hostport }}/solr/

{{- if .Values.solr.metrics.enabled }}

Solr Prometheus metrics can be accessed via port {{ .Values.metrics.service.ports.http }} on the following DNS name from within your cluster:

{{ printf "%s-exporter" (include "common.names.fullname" .) | trunc 63 | trimSuffix "-" }}.{{ .Release.Namespace }}.svc.{{ .Values.clusterDomain }}:{{ .Values.metrics.service.ports.http }}/metrics

{{- end }}
9 changes: 5 additions & 4 deletions helm/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,11 @@ solr:
containerPorts:
http: *global-solr-port
auth:
enabled: true
adminUsername: solrAdmin
existingSecret: ""
existingSecretPasswordKey: SOLR_ADMIN_PASSWORD
## Nov 2023: Agreed with Matt we don't need solr auth for now, since solr isn't exposed
## outside the cluster. Can add later if needed by anyone not using the subchart, and
## instead connecting to a solr instance outside the cluster
##
enabled: false
persistence:
size: 10Gi
extraVolumes:
Expand Down

0 comments on commit c25713c

Please sign in to comment.