docs: Update Readme files and Helm values (#57)

docs: Update Readme files and Helm values

Signed-off-by: hayk96 <[email protected]>

Author: hayk96

README.md

@@ -143,7 +143,9 @@ optional arguments:
 
 required parameters:
   --rule.path RULE.PATH
-                        path to Prometheus rules directory
+                        Prometheus rules directory path
+  --config.file CONFIG.FILE
+                        Prometheus configuration file path                        
   --prom.addr PROM.ADDR
                         URL of Prometheus server, e.g. http://localhost:9090
 ```

docs/examples/kubernetes/helm/README.md

@@ -4,6 +4,9 @@ To deploy `prometheus-api` in Kubernetes, it is easy to use the provided [values
 deploy the [prometheus-community/prometheus](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus)
 chart including the `prometheus-api` application as a sidecar container inside the Prometheus pod.
 
+**IMPORTANT:** When using the provided values.yaml, all Prometheus configurations specified in the prometheus.yml file can not be managed through Helm values. Instead, the configurations need to be managed via 
+the [/configs API](https://hayk96.github.io/prometheus-api/#tag/configs) or the web UI of the **prometheus-api** app.
+
 ### Get repository info
 ```shell
 $ helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
@@ -28,10 +31,10 @@ NAME                TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)   AGE
 prometheus-server   ClusterIP   10.100.237.217   <none>        80/TCP    1m
 
 $ kubectl logs -f -l app.kubernetes.io/component=server -c prometheus-api
-{"timestamp": "22 Jul 2023 13:13:52", "level": "INFO", "message": "The connection to the Prometheus server has been established successfully!"}
-{"timestamp": "22 Jul 2023 13:13:53", "level": "INFO", "message": "Server listening on 0.0.0.0:9090"}
-{"timestamp": "22 Jul 2023 13:13:53", "level": "INFO", "message": "-", "status": 200, "method": "POST", "path": "/-/reload"}
-{"timestamp": "22 Jul 2023 13:14:09", "level": "INFO", "message": "-", "status": 200, "method": "GET", "path": "/metrics"}
+{"timestamp": "07 Dec 2024 10:23:14", "level": "INFO", "message": "Starting web management UI"}
+{"timestamp": "07 Dec 2024 10:23:15", "level": "INFO", "message": "The connection to the Prometheus server has been established successfully!"}
+{"timestamp": "07 Dec 2024 10:23:15", "level": "INFO", "message": "Successfully started metrics endpoint at /api-metrics path"}
+{"timestamp": "07 Dec 2024 10:23:15", "level": "INFO", "message": "Server listening on 0.0.0.0:9090"}
 ```
 Once the apps are ready to handle requests, you can start creating your first Prometheus rules via API.
 > **Important:** As you can see, the type of service is `ClusterIP`, which means it's only accessible from within the 
@@ -81,9 +84,9 @@ HTTP/1.1 201 Created
 content-length: 99
 content-type: application/json
 
-{"status":"success","message":"The rule was created successfully","file":"scviiavxvnqdpjl.yml"}
+{"status":"success","message":"The rule was created successfully","file":"453ee16d-6310-42e0-8d57-2857e27d250f.yml"}
 ```
-Where the `scviiavxvnqdpjl.yml` is the randomly generated filename created by the **prometheus-api** server.
+Where the `453ee16d-6310-42e0-8d57-2857e27d250f.yml` is the randomly generated filename created by the **prometheus-api** server.
 
 ### Deleting alerting rule file via API
 > DELETE /api/v1/rules/{file}
@@ -92,7 +95,7 @@ _Note that the filename in your example is different from the example below._
 
 **Request**
 ```shell
-curl -i -XDELETE 'http://localhost:9090/api/v1/rules/scviiavxvnqdpjl.yml'
+curl -i -XDELETE 'http://localhost:9090/api/v1/rules/453ee16d-6310-42e0-8d57-2857e27d250f.yml'
 ```
 **Response**
 ```

docs/examples/kubernetes/helm/values.yaml

@@ -1,17 +1,37 @@
 server:
+  extraInitContainers:
+    - name: config-setup
+      image: busybox
+      command: ["sh", "-c"]
+      args:
+        - >
+          ! test -f /config/prometheus.yml && 
+          cp /etc/config/prometheus.yml /config 
+          || true
+      volumeMounts:
+        - name: config-volume
+          mountPath: /etc/config
+        - name: storage-volume
+          mountPath: /config
+          subPath: config
   sidecarContainers:
      prometheus-api:
        image: hayk96/prometheus-api:latest
        imagePullPolicy: IfNotPresent
        args:
         - --prom.addr=http://localhost:9091
         - --web.listen-address=0.0.0.0:9090
+        - --config.file=/config/prometheus.yml
         - --rule.path=/rules
         - --web.enable-ui=true
        ports:
          - name: http
            containerPort: 9090
        volumeMounts:
+        - name: storage-volume
+          mountPath: /config
+          subPath: config
+          readOnly: false
         - name: storage-volume
           mountPath: /rules
           subPath: rules
@@ -40,12 +60,19 @@ server:
     - web.enable-lifecycle
     - web.enable-admin-api
     - web.listen-address=:9091
+  configPath: /config/prometheus.yml
   extraVolumeMounts:
+    - name: storage-volume
+      mountPath: /config
+      subPath: config
     - name: storage-volume
       mountPath: /rules
       subPath: rules
 serverFiles:
   prometheus.yml:
     rule_files:
       - /rules/*.yml
-      - /rules/*.yaml
+      - /rules/*.yaml
+configmapReload:
+  prometheus:
+    enabled: false