Add Helm chart, Docs, and Config conversion script
Some checks failed
Build / Code Quality Checks (push) Successful in 15m11s
Build / Build & Push Docker Images (worker) (push) Successful in 13m44s
Build / Build & Push Docker Images (frontend) (push) Successful in 5m8s
Build / Build & Push Docker Images (chat) (push) Failing after 30m7s
Build / Build & Push Docker Images (api) (push) Failing after 21m39s
Some checks failed
Build / Code Quality Checks (push) Successful in 15m11s
Build / Build & Push Docker Images (worker) (push) Successful in 13m44s
Build / Build & Push Docker Images (frontend) (push) Successful in 5m8s
Build / Build & Push Docker Images (chat) (push) Failing after 30m7s
Build / Build & Push Docker Images (api) (push) Failing after 21m39s
This commit is contained in:
162
deploy/helm/datacenter-docs/templates/NOTES.txt
Normal file
162
deploy/helm/datacenter-docs/templates/NOTES.txt
Normal file
@@ -0,0 +1,162 @@
|
||||
█████████████████████████████████████████████████████████████████████████████
|
||||
█ █
|
||||
█ Datacenter Docs & Remediation Engine - Successfully Deployed! █
|
||||
█ █
|
||||
█████████████████████████████████████████████████████████████████████████████
|
||||
|
||||
Thank you for installing {{ .Chart.Name }}.
|
||||
|
||||
Your release is named {{ .Release.Name }}.
|
||||
Release namespace: {{ .Release.Namespace }}
|
||||
|
||||
==============================================================================
|
||||
📦 INSTALLED COMPONENTS:
|
||||
==============================================================================
|
||||
|
||||
{{- if .Values.mongodb.enabled }}
|
||||
✓ MongoDB (Database)
|
||||
{{- end }}
|
||||
{{- if .Values.redis.enabled }}
|
||||
✓ Redis (Cache & Task Queue)
|
||||
{{- end }}
|
||||
{{- if .Values.api.enabled }}
|
||||
✓ API Service
|
||||
{{- end }}
|
||||
{{- if .Values.chat.enabled }}
|
||||
✓ Chat Service (WebSocket)
|
||||
{{- end }}
|
||||
{{- if .Values.worker.enabled }}
|
||||
✓ Celery Worker (Background Tasks)
|
||||
{{- end }}
|
||||
{{- if .Values.frontend.enabled }}
|
||||
✓ Frontend (Web UI)
|
||||
{{- end }}
|
||||
|
||||
==============================================================================
|
||||
🔍 CHECK DEPLOYMENT STATUS:
|
||||
==============================================================================
|
||||
|
||||
kubectl get pods -n {{ .Release.Namespace }} -l app.kubernetes.io/instance={{ .Release.Name }}
|
||||
|
||||
kubectl get services -n {{ .Release.Namespace }} -l app.kubernetes.io/instance={{ .Release.Name }}
|
||||
|
||||
==============================================================================
|
||||
🌐 ACCESS YOUR APPLICATION:
|
||||
==============================================================================
|
||||
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
{{ if $.Values.ingress.tls }}https{{ else }}http{{ end }}://{{ $host.host }}
|
||||
{{- end }}
|
||||
{{- else if .Values.frontend.enabled }}
|
||||
|
||||
To access the frontend, run:
|
||||
|
||||
kubectl port-forward -n {{ .Release.Namespace }} svc/{{ include "datacenter-docs.frontend.fullname" . }} 8080:{{ .Values.frontend.service.port }}
|
||||
|
||||
Then visit: http://localhost:8080
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.api.enabled }}
|
||||
|
||||
To access the API directly, run:
|
||||
|
||||
kubectl port-forward -n {{ .Release.Namespace }} svc/{{ include "datacenter-docs.api.fullname" . }} 8000:{{ .Values.api.service.port }}
|
||||
|
||||
Then visit: http://localhost:8000/api/docs (OpenAPI documentation)
|
||||
{{- end }}
|
||||
|
||||
==============================================================================
|
||||
📊 VIEW LOGS:
|
||||
==============================================================================
|
||||
|
||||
API logs:
|
||||
kubectl logs -n {{ .Release.Namespace }} -l app.kubernetes.io/component=api -f
|
||||
|
||||
{{- if .Values.worker.enabled }}
|
||||
Worker logs:
|
||||
kubectl logs -n {{ .Release.Namespace }} -l app.kubernetes.io/component=worker -f
|
||||
{{- end }}
|
||||
|
||||
{{- if .Values.chat.enabled }}
|
||||
Chat logs:
|
||||
kubectl logs -n {{ .Release.Namespace }} -l app.kubernetes.io/component=chat -f
|
||||
{{- end }}
|
||||
|
||||
==============================================================================
|
||||
🔐 SECURITY NOTICE:
|
||||
==============================================================================
|
||||
|
||||
{{ if eq .Values.secrets.llmApiKey "sk-your-openai-api-key-here" }}
|
||||
⚠️ WARNING: You are using the default LLM API key!
|
||||
Update this immediately in production:
|
||||
|
||||
helm upgrade {{ .Release.Name }} datacenter-docs \
|
||||
--set secrets.llmApiKey="your-actual-api-key" \
|
||||
--reuse-values
|
||||
{{ end }}
|
||||
|
||||
{{ if eq .Values.secrets.apiSecretKey "your-secret-key-here-change-in-production" }}
|
||||
⚠️ WARNING: You are using the default API secret key!
|
||||
Update this immediately in production:
|
||||
|
||||
helm upgrade {{ .Release.Name }} datacenter-docs \
|
||||
--set secrets.apiSecretKey="your-actual-secret-key" \
|
||||
--reuse-values
|
||||
{{ end }}
|
||||
|
||||
For production deployments:
|
||||
- Use strong, unique secrets
|
||||
- Enable TLS/SSL for all services
|
||||
- Review security context and RBAC policies
|
||||
- Consider using external secret management (e.g., HashiCorp Vault)
|
||||
|
||||
==============================================================================
|
||||
📖 USEFUL COMMANDS:
|
||||
==============================================================================
|
||||
|
||||
Upgrade release:
|
||||
helm upgrade {{ .Release.Name }} datacenter-docs --values custom-values.yaml
|
||||
|
||||
Get values:
|
||||
helm get values {{ .Release.Name }}
|
||||
|
||||
View all resources:
|
||||
helm get manifest {{ .Release.Name }}
|
||||
|
||||
Uninstall:
|
||||
helm uninstall {{ .Release.Name }}
|
||||
|
||||
==============================================================================
|
||||
🛠️ CONFIGURATION:
|
||||
==============================================================================
|
||||
|
||||
{{- if .Values.config.autoRemediation.enabled }}
|
||||
✓ Auto-remediation: ENABLED
|
||||
- Minimum reliability score: {{ .Values.config.autoRemediation.minReliabilityScore }}%
|
||||
- Approval threshold: {{ .Values.config.autoRemediation.requireApprovalThreshold }}%
|
||||
{{- if .Values.config.autoRemediation.dryRun }}
|
||||
- Mode: DRY RUN (no actual changes will be made)
|
||||
{{- else }}
|
||||
- Mode: ACTIVE (changes will be applied)
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
⚠️ Auto-remediation: DISABLED
|
||||
{{- end }}
|
||||
|
||||
LLM Provider: {{ .Values.config.llm.baseUrl }}
|
||||
Model: {{ .Values.config.llm.model }}
|
||||
|
||||
==============================================================================
|
||||
📚 DOCUMENTATION & SUPPORT:
|
||||
==============================================================================
|
||||
|
||||
For more information, visit:
|
||||
https://git.commandware.com/it-ops/llm-automation-docs-and-remediation-engine
|
||||
|
||||
Report issues:
|
||||
https://git.commandware.com/it-ops/llm-automation-docs-and-remediation-engine/issues
|
||||
|
||||
==============================================================================
|
||||
|
||||
Happy automating! 🚀
|
||||
Reference in New Issue
Block a user