chore: update NOTES.txt with current template
Signed-off-by: Thomas Stocker <thomas.stocker.pro@gmail.com>
This commit is contained in:
Thomas Stocker
committed by
Bryan Frimin
Bryan Frimin
parent
ec67ac3991
commit
c1f5b01541
@@ -1,84 +1,88 @@
|
||||
🎉 Probo has been successfully deployed!
|
||||
|
||||
📋 Release Information:
|
||||
Name: {{ .Release.Name }}
|
||||
Namespace: {{ .Release.Namespace }}
|
||||
Version: {{ .Chart.AppVersion }}
|
||||
Name: {{ .Release.Name }}
|
||||
Namespace: {{ .Release.Namespace }}
|
||||
Version: {{ .Chart.AppVersion }}
|
||||
|
||||
🌐 Accessing Probo:
|
||||
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
Application: {{ if $.Values.ingress.tls }}https{{ else }}http{{ end }}://{{ $host.host }}
|
||||
Application: {{ if $.Values.ingress.tls }}https{{ else }}http{{ end }}://{{ $host.host }}
|
||||
{{- end }}
|
||||
{{- else if contains "NodePort" .Values.service.type }}
|
||||
Get the application URL by running:
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "probo.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo "Application: http://$NODE_IP:$NODE_PORT"
|
||||
{{- 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 by running:
|
||||
kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "probo.fullname" . }}
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
Watch the status:
|
||||
kubectl get svc --namespace {{ .Release.Namespace }} {{ include "probo.fullname" . }} -w
|
||||
|
||||
Once available, get the application URL by running:
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "probo.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo "Application: http://$SERVICE_IP:{{ .Values.service.port }}"
|
||||
Once available, access the application at the EXTERNAL-IP shown
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
Application is available only within the cluster.
|
||||
Application is available only within the cluster.
|
||||
|
||||
To access it from your local machine, run:
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward svc/{{ include "probo.fullname" . }} 8080:{{ .Values.service.port }}
|
||||
To access from your local machine:
|
||||
kubectl port-forward --namespace {{ .Release.Namespace }} svc/{{ include "probo.fullname" . }} 8080:{{ .Values.service.port }}
|
||||
|
||||
Then visit: http://localhost:8080
|
||||
Then visit: http://localhost:8080
|
||||
{{- end }}
|
||||
|
||||
📊 Monitoring:
|
||||
Metrics endpoint: http://{{ include "probo.fullname" . }}:{{ .Values.probo.metrics.port }}/metrics
|
||||
Metrics are exposed on port {{ .Values.probo.metrics.port }}
|
||||
|
||||
To access metrics from your local machine, run:
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward svc/{{ include "probo.fullname" . }} 8081:{{ .Values.probo.metrics.port }}
|
||||
To access metrics locally:
|
||||
kubectl port-forward --namespace {{ .Release.Namespace }} svc/{{ include "probo.fullname" . }} 8081:{{ .Values.probo.metrics.port }}
|
||||
|
||||
Then visit: http://localhost:8081/metrics
|
||||
|
||||
🔍 View Logs:
|
||||
kubectl --namespace {{ .Release.Namespace }} logs -f deployment/{{ include "probo.fullname" . }}
|
||||
kubectl logs --namespace {{ .Release.Namespace }} -f deployment/{{ include "probo.fullname" . }}
|
||||
|
||||
🗄️ Database:
|
||||
Using external PostgreSQL at: {{ .Values.postgresql.host }}:{{ .Values.postgresql.port }}
|
||||
Database: {{ .Values.postgresql.database }}
|
||||
{{- if .Values.postgresql.enabled }}
|
||||
Using CloudNativePG cluster: {{ include "probo.fullname" . }}-postgresql
|
||||
Read-write service: {{ include "probo.fullname" . }}-postgresql-rw:5432
|
||||
Database: {{ .Values.postgresql.database }}
|
||||
{{- else }}
|
||||
Using external PostgreSQL at: {{ .Values.postgresql.host }}:{{ .Values.postgresql.port }}
|
||||
Database: {{ .Values.postgresql.database }}
|
||||
{{- end }}
|
||||
|
||||
💾 Object Storage:
|
||||
Using S3 storage
|
||||
Bucket: {{ .Values.s3.bucket }}
|
||||
Region: {{ .Values.s3.region }}
|
||||
{{- if .Values.s3.endpoint }}
|
||||
Endpoint: {{ .Values.s3.endpoint }}
|
||||
{{- end }}
|
||||
|
||||
⚠️ Important Security Notes:
|
||||
{{- if .Values.minio.enabled }}
|
||||
Using MinIO: {{ include "probo.fullname" . }}-minio:9000
|
||||
Bucket: {{ .Values.s3.bucket }}
|
||||
{{- else }}
|
||||
Using S3 storage
|
||||
Bucket: {{ .Values.s3.bucket }}
|
||||
Region: {{ .Values.s3.region }}
|
||||
{{- if .Values.s3.endpoint }}
|
||||
Endpoint: {{ .Values.s3.endpoint }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
⚠️ Security Notes:
|
||||
{{- if not .Values.ingress.tls }}
|
||||
⚠️ TLS is not enabled! Enable it for production by configuring ingress.tls
|
||||
⚠️ TLS is not enabled! Enable it for production by configuring ingress.tls
|
||||
{{- end }}
|
||||
{{- if or .Values.postgresql.enabled .Values.minio.enabled }}
|
||||
⚠️ Using internal PostgreSQL or MinIO - FOR TESTING ONLY!
|
||||
For production, disable these and use external managed services.
|
||||
{{- end }}
|
||||
|
||||
📚 Next Steps:
|
||||
|
||||
1. Update the hostname in values.yaml to match your domain:
|
||||
1. Update the hostname to match your domain:
|
||||
probo.hostname: "{{ .Values.probo.hostname }}"
|
||||
|
||||
2. Configure email delivery:
|
||||
Update probo.mailer.smtp settings with your SMTP server details.
|
||||
Update probo.mailer.smtp settings with your SMTP server details
|
||||
|
||||
{{- if not .Values.probo.openai.apiKey }}
|
||||
3. (Optional) Configure OpenAI integration for AI-powered features:
|
||||
Set probo.openai.apiKey in values.yaml
|
||||
{{- end }}
|
||||
|
||||
4. Review and update CORS allowed origins:
|
||||
4. Review CORS allowed origins:
|
||||
probo.cors.allowedOrigins
|
||||
|
||||
📖 Documentation:
|
||||
- GitHub: https://github.com/getprobo/probo
|
||||
- Discord: https://discord.gg/8qfdJYfvpY
|
||||
- Website: https://getprobo.com
|
||||
|
||||
|
||||
✨ Thank you for using Probo!
|
||||
|
||||
Reference in New Issue
Block a user