Reduce k8s deployment replica and add metrics endpoints (#127)

README.md

@@ -56,8 +56,11 @@ Running in Docker
 - `docker compose up --build --exit-code-from regtest` - To run regression tests in a Docker environment.
 
 Running in Kubernetes
-- `./run.sh` - To run Polaris as a mini-deployment locally. This will create two pods that bind themselves to port `8181`.
-- `kubectl port-forward svc/polaris-service -n polaris 8181:8181` - To create a secure connection between a local machine and a pod within the cluster.
+- `./run.sh` - To run Polaris as a mini-deployment locally. This will create one pod that bind itself to ports `8181` and `8182`.
+- `kubectl port-forward svc/polaris-service -n polaris 8181:8181 8182:8182` - To create secure connections between a local machine and a pod within the cluster for both service and metrics endpoints.
+  - Currrently supported metrics endpoints:
+    - localhost:8182/metrics
+    - localhost:8182/healthcheck
 - `kubectl get pods -n polaris` - To check the status of the pods.
 - `kubectl get deployment -n polaris` - To check the status of the deployment.
 - `kubectl describe deployment polaris-deployment -n polaris` - To troubleshoot if things aren't working as expected.

k8/deployment.yaml

@@ -9,7 +9,7 @@ metadata:
   name: polaris-deployment
   namespace: polaris
 spec:
-  replicas: 2
+  replicas: 1
   selector:
     matchLabels:
       app: polaris
@@ -23,6 +23,7 @@ spec:
         image: localhost:5001/polaris:latest
         ports:
         - containerPort: 8181
+        - containerPort: 8182
 ---
 apiVersion: v1
 kind: Service
@@ -33,5 +34,9 @@ spec:
   selector:
     app: polaris
   ports:
-  - port: 8181
+  - name: service
+    port: 8181
     targetPort: 8181
+  - name: metrics
+    port: 8182
+    targetPort: 8182