|
1 | 1 | # Geodini |
2 | 2 |
|
3 | 3 | A natural language geocoding API. |
| 4 | + |
| 5 | +## Helm Chart Installation |
| 6 | + |
| 7 | +This application can be deployed using the provided Helm chart located in the `geodini-chart` directory. |
| 8 | + |
| 9 | +### Prerequisites |
| 10 | + |
| 11 | +* Kubernetes cluster (e.g., Minikube, Kind, or a cloud provider's K8s service) |
| 12 | +* Helm v3 installed |
| 13 | +* `kubectl` configured to connect to your cluster |
| 14 | + |
| 15 | +### Installation Steps |
| 16 | + |
| 17 | +1. **Navigate to the chart directory:** |
| 18 | + ```bash |
| 19 | + cd geodini-chart |
| 20 | + ``` |
| 21 | + |
| 22 | +2. **Review and customize values (Optional):** |
| 23 | + Before installing, you might want to customize the deployment by overriding default values. Create a `my-values.yaml` file or inspect `values.yaml` for available options. |
| 24 | + Key values you might want to override: |
| 25 | + * `postgres.password`: **It is highly recommended to change the default PostgreSQL password.** |
| 26 | + * `ingress.enabled`: Set to `true` if you have an Ingress controller and want to expose the application via Ingress. |
| 27 | + * `ingress.hosts`: Configure your desired hostname(s). |
| 28 | + * `ingress.tls`: Configure TLS secrets if using HTTPS. |
| 29 | + * `appDataPersistence.size` and `postgres.persistence.size`: Adjust storage sizes as needed. |
| 30 | + * Image tags for `api`, `frontend`, and `api.initContainer` if you want to use specific versions. |
| 31 | + |
| 32 | +3. **Install the chart:** |
| 33 | + To install the chart with the release name `geodini`: |
| 34 | + ```bash |
| 35 | + helm install geodini . |
| 36 | + ``` |
| 37 | + If you have a custom values file: |
| 38 | + ```bash |
| 39 | + helm install geodini . -f my-values.yaml |
| 40 | + ``` |
| 41 | + To install into a specific namespace: |
| 42 | + ```bash |
| 43 | + helm install geodini . --namespace geodini-ns --create-namespace |
| 44 | + ``` |
| 45 | + |
| 46 | +4. **Check deployment status:** |
| 47 | + ```bash |
| 48 | + kubectl get pods -n <your-namespace-if-any> |
| 49 | + kubectl get svc -n <your-namespace-if-any> |
| 50 | + ``` |
| 51 | + Wait for all pods to be in the `Running` state. The `NOTES.txt` output from the Helm install command will also provide useful information on how to access the application. |
| 52 | + |
| 53 | +### Accessing the Application |
| 54 | + |
| 55 | +* **Via Port-Forward (if Ingress is not enabled):** |
| 56 | + The `NOTES.txt` from the Helm installation will provide `kubectl port-forward` commands. Typically: |
| 57 | + ```bash |
| 58 | + # Forward Frontend |
| 59 | + kubectl port-forward svc/geodini-frontend 8080:80 # Access at http://localhost:8080 |
| 60 | + # Forward API (if direct access needed) |
| 61 | + kubectl port-forward svc/geodini-api 9000:9000 |
| 62 | + ``` |
| 63 | +* **Via Ingress (if enabled):** |
| 64 | + Access the application via the host and paths configured in your `values.yaml` (e.g., `http://chart-example.local/` or `https://your.domain.com/`). |
| 65 | + |
| 66 | +### Upgrading the Chart |
| 67 | + |
| 68 | +To upgrade an existing release: |
| 69 | +```bash |
| 70 | +helm upgrade geodini . -f my-values.yaml # Or without -f if no custom values |
| 71 | +``` |
| 72 | + |
| 73 | +### Uninstalling the Chart |
| 74 | + |
| 75 | +To uninstall/delete the `geodini` release: |
| 76 | +```bash |
| 77 | +helm uninstall geodini |
| 78 | +``` |
| 79 | +This will remove all Kubernetes components associated with the chart. PersistentVolumeClaims (PVCs) might need to be deleted manually if you want to remove the persisted data: |
| 80 | +```bash |
| 81 | +kubectl delete pvc geodini-app-data geodini-postgres-data |
| 82 | +``` |
| 83 | +(Adjust PVC names based on your release name). |
0 commit comments