Merge 3f8a67426ed8fd5ff042425f41fdb82e0b617279 into 297e04f69bcd32f311ed3928ef3141389b701bc9

kubernetes/README.md

@@ -11,9 +11,10 @@ This directory contains base Kubernetes manifests to self-host Rallly. It separa
 ## Configuration
 
 1. **Secrets (`secrets.yaml`):**
-    - **Important:** Do not commit the `secrets.yaml` file with real credentials to version control.
+   - **Important:** Do not commit the `secrets.yaml` file with real credentials to version control. Consider adding `secrets.yaml` to your `.gitignore` file to prevent accidental commits.
    - Update `POSTGRES_PASSWORD` and `SECRET_PASSWORD` (use `openssl rand -hex 32` to generate).
    - **Critical:** Ensure the password in `DATABASE_URL` matches `POSTGRES_PASSWORD`. Both must use the same value.
+   - **Format:** The `DATABASE_URL` format should look like this: `postgres://<user>:<password>@<postgres-service-name>:5432/<db-name>`.
 
 2. **Config (`rallly-config.yaml`):**
    - Update `NEXT_PUBLIC_BASE_URL` to match your domain.
@@ -36,6 +37,9 @@ kubectl apply -f rallly-config.yaml
 # 2. Apply Database (StatefulSet)
 kubectl apply -f postgres.yaml
 
+# Wait for database to be ready
+kubectl wait --for=condition=ready pod -l app=postgres --timeout=300s
+
 # 3. Apply Application (Deployment)
 kubectl apply -f rallly.yaml
 
@@ -43,6 +47,14 @@ kubectl apply -f rallly.yaml
 kubectl apply -f ingress.yaml
 ```
 
+**Note:** If you update `secrets.yaml` or `rallly-config.yaml` _after_ deployment, you must restart the Rallly pods for changes to take effect:
+
+```bash
+kubectl rollout restart deployment rallly
+```
+
+This performs a **rolling restart**, so there will be no downtime. However, ensure the new configuration is valid; if pods fail to start, check the logs with `kubectl logs -f deployment/rallly`.
+
 ## Verification
 
 Check that the pods are running:
@@ -55,4 +67,14 @@ The Postgres pod should show `1/1 Running` and the Rallly pod should eventually
 
 ## Notes on Storage
 
-The PostgreSQL StatefulSet requests a 1Gi PersistentVolume. Ensure your cluster has a default StorageClass configured, or update the `volumeClaimTemplates` in `postgres.yaml` to specify a StorageClass.
+The PostgreSQL StatefulSet requests a 1Gi PersistentVolume. Ensure your cluster has a default StorageClass configured, or update the `volumeClaimTemplates` in `postgres.yaml` to specify a StorageClass. If no StorageClass is available, the PersistentVolumeClaim will remain pending and the postgres pod will not start. Check your cluster's available StorageClasses with `kubectl get storageclass`.
+
+## Notes on Backups
+
+For production deployments, implement regular PostgreSQL backups. Consider using:
+
+- Kubernetes-native backup tools (e.g., Velero)
+- Scheduled pg_dump jobs within the cluster
+- Cloud-provider managed backups (if using managed K8s)
+
+Refer to your cluster provider's backup documentation for recommendations.

kubernetes/rallly.yaml

@@ -26,7 +26,7 @@ spec:
       app: rallly
   strategy:
     type: RollingUpdate
-    # Zero-donwtime deployment strategy
+    # Zero-downtime deployment strategy
     rollingUpdate:
       maxUnavailable: 0
       maxSurge: 1