refactoring documentation and deployment manifests

Author: rchakode

.idea/.gitignore

@@ -1,97 +1,50 @@
 
+![](./images/banners/realopinsight-overview-thumbnail.png)
+
+
+![GPL v3 License](https://img.shields.io/github/license/rchakode/realopinsight.svg?label=License)
+[![Calendar Versioning](https://img.shields.io/badge/calver-YY.MM.MICRO-bb8fce.svg)](http://calver.org)
 ![build](https://github.com/rchakode/realopinsight/workflows/CI/badge.svg)
+![Docker pulls](https://img.shields.io/docker/pulls/rchakode/realopinsight.svg?label=Docker%20Pulls)
 
-# Overview
-RealOpInsight allows to monitor, measure and observe end-user applications availability atop of Kubernetes®, Zabbix®, Nagios®. It features application-specific knowledges to aggregate and handle the status of low-level probes in a way that is meaningful for any targeted end-user application.
+---
 
 - [Overview](#overview)
-- [Key Features](#key-features)
-- [Quick Start](#quick-start)
-    - [Deployment on kubernetes](#deployment-on-kubernetes)
-    - [Deployment on Docker](#deployment-on-docker)
-    - [Getting Started](#getting-started)
+- [Getting Started](#getting-started)
+- [License](#license)
 - [Contributions](#contributions)
-- [Copyrights & License](#copyrights--license)
-
-# Key Features
-Fully open source ([GPL v3 Licence](LICENSE)), RealOpinsight features include:
-* **Monitor business values, Define & track SLA/SLO targets:** Focus on the applications that underlie your business, set up application-aware notifications, measure, observe and analyze applications availability over time.
-* **Federated & unified applications monitoring:** RealOpInsight enables to set up unified applications monitoring views on top of applications and corporate environments that rely on many monitoring systems. Thereby breaking monitoring silos, it boosts the productivity of operations staffs while helping them solving incident with relevant priorities.
-* **Relationship mapping & event correlation:** Map relationships among each application components, set up application-specific policies to calculate and propagate the severity of incidents so as to meet your particular incident management needs.
-* **Simple and secured integration through API:** Don't waste time on complex or boring configuration tasks, RealOpInsight only requires a read-only access to the API of the monitoring data collection backends (i.e. Kubernetes API, Zabbix API...). It's released as Docker images along with Kubernetes Helm3 manifests to ease its deployment.
-* **Tactical Operations Dashboards:** Whether you're an operations staff or executive, RealOpInsight allows to build user-specific tactical dashboards that allow you to have a quick insight on how your applications are operating while be able to have more details in one click.
-
-![](./images/banners/screenshots.png)
-
-# Quick Start
-RealOpInsight is released as Docker images along with Kubernetes Helm3 manifests to ease its deployment.
-
-The below sections show how to set an instance of RealOpInsight in a couple of seconds on Kubernetes or on an [OCI](https://opencontainers.org/)-compliant container engine (Docker, Podman, CRI-O, etc).
 
-## Deployment on Kubernetes
-Assuming you have a Linux terminal with Helm3 installed and able to access a KUBECONFIG file to deploy resources on Kubernetes, the following command shall install an instance in the `monitoring` namespace. **The namespace must exist**, it can be changed to another value.
-
-```
-helm upgrade \
-  --namespace monitoring \
-  --install realopinsight \
-  helm/realopinsight/
-```
-
-By default the Helm manifests also deploy a **ClusterIP** service named `realopinsiht` to expose the UI on port `80` and Prometheus metrics on port `4584`. The associated in-cluster URLs are the following:
-  * UI: `http://realopinsight.monitoring/ui`.
-  * Prometheus metrics: `http://realopinsight.monitoring:4583/metrics`.
+# Overview
+RealOpInsight features application-specific knowledges to monitors an IT infrastructure from an end-user service point of view. It leverages low-level probes from Kubernetes®, Zabbix® and/or Nagios®, and enable to build on top of that an application service tree allowing to easily evaluate the impact of each incident on the service availability. 
 
-## Remote access to the UI
-To get a remote access to the UI, use one of the following options:
-  * Change the service type to **LoadBalancer** (see [Helm value files](helm/realopinsight/values.yaml));
-  * Enable an Ingress access (see [Helm value files](helm/realopinsight/values.yaml));
-  * Enable port-forwarding from your local machine as follows (change the namespace if different).
-    ```
-    kubectl port-forward \
-      --namespace monitoring \
-      service/realopinsight-ui 4583:80
-    ```
-    Then point your browser at the following address: http://localhost:4583/ui/.
+Key features:
 
-## Deployment on Docker
-The following command shall pull the image and start an instance of RealOpInsight in background. The `-d` option can be removed to start the instance in foreground.
-With this command the data of the instance will be stored locally on the Docker machine at the specified path (value of option `--volume`, can be changed if needed).
+  * **Monitor business values, Define & track SLA/SLO targets:** Focus on the applications that underlie your business, set up application-aware notifications, measure, observe and analyze applications availability over time.
+  * **Federated & unified applications monitoring:** Break silos by setting up unified applications monitoring operations views that hide the underlying monitoring systems while helping you solving incidents with relevant business priorities.
+  * **Relationship mapping & event correlation:** Map relationships among application components, set up specific business-oriented policies to handle and propagate each incident with appropriate business impact.
+  * **Simple and secured integration through API:** Don't waste time on complex configuration tasks, just a couple of minute is required to deploy and get started with RealOpInsight.
+  * **Tactical Operations Dashboards:** For operations staff or executive, build specific tactical dashboards to get quick insight on how your applications are operating, be able to get details in one click.
+  * Open source licensed under the terms of [GPL v3 Licence](LICENSE).
 
-```
-$ docker run -d \
-  --name realopinsight \
-  --network host \
-  --volume $HOME/.realopinsight:/opt/realopinsight \
-  rchakode/realopinsight
-```
+![](./images/banners/screenshots.png)
 
-Once the container started, it shall enable the following endpoints:
- * UI: `http://localhost:4583/ui`.
- * Prometheus metrics: `http://localhost:4584/metrics`.
+# Getting Started
+  * [Deployment on Kubernetes](./docs/deployement-on-kubernetes.md)
+  * [Deployment on Docker](./docs/deployement-on-deployment-on-docker.md)
+  * [Integration with Kubernetes](https://realopinsight.com/docs/quickstart-kubernetes-dashboard/)
+  * [Integration with Zabbix](https://realopinsight.com/docs/quickstart-zabbix-dashboard/)
+  * [Integration with Nagios and alike](https://realopinsight.com/docs/quickstart-nagios-icinga-centreon-dashboard/)
+  * [Design fundamentals](https://realopinsight.com/docs/monitoring-data-sources/)
 
-## Default admin credentials
-The default username and password for the UI are `admin` and `password`.
+> The default credentials: username => `admin`, password => `password` (should be changed).
 
-> For a production setup, you must change this default password as quick as possible.
+# License
+RealOpInsight is licensed under the terms of [GPLv3 License](LICENSE), mainly due to copyleft contamination by third-party software to which it's bound (e.g. [Qt](https://www.qt.io/), [Wt](https://www.webtoolkit.eu/wt)).
 
-## Configuration and next steps
-Consider the following resources to start integrating RealOpInsight with your target monitoring environment.
-* [Architecture & Supported Monitoring Sources](https://realopinsight.com/docs/monitoring-data-sources/)
-* [Integration with Kubernetes](https://realopinsight.com/docs/quickstart-kubernetes-dashboard/)
-* [Integration with Zabbix](https://realopinsight.com/docs/quickstart-zabbix-dashboard/)
-* [Integration with Nagios and related systems](https://realopinsight.com/docs/quickstart-nagios-icinga-centreon-dashboard/)
 
 # Contributions
-Contributions in any form (feedback, code, documentation...) are welcome.
-
-For code contributions it's required to have skills in writing code in C+11 or later.
-
-The software also includes [Qt](https://www.qt.io/) and [Wt](https://www.webtoolkit.eu/wt) at it core. Having fundamentals to develop software using this frameworks may be helpful, but not required.
-
-# Copyrights & License
-This project has been initiated by Rodrigue Chakode and open to contributions.
-
-Contributions in any form (code, documentation...) must be aligned and compliant with the following terms.
+Contributions in any forms are welcomed (feedback, code, documentation, etc).
 
-The software is licensed under the terms of [GPLv3 License](LICENSE), mainly due to contamination by third-party systems that the software is bound to. All those third-party systems may offer dual licenses (e.g. for proprietary uses), subject to pay some license fees. You can contact us you're interested in such a use.
+RealOpInsight is developed using C++14 and is bound the [Qt](https://www.qt.io/) and [Wt](https://www.webtoolkit.eu/wt) frameworks. 
+Having fundamentals to develop software in C++11 or higher is required. 
+It may be helpful, but not required, to have experience building software with Qt and Wt.

.idea/modules.xml

@@ -0,0 +1,47 @@
+# Deploy RealOpInsight on Kubernetes
+This document describes how to deploy RealOpInsight on a Kubernetes cluster.
+
+The deployment can be achieved using `Helm` or `kubectl` + `Kustomize`. Select the appropriate section below to getting started.
+
+- [Deploy RealOpInsight on Kubernetes](#deploy-realopinsight-on-kubernetes)
+  - [Installation using kubectl and Kustomize](#installation-using-kubectl-and-kustomize)
+  - [Deployment with Helm](#deployment-with-helm)
+  - [In-cluster access to service](#in-cluster-access-to-service)
+  - [Remote access to the service](#remote-access-to-the-service)
+
+## Installation using kubectl and Kustomize
+First review the default configuration settings in the deployment ConfigMap: `kustomize/realopinsight-config.yaml`.
+
+Then, perform the following command to submit the deployment.
+The target namespace (`monitoring`) is assumed to exist. Otherwise, create it first.
+
+```
+kubectl -n monitoring apply -k ./manifests/kustomize
+```
+
+## Deployment with Helm
+Assuming you have a Linux terminal with Helm3 installed and able to access a KUBECONFIG file to deploy resources on Kubernetes, the following command shall install an instance in the `monitoring` namespace. **The namespace must exist**, it can be changed to another value.
+
+```
+helm upgrade --namespace monitoring --install realopinsight manifests/helm/realopinsight/
+```
+
+## In-cluster access to service
+On success, the deployment does create a Kubernetes **ClusterIP** service named `realopinsiht`.
+
+This service exposes the RealOpInsight's web interface (port `80`) as well as its Prometheus exporter (port `4584`).
+
+Their in-cluster URLs are the following:
+  * Web UI: `http://realopinsight.monitoring/ui`.
+  * Prometheus metrics: `http://realopinsight.monitoring:4583/metrics`.
+
+
+## Remote access to the service
+As a developer or for debugging purposes, you can enable port forwarding for local access as follows.
+
+```
+kubectl port-forward --namespace monitoring service/realopinsight-ui 4583:80
+```
+
+For production access, typically for operations monitoring, you must have to consider the Ingress policies defined in your organization. Contact your IT staff for additional information.
+

.idea/realopinsight.iml

@@ -0,0 +1,21 @@
+
+# Deploy RealOpInsight on Docker
+This document describes how to deploy RealOpInsight on a Docker machine.
+
+## Start the container
+The following command shall pull the image and start an instance in background (`-d`). You can remove this option to start the instance in foreground.
+
+With this command the data of the instance will be stored locally on the Docker machine at the specified path (value of option `--volume`, can be changed if needed).
+
+```
+docker run -d \
+    --name realopinsight \
+    --network host \
+    --volume $HOME/.realopinsight:/opt/realopinsight \
+    rchakode/realopinsight
+```
+
+## Accessing the service
+Once the container started, it shall enable the following endpoints:
+ * Web UI: `http://localhost:4583/ui`.
+ * Prometheus metrics: `http://localhost:4584/metrics`.

.idea/runConfigurations.xml

@@ -0,0 +1,14 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+namespace: monitoring
+
+resources:
+  - resources/realopinsight-config.yaml
+  - resources/realopinsight-rbac.yaml
+  - resources/realopinsight-app.yaml
+  - resources/realopinsight-tests.yaml
+images:
+  - name: realopinsight
+    newName: rchakode/realopinsight
+    newTag: 22.02.0

.idea/vcs.xml

@@ -0,0 +1,129 @@
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: realopinsight
+  labels:
+    app.kubernetes.io/name: realopinsight
+    app.kubernetes.io/instance: realopinsight
+    app: realopinsight
+spec:
+  type: ClusterIP
+  ports:
+    - name: http-ui
+      protocol: TCP
+      port: 80
+      targetPort: 4583
+    - name: http-metrics
+      protocol: TCP
+      port: 4584
+      targetPort: 4584
+  selector:
+    app.kubernetes.io/name: realopinsight
+    app.kubernetes.io/instance: realopinsight
+---
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: realopinsight
+  labels:
+    app.kubernetes.io/name: realopinsight
+    app.kubernetes.io/instance: realopinsight
+    app: realopinsight
+spec:
+  replicas: 1
+  serviceName: realopinsight
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: realopinsight
+      app.kubernetes.io/instance: realopinsight
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: realopinsight
+        app.kubernetes.io/instance: realopinsight
+    spec:
+      securityContext:
+        runAsUser: 54583
+        fsGroup: 54583
+      serviceAccountName: realopinsight
+      restartPolicy: Always
+      containers:
+        - name: realopinsight
+          image: "rchakode/realopinsight"
+          imagePullPolicy: Always
+          env:
+            - name: "REALOPINSIGHT_DATA_DIR"
+              valueFrom:
+                configMapKeyRef:
+                  key: REALOPINSIGHT_DATA_DIR
+                  name: realopinsight-config
+            - name: "REALOPINSIGHT_DB_NAME"
+              valueFrom:
+                configMapKeyRef:
+                  key: REALOPINSIGHT_DB_NAME
+                  name: realopinsight-config   
+            - name: "REALOPINSIGHT_DB_PASSWORD"
+              valueFrom:
+                configMapKeyRef:
+                  key: REALOPINSIGHT_DB_PASSWORD
+                  name: realopinsight-config  
+            - name: "REALOPINSIGHT_DB_SERVER_ADDR"
+              valueFrom:
+                configMapKeyRef:
+                  key: REALOPINSIGHT_DB_SERVER_ADDR
+                  name: realopinsight-config  
+            - name: "REALOPINSIGHT_DB_SERVER_PORT"
+              valueFrom:
+                configMapKeyRef:
+                  key: REALOPINSIGHT_DB_SERVER_PORT
+                  name: realopinsight-config
+            - name: "REALOPINSIGHT_DB_TYPE"
+              valueFrom:
+                configMapKeyRef:
+                  key: REALOPINSIGHT_DB_TYPE
+                  name: realopinsight-config
+            - name: "REALOPINSIGHT_DB_USER"
+              valueFrom:
+                configMapKeyRef:
+                  key: REALOPINSIGHT_DB_USER
+                  name: realopinsight-config
+            - name: "REALOPINSIGHT_ROOT_DIR"
+              valueFrom:
+                configMapKeyRef:
+                  key: REALOPINSIGHT_ROOT_DIR
+                  name: realopinsight-config
+          ports:
+            - name: http-ui
+              containerPort: 4583
+              protocol: TCP
+            - name: http-metrics
+              containerPort: 4584
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /ui
+              port: http-ui
+          readinessProbe:
+            httpGet:
+              path: /ui
+              port: http-ui
+          resources:
+            {}
+          volumeMounts:
+            - mountPath: /data
+              name: data-vol
+            - mountPath: /opt/realopinsight/etc
+              name: config-data-vol
+      volumes:
+      - name: config-data-vol
+        emptyDir: {}
+  volumeClaimTemplates:
+  - metadata:
+      name: data-vol
+    spec:
+      accessModes:
+        - ReadWriteOnce
+      resources:
+        requests:
+          storage: 1Gi