Monitoring and various documentation fixes (#111)

* Update INSTALL.md * CI/CD with minikube * ldap documentation elastic-stack ldap documentation * Details on JHub LDAP documentation * typo in jhub ldap doc * Helm 3 - Remove deprecated tiller ref, updated traefik install version * Deprecate tiller (doc update) * Feature/zabbix (#110) * Documentation links fix (#95) * fix the password to connect to Adminer (#99) * Update logging doc (#103) * Update INSTALL.md * CI/CD with minikube * ldap documentation elastic-stack ldap documentation * Details on JHub LDAP documentation * typo in jhub ldap doc Co-authored-by: Sebastien Dupont <[email protected]> * Zabbix doc: cetic/helm-fadi#27 * Update LOGGING.md Co-authored-by: Sebastien Dupont <[email protected]> Co-authored-by: Alexandre Nuttinck <[email protected]> Co-authored-by: Faiez Zalila <[email protected]> * update zabbix service name * fix #105 (#115) Co-authored-by: Amen Ayadi <[email protected]> Co-authored-by: Amen AYADI <[email protected]> Co-authored-by: Alexandre Nuttinck <[email protected]> Co-authored-by: Faiez Zalila <[email protected]>
cetic · Mar 31, 2020 · ae0b32b · ae0b32b
1 parent a9a6d69
commit ae0b32b
Show file tree

Hide file tree

Showing 8 changed files with 525 additions and 460 deletions.
diff --git a/doc/LOGGING.md b/doc/LOGGING.md
@@ -43,9 +43,7 @@ To create the index pattern and monitor the logs, follow these simple steps:
 
 For more details you can always visit the [Elastic-stack official documentation](https://www.elastic.co/guide/index.html).
 
-
 ### LDAP Authentication 
-================
 
 KIBANA is not compatible with ldap which means it can't be linked directly, to authenticate against the ldap server before accessing KIBANA we're using [nginx-ldap-auth](https://github.com/nginxinc/nginx-ldap-auth).
 > The nginx-ldap-auth software is a reference implementation of a method for authenticating users who request protected resources from servers proxied by NGINX Plus. It includes a daemon (ldap-auth) that communicates with an authentication server which is in this case OpenLDAP.
@@ -55,5 +53,5 @@ The kibana service isn't accessible directly, to get to it you have to access ng
 ```
 minikube service fadi-nginx-ldapauth-proxy
 ```
-for more info: [nginx plus authenticate users](https://www.nginx.com/blog/nginx-plus-authenticate-users/).
 
+For more informations, see this blog post: [nginx plus authenticate users](https://www.nginx.com/blog/nginx-plus-authenticate-users/).
diff --git a/doc/MONITORING.md b/doc/MONITORING.md
@@ -0,0 +1,64 @@
+Montoring
+==========
+
+<p align="left";>
+	<a href="https://www.elastic.co" alt="elk">
+	    <img src="images/logos/zabbix_logo.png" align="center" alt="ELK logo" width="200px" />
+    </a>
+</p>
+
+**[ZABBIX](https://www.zabbix.com)** Zabbix is an open-source monitoring software tool for diverse IT components, including networks, servers, virtual machines and cloud services. Zabbix provides monitoring metrics, among others network utilization, CPU load and disk space consumption.
+
+## Zabbix components
+
+### Zabbix Server
+
+Zabbix server is the central process of Zabbix software.
+
+The server performs the polling and trapping of data, it calculates triggers, sends notifications to users. It is the central component to which Zabbix agents and proxies report data on availability and integrity of systems. The server can itself remotely check networked services (such as web servers and mail servers) using simple service checks.
+
+### Zabbix Agent
+
+Zabbix agent is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).
+
+### Zabbix Web ( frontend )
+
+Zabbix web interface is a part of Zabbix software. It is used to manage resources under monitoring and view monitoring statistics.
+
+### Zabbix Proxy 
+
+Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
+
+## How to use
+
+Make sure to enable zabbix in the `values.yaml` file, then to access the front-end use the following command:
+
+```
+minikube service fadi-zabbix-web
+```
+
+The default username/password are `Admin`/`zabbix`, once connected make sure the zabbix-server is working on the global view, to see the received metrics ( or graphs ) head to the tab `Latest data` under `monitoring` and then click on select on **host groups** and **hosts** and choose your `zabbix servers`.
+
+![zabbix](images/carousel/zabbix.gif)
+
+## LDAP Authentication 
+
+
+By default, internal [Zabbix authentication](https://www.zabbix.com/documentation/4.0/manual/web_interface/frontend_sections/administration/authentication) is used globally. To change to LDAP - select LDAP as Default authentication and enter **authentication details** in the LDAP settings tab. 
+
+The default **authentication details** for FADI:
+
+```
+LDAP host: fadi-openldap
+Port: 389
+Base DN: dc=ldap,dc=cetic,dc=be
+Search attribute: cn
+Bind DN: cn=admin,dc=ldap,dc=cetic,dc=be
+Bind password: password1
+User password: password1
+```
+
+
+![zabbix](images/carousel/zabbix-auth.gif)
+
+For more details you can always go to: [Zabbix Documentation 4.0](https://www.zabbix.com/documentation/4.0/manual/introduction).
diff --git a/doc/REVERSEPROXY.md b/doc/REVERSEPROXY.md
@@ -34,10 +34,10 @@ kubectl get clusterrole traefik-ingress-controller 2> /dev/null || kubectl creat
 
 Take a look at the [sample file](/helm/traefik/rbac-config.yaml).
 
-Then, you can install Traefik with Helm: (If you want further information, you can follow this [tutorial](https://docs.traefik.io/v1.3/user-guide/kubernetes/#deploy-trfik-using-helm-chart))
+Then, you can install Traefik with Helm: (If you want further information, you can follow this [tutorial](https://docs.traefik.io/v1.7/user-guide/kubernetes/#deploy-traefik-using-helm-chart))
 
 ```
-helm upgrade --install traefik stable/traefik -f ./traefik/values.yaml --namespace kube-system --tiller-namespace tiller
+helm upgrade --install traefik stable/traefik -f ./traefik/values.yaml --namespace kube-system
 ```
 
 The values file can be found [here](/helm/traefik/values.yaml).
@@ -81,4 +81,4 @@ grafana:
 
 You should now be able to access Grafana through the domain name you have chosen: `http(s)://grafana.yourdomain.com`
 
-Next you will also want to configure SSL access to your services. For that, have a look at the [security documentation](/doc/SECURITY.md). 
+Next you will also want to configure SSL access to your services. For that, have a look at the [security documentation](/doc/SECURITY.md). 
diff --git a/doc/images/carousel/zabbix-auth.gif b/doc/images/carousel/zabbix-auth.gif
diff --git a/doc/images/carousel/zabbix.gif b/doc/images/carousel/zabbix.gif
diff --git a/doc/images/logos/zabbix_logo.png b/doc/images/logos/zabbix_logo.png