Merge pull request #19 from yadneshk/ocp_deploy

Add manifests to deploy Metricly on top of OpenShift

README.md

@@ -34,7 +34,6 @@
 - **Podman** (for containerized deployment)
 - **Prometheus** (for metrics scraping)
 
----
 
 ### **Installation**
 
@@ -149,6 +148,20 @@ localhost/metricly:latest
 
 Prebuilt images with latest commits are pushed to [Quay](https://quay.io/repository/yadneshk/metricly?tab=tags).
 
+**Deploy on OpenShift**
+```bash
+oc new-project monitoring
+oc create -f manifests/metricly/security-ctx-constraint.yml
+oc create -f manifests/metricly/service-account.yml
+oc adm policy add-scc-to-user metricly -z metricly -n monitoring
+oc create -f manifests/metricly/config-map.yml
+oc create -f manifests/metricly/daemonset.yml
+oc create -f manifests/metricly/service.yml
+oc expose svc metricly
+```
+> [!NOTE]
+Currently these steps only deploy Metricly, it doesn't prepare any resources for alerts or data visualizations.
+
 ---
 
 ### **Metrics Exposed**
@@ -371,7 +384,8 @@ The Metricly exporter provides the following API endpoints:
           ]
         }
       }
-      ```      
+      ```
+---
 
 ### **Alertmanager Configuration** ###
 Metricly provides a few inbuilt alerts to monitor high utilization of CPU, Memory and Disk usage.
@@ -384,6 +398,8 @@ Upon meeting condition for any alert, an email notification is sent to the recei
 
 To include more alerts, take a look at `config/prometheus/alerts/`. Similar alerts can be built and added to the same directory.
 
+---
+
 ### **Development**
 
 #### **Testing**

manifests/metricly/config-map.yml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: metricly-config
+  namespace: monitoring
+data:
+  config.yaml: |
+    server:
+      address: 0.0.0.0
+      port: 8080
+    prometheus:
+      address: prometheus-service
+      port: 9090
+    interval: 10s
+    debug: true

manifests/metricly/daemonset.yml

@@ -0,0 +1,58 @@
+apiVersion: apps/v1
+kind: DaemonSet
+metadata:
+  name: metricly
+  namespace: monitoring
+spec:
+  selector:
+    matchLabels:
+      app: metricly
+  template:
+    metadata:
+      annotations:
+        openshift.io/required-scc: metricly
+      labels:
+        app: metricly
+    spec:
+      nodeSelector:
+        kubernetes.io/os: linux
+      serviceAccountName: metricly
+      containers:
+        - name: metricly
+          image: quay.io/yadneshk/metricly:latest
+          ports:
+            - containerPort: 8080
+              protocol: TCP
+          volumeMounts:
+            - name: config-volume
+              mountPath: /etc/metricly
+              readOnly: true
+            - name: host-filesystem
+              mountPath: /host/root/
+              mountPropagation: HostToContainer
+              readOnly: true
+          env:
+            - name: PROC_CPU_STAT
+              value: /host/root/proc/stat
+            - name: PROC_MEMORY_INFO
+              value: /host/root/proc/meminfo
+            - name: PROC_NETWORK_DEV
+              value: /host/root/proc/net/dev
+            - name: PROC_DISK_MOUNTS
+              value: /host/root/proc/mounts
+            - name: PROC_DISK_STATS
+              value: /host/root/proc/diskstats
+            - name: IGNORE_MOUNTS
+              value: "overlay,shm"
+          securityContext:
+            runAsUser: 0           
+      volumes:
+        - name: config-volume
+          configMap:
+            name: metricly-config
+        - name: host-filesystem
+          hostPath:
+            path: /
+
+---
+

manifests/metricly/security-ctx-constraint.yml

@@ -0,0 +1,19 @@
+allowHostDirVolumePlugin: true
+allowHostNetwork: true
+allowHostPID: true
+allowHostPorts: true
+allowPrivilegedContainer: true
+apiVersion: security.openshift.io/v1
+kind: SecurityContextConstraints
+metadata:
+  annotations:
+    kubernetes.io/description: SCC specific to Metricly
+  name: metricly
+readOnlyRootFilesystem: false
+runAsUser:
+  type: RunAsAny
+seLinuxContext:
+  type: RunAsAny
+seccompProfiles:
+- runtime/default
+users: []

manifests/metricly/service-account.yml

@@ -0,0 +1,8 @@
+apiVersion: v1
+automountServiceAccountToken: false
+kind: ServiceAccount
+metadata:
+  labels:
+    app.kubernetes.io/name: metricly
+  name: metricly
+  namespace: monitoring

manifests/metricly/service.yml

@@ -0,0 +1,13 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: metricly
+  namespace: monitoring
+spec:
+  selector:
+    app: metricly
+  ports:
+    - protocol: TCP
+      port: 8080
+      targetPort: 8080
+  type: ClusterIP