Userguide update (#135)

* 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
* Feature/zabbix (#110)
* Documentation links fix (#95)
* fix the password to connect to Adminer (#99)
* Update logging doc  (#103)

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]>

* Simplified description

* Remove outdated Helm architecture schema

* Delete helm-architecture.png

* removed erroneous dashboard link, added troubleshooting guidance (logs howto and FAQ link)

* Add kubectl logs/events guidance to bug report template

* FAQ: add logs/debug instructions, change FADI acronym explanation, add links to how to extend FADI

* Delete helm/tiller directory

* Add ingress note in FAQ, fixes #121

* typo

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]>

Author: 4 people

.github/ISSUE_TEMPLATE/bug_report.md

@@ -21,7 +21,7 @@ A clear and concise description of what the bug is.
 Provide the environment in which the bug has happened (minikube on a workstation, full fledged Kubernetes cluster, ...)
 
 * **OS** (e.g. from `/etc/os-release`)
-* **VM driver** (e.g. cat ~/.minikube/machines/minikube/config.json | grep DriverName)
+* **VM driver** (e.g. `cat ~/.minikube/machines/minikube/config.json | grep DriverName`)
 * **Minikube version** (e.g. `minikube version`)
 
 **What happened**:
@@ -34,6 +34,14 @@ Provide the environment in which the bug has happened (minikube on a workstation
 
 **Output of `minikube logs` (if applicable)**:
 
+**Output of Kubectl for pods, events**
+
+```bash
+kubectl get events --all-namespaces
+kubectl get events -n fadi
+kubectl get pods -n fadi
+kubectl logs fadi-nifi
+```
 
 **Anything else we need to know**:
 

FAQ.md

@@ -10,9 +10,13 @@ FAQ - Frequently asked questions
 
 In case you encounter an issue with FADI, have a feature request or any other question, feel free to [open an issue](https://github.com/cetic/fadi/issues/new/choose).
 
+## How can I extend FADI
+
+FADI relies on Helm to integrate the various service together. To add another service to the stack, you can package it inside a [Helm chart](https://helm.sh/docs/howto/) and [add it to your own FADI chart](helm/README.md).
+
 ## Why "FADI"?
 
-FADI is the acronym for "Framework d'Analyse de Données Industrielles" ("A Framework for Industrial Data Analysis")
+FADI is the acronym for "Framework for Automating the Deployment and orchestration of container-based Infrastructures"
 
 ## FADI is not working
 
@@ -22,7 +26,15 @@ Please make sure the following steps have been taken beforehand:
 
 * update Minikube to the latest version
 * update Helm to the latest version
-* check the logs (`minikube logs`) for any suspicious error message
+* check the logs for any suspicious error message:
+
+```bash
+minikube logs
+kubectl get events --all-namespaces
+kubectl get events -n fadi
+kubectl get pods -n fadi
+kubectl logs fadi-nifi
+```
 
 ## OSx - slow installation
 
@@ -41,6 +53,8 @@ See
 * [doc/REVERSEPROXY.md](doc/REVERSEPROXY.md) for the reverse proxy configuration guide 
 * https://github.com/cetic/fadi/issues/81 for port forwarding instructions
 
+In a Minikube setting, make sure the ingress plugin is enabled (`minikube addons enable ingress`), and populate your `/etc/hosts` file accordingly.
+
 ## How to configure Kubernetes Storage Class?
 
 If you encounter the error `pod has unbound PersistentVolumeClaims`, make sure you have a **default StorageClass** in your cluster.
@@ -79,4 +93,4 @@ kubectl patch storageclass local-path -p '{"metadata": {"annotations":{"storagec
 See also:
 
  * Kubernetes official documentation on storage classes: https://kubernetes.io/docs/concepts/storage/storage-classes/
- * https://github.com/cetic/helm-fadi/issues/15
+ * https://github.com/cetic/helm-fadi/issues/15

INSTALL.md

@@ -26,8 +26,6 @@ The deployment of the FADI stack is achieved with:
 * [Helm v3](https://helm.sh/).
 * [Kubernetes](https://kubernetes.io/).
 
-![](doc/images/architecture/helm-architecture.png)
-
 ## 1. Local installation
 
 This type of installation provides a quick way to test the platform, and also to adapt it to your needs.
@@ -70,7 +68,7 @@ To get the Kubernetes dashboard, type:
 minikube dashboard
 ```
 
-This will open a browser window with the [Kubernetes Dashboard](http://127.0.0.1:40053/api/v1/namespaces/kube-system/services/http:kubernetes-dashboard:/proxy/), it should look like this:
+This will open a browser window with the Kubernetes Dashboard:
 
 ![Minikube initial dashboard](doc/images/installation/minikube_dashboard.png)
 
@@ -195,7 +193,16 @@ It is also possible to create the Kubernetes cluster in command line, see: https
 ## 4. Troubleshooting
 
 * Installation logs are located in the `helm/deploy.log` file.
-* Enable local monitoring in minikube: `minikube addons enable metrics-server`
+* Check the Minikube and Kubernetes logs:
+```bash
+minikube logs
+kubectl get events --all-namespaces
+kubectl get events -n fadi
+kubectl get pods -n fadi
+kubectl logs fadi-nifi-xxxxx -n fadi
+```
+* Enable [metrics server](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-metrics-pipeline/#metrics-server) in minikube: `minikube addons enable metrics-server`
+* The [FAQ](FAQ.md) provides some guidance on common issues
 * For Windows users, please refer to the following [issue](https://github.com/cetic/fadi/issues/55).
 
 ## 5. Continuous integration (CI) and deployment (CD)

README.md

@@ -8,10 +8,7 @@
 
 ## What is FADI?
 
-FADI is a Cloud Native platform for Big Data based on mature open source tools.
-The FADI project is dedicated to making the deployment of Big Data tools simple, portable and scalable. 
-The goal is to provide a straightforward way to deploy open-source systems for Big Data to various infrastructures (private and public clouds). 
-Anywhere you can run [Kubernetes](https://kubernetes.io/), you should be able to run FADI.
+The purpose of FADI is to provide a straightforward way to deploy integrated and modular Big Data systems to various infrastructures (private and public clouds). FADI relies on the [Kubernetes](https://kubernetes.io/) container orchestration engine for portability and scalability.
 
 ![FADI carousel](doc/images/carousel/carousel.gif)
 
@@ -70,4 +67,4 @@ This project follows the [all-contributors](https://github.com/all-contributors/
 You can find out more about FADI on the [CETIC website](https://cetic.be/FADI)
 
 ## License
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcetic%2Ffadi.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcetic%2Ffadi?ref=badge_large)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcetic%2Ffadi.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcetic%2Ffadi?ref=badge_large)