Files
orchard/helm/orchard/templates/NOTES.txt
Mondo Diaz 11131c2071 Fix Helm chart: rename minio.ingress to minioIngress to avoid subchart conflict
The minio.ingress config was conflicting with the Bitnami MinIO subchart's
own ingress configuration, causing coalesce.go warnings. Renamed to
minioIngress as a top-level config.

Also enabled minioIngress by default with host minio-orch-dev.common.global.bsf.tools
2025-12-16 12:47:26 -06:00

65 lines
3.0 KiB
Plaintext

Orchard has been installed!
1. Get the application URL by running these commands:
{{- if .Values.ingress.enabled }}
{{- range $host := .Values.ingress.hosts }}
{{- range .paths }}
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
{{- end }}
{{- end }}
{{- else if contains "NodePort" .Values.service.type }}
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "orchard.fullname" . }})
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
echo 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 of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "orchard.fullname" . }}'
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "orchard.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
echo http://$SERVICE_IP:{{ .Values.service.port }}
{{- else if contains "ClusterIP" .Values.service.type }}
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "orchard.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
echo "Visit http://127.0.0.1:8080 to use your application"
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
{{- end }}
2. API Endpoints:
- Health Check: GET /health
- List Projects: GET /api/v1/projects
- Create Project: POST /api/v1/projects
- Upload: POST /api/v1/project/{project}/{package}/upload
- Download: GET /api/v1/project/{project}/{package}/+/{ref}
3. Example Usage:
# Create a project
curl -X POST http://localhost:8080/api/v1/projects \
-H "Content-Type: application/json" \
-d '{"name": "my-project", "description": "My project", "is_public": true}'
# Create a package
curl -X POST http://localhost:8080/api/v1/project/my-project/packages \
-H "Content-Type: application/json" \
-d '{"name": "releases", "description": "Release builds"}'
# Upload an artifact
curl -X POST http://localhost:8080/api/v1/project/my-project/releases/upload \
-F "file=@./my-artifact.tar.gz" \
-F "tag=v1.0.0"
# Download an artifact
curl -O http://localhost:8080/api/v1/project/my-project/releases/+/v1.0.0
{{- if .Values.postgresql.enabled }}
4. PostgreSQL is deployed as a subchart.
Connection: {{ include "orchard.postgresql.host" . }}:5432
{{- end }}
{{- if .Values.minio.enabled }}
5. MinIO is deployed as a subchart.
Endpoint: {{ include "orchard.minio.host" . }}
Bucket: {{ .Values.orchard.s3.bucket }}
{{- end }}