From 8eee28b05ce24cf611c9ec8fe74887474c376a17 Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Tue, 14 Dec 2021 11:37:18 +0100 Subject: [PATCH 01/13] Update USERGUIDE.md documenting the port forward command pour adminer/phpldapadmin removing 'minikube service' commands adding the minikube tunnel creation adding link for doc to update hosts files (linux, mac, windows) --- USERGUIDE.md | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/USERGUIDE.md b/USERGUIDE.md index 3dfb576..f1b9930 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -31,6 +31,12 @@ Those components are configured in the following [sample config file](helm/value The following instructions assume that you deployed FADI on your workstation inside minikube. +To access services through domain names, open a new terminal and enter this command to give `traefik` an external IP address: +``` +minikube tunnel +``` +Don't forget to update your `hosts` file with the `traefik` external IP address. You can find [here](https://phoenixnap.com/kb/how-to-edit-hosts-file-in-windows-mac-or-linux) a user gide for Linux, Mac and Windows. + Unless specified otherwise, all services can be accessed using the username and password pair: `admin` / `password1` , see the [user management documentation](doc/USERMANAGEMENT.md) for detailed information on how to configure user identification and authorization (LDAP, RBAC, ...). See the [logs management documentation](doc/LOGGING.md) for information on how to configure the management of the various service logs. @@ -43,10 +49,14 @@ First, setup the datalake by creating a table in the postgresql database. To achieve this you need to: -* Head to the adminer interface, if you are using **minikube**, you can use the following command : +* Head to the adminer interface + + * if you want to create a **traefik ingress**, you can follow this [guide](doc/REVERSEPROXY.md#2-configure-the-various-services-to-use-traefik) + * else, you can use a port-forwarding to access the interface: ``` -minikube service -n fadi fadi-adminer +kubectl port-forward service/fadi-adminer 8080:80 ``` + Now you can access `adminer` from your browser by taping: `localhost:8080` * Access to the adminer service and to the postgreSQL database using the following credentials: @@ -99,9 +109,9 @@ measure_ts,temperature (...) ``` -To start, head to the Nifi web interface, if you are using **minikube**, you can use the following command : +To start, head to the Nifi web interface, tape in your browser the `nifi.traefikIngress.host`. E.g. : ``` -minikube service -n fadi fadi-nifi +http(s)://nifi.test.local ``` ![Nifi web interface](examples/basic/images/nifi_interface.png) @@ -189,9 +199,9 @@ Once the measurements are stored in the database, we will want to display the re [Grafana](http://grafana.com/) provides a dashboard and alerting interface. -Head to the Grafana interface, if you are using **minikube**, you can use the following command : +Head to the Grafana web interface by taping in your browser the `grafana.traefikIngress.host`. E.g. : ``` -minikube service -n fadi fadi-grafana +http(s)://grafana.test.local ``` (the default credentials are `admin`/`password1`) @@ -244,9 +254,9 @@ For more information on how to use Grafana, see the [official Grafana user guide [Apache Superset](https://superset.incubator.apache.org) provides some interesting features to explore your data and build basic dashboards. -Head to the Superset interface, if you are using **minikube**, you can use the following command : +Head to the Superset web interface by taping in your browser the `superset.traefikIngress.host`. E.g. : ``` -minikube service -n fadi fadi-superset +http(s)://superset.test.local ``` (the default credentials are `admin`/`password1`): @@ -312,10 +322,15 @@ For more information on how to use Superset, see the [official Superset user gui In this simple use case, we will try to access the data that is stored in the data lake. -Head to the Jupyter notebook interface, if you are using **minikube**, you can use the following command : +* Head to the Jupyter notebook interface + + * if you want to create a **traefik ingress**, you can follow this [guide](doc/REVERSEPROXY.md#2-configure-the-various-services-to-use-traefik) + * else, you can use a port-forwarding to access the interface: +``` +kubectl port-forward service/proxy-public 8081:80 ``` -minikube service -n fadi proxy-public -``` + Now you can access `adminer` from your browser by taping: `localhost:8081` + Then, you can login using the default credentials `admin`/`password1`. A Jupyter dashboard is shown. From bfe31a8219623ac6838641ac98ec015fe92684b9 Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Mon, 20 Dec 2021 10:21:04 +0100 Subject: [PATCH 02/13] Update USERMANAGEMENT.md --- doc/USERMANAGEMENT.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/USERMANAGEMENT.md b/doc/USERMANAGEMENT.md index 1c99b32..f590530 100644 --- a/doc/USERMANAGEMENT.md +++ b/doc/USERMANAGEMENT.md @@ -123,15 +123,15 @@ auth: userIdentityAttribute: cn ``` -Then we make sure to pre-set the `nodePort`, let's say we want the node port to be 34567, our service configuration should look like this : +Then we make sure to pre-set the `traefikIngress`, let's say we want the domain name `nifi.example.cetic.be`, our `traefikIngress` configuration should look like this : ```yaml -service: - type: NodePort - nodePort: 34567 +traefikIngress: + enabled: true + host: nifi.example.cetic.be ``` -And then we set the properties as follows, the `nifi.properties.webProxyHost` variable should have the exact url with the exact port that we are going to use to access NIFI later, if our dns is nifi.example.cetic.be and/or the ip address 10.10.10.10, our configuration should look like this: +And then we set the properties as follows, the `nifi.properties.webProxyHost` variable should have the exact url that we are going to use to access NIFI later, if our dns is nifi.example.cetic.be, our configuration should look like this: ```yaml @@ -140,7 +140,7 @@ And then we set the properties as follows, the `nifi.properties.webProxyHost` va isNode: false httpPort: null httpsPort: 9443 - webProxyHost: nifi.example.cetic.be:34567, 10.10.10.10:34567 + webProxyHost: nifi.example.cetic.be clusterPort: 6007 clusterSecure: true ``` @@ -209,13 +209,13 @@ We can no longer see the name of the group, and we now have a more restrictive c > "phpLDAPadmin is a web app for administering Lightweight Directory Access Protocol (LDAP) servers." -In order to use [phpLDAPadmin](http://phpldapadmin.sourceforge.net/wiki/index.php/Main_Page), pass the configuration for the LDAP server through the environmental variable `_PHPLDAPADMIN_LDAP_HOSTS_`. To connect this service with the OpenLDAP server, pass **the name of the service** (`fadi-openldap`). To connect to the web application, run the following command: +In order to use [phpLDAPadmin](http://phpldapadmin.sourceforge.net/wiki/index.php/Main_Page), pass the configuration for the LDAP server through the environmental variable `_PHPLDAPADMIN_LDAP_HOSTS_`. To connect this service with the OpenLDAP server, pass **the name of the service** (`fadi-openldap`). To connect to the web application, run the following command in a separate shell: ```bash -minikube service fadi-phpldapadmin -n fadi +kubectl port-forward service/fadi-phpldapadmin 8080:80 ``` -The main page for phpLDAPadmin will open in your default browser where you can connect to your LDAP server and manage it. +Now, tape `loaclhost:8080` in your browser to access the main page of phpLDAPadmin where you can connect to your LDAP server and manage it. phpdapadmin From cd4338c584d86e309db19aa129e1538ada6026d3 Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Mon, 20 Dec 2021 10:41:50 +0100 Subject: [PATCH 03/13] Update INSTALL.md --- INSTALL.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index f0e9868..39da11f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -86,13 +86,11 @@ cd fadi Launch the Helm script, this will deploy all the FADI services on the Minikube cluster (and may take some time). ```bash -kubectl config set-context minikube -minikube addons enable ingress cd helm # you can edit values.yaml file to customise the stack ./deploy.sh # specify the fadi namespace to see the different pods -kubectl config set-context minikube --namespace fadi +kubectl get pods --namespace fadi ``` You can check everything is deploying/-ed in the Kubernetes dashboard: @@ -117,13 +115,15 @@ kubectl get pods To access a service in your browser, type for instance: ``` -minikube service -n fadi fadi-nifi +kubectl port-forward service/fadi-grafana 8080:80 ``` +Then, you can access the service by typing in your browser `localhost:8080 +` You can list all the addresses by typing: ``` -kubectl get ingress -n fadi +kubectl get ingressroute -n fadi ``` To update the FADI stack, re-type: From f3416df9abf3caccace58f55832eb97f59722af1 Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Mon, 20 Dec 2021 10:44:30 +0100 Subject: [PATCH 04/13] Update deploy.sh --- helm/deploy.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/helm/deploy.sh b/helm/deploy.sh index 96702f6..3cdf195 100755 --- a/helm/deploy.sh +++ b/helm/deploy.sh @@ -22,6 +22,7 @@ helm repo add cetic https://cetic.github.io/helm-charts/ --force-update helm repo update # install/upgrade FADI +helm dep up helm upgrade --install ${NAMESPACE} cetic/fadi -f ./values.yaml --namespace ${NAMESPACE} printf "\n\nInstallation successful!\n" From ca61dd6391caa459799bce9e16c8e6b0e2c50e9d Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Mon, 20 Dec 2021 10:46:49 +0100 Subject: [PATCH 05/13] Update USERGUIDE.md --- USERGUIDE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/USERGUIDE.md b/USERGUIDE.md index f1b9930..71e8cc9 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -19,6 +19,7 @@ In this simple example, we will ingest temperature measurements from sensors, st To install the FADI framework on your workstation or on a cloud, see the [installation instructions](INSTALL.md). + The components needed for this use case are the following: * Apache Nifi as a integration tool to ingest the sensor data from the data source (a csv file in this case) and store it in the database @@ -109,7 +110,7 @@ measure_ts,temperature (...) ``` -To start, head to the Nifi web interface, tape in your browser the `nifi.traefikIngress.host`. E.g. : +To start, head to the Nifi web interface, type in your browser the `nifi.traefikIngress.host`. E.g. : ``` http(s)://nifi.test.local ``` From eac82610aece0c14c5757e92010312d204d655ad Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Mon, 20 Dec 2021 10:47:46 +0100 Subject: [PATCH 06/13] Update USERMANAGEMENT.md --- doc/USERMANAGEMENT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/USERMANAGEMENT.md b/doc/USERMANAGEMENT.md index f590530..8e42b4f 100644 --- a/doc/USERMANAGEMENT.md +++ b/doc/USERMANAGEMENT.md @@ -215,7 +215,7 @@ In order to use [phpLDAPadmin](http://phpldapadmin.sourceforge.net/wiki/index.ph kubectl port-forward service/fadi-phpldapadmin 8080:80 ``` -Now, tape `loaclhost:8080` in your browser to access the main page of phpLDAPadmin where you can connect to your LDAP server and manage it. +Now, type `loaclhost:8080` in your browser to access the main page of phpLDAPadmin where you can connect to your LDAP server and manage it. phpdapadmin From f94ff7cc3ba4076e4539947800e599662758a0b0 Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Wed, 5 Jan 2022 14:37:09 +0100 Subject: [PATCH 07/13] Update INSTALL.md --- INSTALL.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 39da11f..bbf7fc2 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -89,8 +89,6 @@ Launch the Helm script, this will deploy all the FADI services on the Minikube c cd helm # you can edit values.yaml file to customise the stack ./deploy.sh -# specify the fadi namespace to see the different pods -kubectl get pods --namespace fadi ``` You can check everything is deploying/-ed in the Kubernetes dashboard: @@ -117,8 +115,7 @@ To access a service in your browser, type for instance: ``` kubectl port-forward service/fadi-grafana 8080:80 ``` -Then, you can access the service by typing in your browser `localhost:8080 -` +Then, you can access the service by typing in your browser [localhost:8080](http://loacalhost:8080) You can list all the addresses by typing: From 2c98c983e4552d197c65bb1accbb4da181b0f9af Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Wed, 5 Jan 2022 14:52:40 +0100 Subject: [PATCH 08/13] Update USERGUIDE.md --- USERGUIDE.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/USERGUIDE.md b/USERGUIDE.md index 71e8cc9..e9152f9 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -19,7 +19,6 @@ In this simple example, we will ingest temperature measurements from sensors, st To install the FADI framework on your workstation or on a cloud, see the [installation instructions](INSTALL.md). - The components needed for this use case are the following: * Apache Nifi as a integration tool to ingest the sensor data from the data source (a csv file in this case) and store it in the database @@ -32,7 +31,7 @@ Those components are configured in the following [sample config file](helm/value The following instructions assume that you deployed FADI on your workstation inside minikube. -To access services through domain names, open a new terminal and enter this command to give `traefik` an external IP address: +To access services through domain names, open a new terminal and enter this command to give `Traefik` an external IP address: ``` minikube tunnel ``` @@ -55,9 +54,9 @@ To achieve this you need to: * if you want to create a **traefik ingress**, you can follow this [guide](doc/REVERSEPROXY.md#2-configure-the-various-services-to-use-traefik) * else, you can use a port-forwarding to access the interface: ``` -kubectl port-forward service/fadi-adminer 8080:80 +kubectl port-forward service/fadi-adminer 8081:80 ``` - Now you can access `adminer` from your browser by taping: `localhost:8080` + Now you can access `Adminer` from your browser by typing: [localhost:8081](http://localhost:8081) * Access to the adminer service and to the postgreSQL database using the following credentials: @@ -111,9 +110,8 @@ measure_ts,temperature ``` To start, head to the Nifi web interface, type in your browser the `nifi.traefikIngress.host`. E.g. : -``` -http(s)://nifi.test.local -``` + +[http://nifi.test.local](http://nifi.test.local) ![Nifi web interface](examples/basic/images/nifi_interface.png) @@ -200,10 +198,10 @@ Once the measurements are stored in the database, we will want to display the re [Grafana](http://grafana.com/) provides a dashboard and alerting interface. -Head to the Grafana web interface by taping in your browser the `grafana.traefikIngress.host`. E.g. : -``` -http(s)://grafana.test.local -``` +Head to the Grafana web interface by typing in your browser the `grafana.traefikIngress.host`. E.g. : + +[http://grafana.test.local](http://grafana.test.local) + (the default credentials are `admin`/`password1`) ![Grafana web interface](examples/basic/images/grafana_interface.png) @@ -255,10 +253,10 @@ For more information on how to use Grafana, see the [official Grafana user guide [Apache Superset](https://superset.incubator.apache.org) provides some interesting features to explore your data and build basic dashboards. -Head to the Superset web interface by taping in your browser the `superset.traefikIngress.host`. E.g. : -``` -http(s)://superset.test.local -``` +Head to the Superset web interface by typing in your browser the `superset.traefikIngress.host`. E.g. : + +[http://superset.test.local](http://superset.test.local) + (the default credentials are `admin`/`password1`): First we will define the datasource: @@ -330,7 +328,7 @@ In this simple use case, we will try to access the data that is stored in the da ``` kubectl port-forward service/proxy-public 8081:80 ``` - Now you can access `adminer` from your browser by taping: `localhost:8081` + Now you can access `Adminer` from your browser by typing: [localhost:8081](http://localhost:8081) Then, you can login using the default credentials `admin`/`password1`. From 98cf73bd68e0bbaa11f08df688532c64af5de894 Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Wed, 5 Jan 2022 14:57:03 +0100 Subject: [PATCH 09/13] Update USERMANAGEMENT.md --- doc/USERMANAGEMENT.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/USERMANAGEMENT.md b/doc/USERMANAGEMENT.md index 8e42b4f..958e5f2 100644 --- a/doc/USERMANAGEMENT.md +++ b/doc/USERMANAGEMENT.md @@ -123,12 +123,12 @@ auth: userIdentityAttribute: cn ``` -Then we make sure to pre-set the `traefikIngress`, let's say we want the domain name `nifi.example.cetic.be`, our `traefikIngress` configuration should look like this : +Then we make sure to pre-set the `traefikIngress`, let's say we want the domain name `nifi.test.local`, our `traefikIngress` configuration should look like this : ```yaml traefikIngress: enabled: true - host: nifi.example.cetic.be + host: nifi.test.local ``` And then we set the properties as follows, the `nifi.properties.webProxyHost` variable should have the exact url that we are going to use to access NIFI later, if our dns is nifi.example.cetic.be, our configuration should look like this: @@ -212,10 +212,10 @@ We can no longer see the name of the group, and we now have a more restrictive c In order to use [phpLDAPadmin](http://phpldapadmin.sourceforge.net/wiki/index.php/Main_Page), pass the configuration for the LDAP server through the environmental variable `_PHPLDAPADMIN_LDAP_HOSTS_`. To connect this service with the OpenLDAP server, pass **the name of the service** (`fadi-openldap`). To connect to the web application, run the following command in a separate shell: ```bash -kubectl port-forward service/fadi-phpldapadmin 8080:80 +kubectl port-forward service/fadi-phpldapadmin 8082:80 ``` -Now, type `loaclhost:8080` in your browser to access the main page of phpLDAPadmin where you can connect to your LDAP server and manage it. +Now, type [localhost:8082](http://localhost:8082) in your browser to access the main page of phpLDAPadmin where you can connect to your LDAP server and manage it. phpdapadmin From e6b67523913964adedf2c2147bf63458d0032e55 Mon Sep 17 00:00:00 2001 From: Sebastien Dupont Date: Mon, 17 Jan 2022 13:36:01 +0100 Subject: [PATCH 10/13] Doc formatting, typos --- USERGUIDE.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/USERGUIDE.md b/USERGUIDE.md index e9152f9..0b44dd3 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -31,11 +31,11 @@ Those components are configured in the following [sample config file](helm/value The following instructions assume that you deployed FADI on your workstation inside minikube. -To access services through domain names, open a new terminal and enter this command to give `Traefik` an external IP address: +To access services through domain names, open a new terminal and enter this command to give Traefik an external IP address: ``` minikube tunnel ``` -Don't forget to update your `hosts` file with the `traefik` external IP address. You can find [here](https://phoenixnap.com/kb/how-to-edit-hosts-file-in-windows-mac-or-linux) a user gide for Linux, Mac and Windows. +Don't forget to update your `hosts` file with Traefik's external IP address. You can find [here](https://phoenixnap.com/kb/how-to-edit-hosts-file-in-windows-mac-or-linux) a user guide for Linux, Mac and Windows. Unless specified otherwise, all services can be accessed using the username and password pair: `admin` / `password1` , see the [user management documentation](doc/USERMANAGEMENT.md) for detailed information on how to configure user identification and authorization (LDAP, RBAC, ...). @@ -51,14 +51,14 @@ To achieve this you need to: * Head to the adminer interface - * if you want to create a **traefik ingress**, you can follow this [guide](doc/REVERSEPROXY.md#2-configure-the-various-services-to-use-traefik) + * if you want to create a **Traefik ingress**, you can follow this [guide](doc/REVERSEPROXY.md#2-configure-the-various-services-to-use-traefik) * else, you can use a port-forwarding to access the interface: ``` kubectl port-forward service/fadi-adminer 8081:80 ``` - Now you can access `Adminer` from your browser by typing: [localhost:8081](http://localhost:8081) + Now you can access Adminer from your browser at [localhost:8081](http://localhost:8081) -* Access to the adminer service and to the postgreSQL database using the following credentials: +* Access to the Adminer service and to the PostgreSQL database using the following credentials: * System: `PostgreSQL` * Server: `fadi-postgresql` @@ -66,7 +66,7 @@ kubectl port-forward service/fadi-adminer 8081:80 * Password: `password1` * Database: `postgres` -* In the adminer Browser, launch the Query tool by clicking "SQL command". +* In the Adminer Browser, launch the Query tool by clicking "SQL command". * Copy/Paste the [table creation script](examples/basic/create_datalake_tables.sql) in the Query Editor. ![Postgres Server](examples/basic/images/adminer_create_table.png) From 7ccbb1511320d03413f787950e728c3c3e6258a7 Mon Sep 17 00:00:00 2001 From: Sebastien Dupont Date: Mon, 17 Jan 2022 13:43:25 +0100 Subject: [PATCH 11/13] Typos --- USERGUIDE.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/USERGUIDE.md b/USERGUIDE.md index 0b44dd3..8965374 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -52,11 +52,7 @@ To achieve this you need to: * Head to the adminer interface * if you want to create a **Traefik ingress**, you can follow this [guide](doc/REVERSEPROXY.md#2-configure-the-various-services-to-use-traefik) - * else, you can use a port-forwarding to access the interface: -``` -kubectl port-forward service/fadi-adminer 8081:80 -``` - Now you can access Adminer from your browser at [localhost:8081](http://localhost:8081) + * else, you can use a port-forwarding to access the interface: `kubectl port-forward service/fadi-adminer 8081:80` and can access Adminer from your browser at [localhost:8081](http://localhost:8081) * Access to the Adminer service and to the PostgreSQL database using the following credentials: @@ -171,7 +167,7 @@ So, create the following components : ![Nifi Ingest CSV and store in PostgreSQL](examples/basic/images/nifi_csv_to_sql_2.png) -See also [the nifi template](/examples/basic/basic_example_final_template.xml) that corresponds to this example. +See also [the NiFi template](/examples/basic/basic_example_final_template.xml) that corresponds to this example. * To reuse the provided template (instead of designing our own template), you can: * Click `Upload template` in the **Operate** frame, select the template, and upload it. * From the Nifi menu, drag and drop the **Template** menu. @@ -323,12 +319,8 @@ In this simple use case, we will try to access the data that is stored in the da * Head to the Jupyter notebook interface - * if you want to create a **traefik ingress**, you can follow this [guide](doc/REVERSEPROXY.md#2-configure-the-various-services-to-use-traefik) - * else, you can use a port-forwarding to access the interface: -``` -kubectl port-forward service/proxy-public 8081:80 -``` - Now you can access `Adminer` from your browser by typing: [localhost:8081](http://localhost:8081) + * if you want to create a **Traefik ingress**, you can follow this [guide](doc/REVERSEPROXY.md#2-configure-the-various-services-to-use-traefik) + * you can also use a port-forwarding to access the interface `kubectl port-forward service/proxy-public 8081:80` and access the Jupyter dashboard from your browser at [localhost:8081](http://localhost:8081). Then, you can login using the default credentials `admin`/`password1`. From 3f616c266b2ea39d7ce7b472f97095799c049c11 Mon Sep 17 00:00:00 2001 From: Sebastien Dupont Date: Mon, 17 Jan 2022 13:44:34 +0100 Subject: [PATCH 12/13] typo --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index bbf7fc2..396193e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -115,7 +115,7 @@ To access a service in your browser, type for instance: ``` kubectl port-forward service/fadi-grafana 8080:80 ``` -Then, you can access the service by typing in your browser [localhost:8080](http://loacalhost:8080) +Then, you can access the service by typing in your browser [localhost:8080](http://localhost:8080) You can list all the addresses by typing: From b7e2fed1ccb12ccabdc28b58e165709e2234c5f4 Mon Sep 17 00:00:00 2001 From: zakaria2905 <48456087+zakaria2905@users.noreply.github.com> Date: Wed, 19 Jan 2022 13:46:55 +0100 Subject: [PATCH 13/13] Update USERGUIDE.md --- USERGUIDE.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/USERGUIDE.md b/USERGUIDE.md index 8965374..1fbeb99 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -107,7 +107,7 @@ measure_ts,temperature To start, head to the Nifi web interface, type in your browser the `nifi.traefikIngress.host`. E.g. : -[http://nifi.test.local](http://nifi.test.local) +[http://nifi.fadi.cetic.be](http://nifi.fadi.cetic.be) ![Nifi web interface](examples/basic/images/nifi_interface.png) @@ -196,7 +196,7 @@ Once the measurements are stored in the database, we will want to display the re Head to the Grafana web interface by typing in your browser the `grafana.traefikIngress.host`. E.g. : -[http://grafana.test.local](http://grafana.test.local) +[http://grafana.fadi.cetic.be](http://grafana.fadi.cetic.be) (the default credentials are `admin`/`password1`) @@ -251,7 +251,7 @@ For more information on how to use Grafana, see the [official Grafana user guide Head to the Superset web interface by typing in your browser the `superset.traefikIngress.host`. E.g. : -[http://superset.test.local](http://superset.test.local) +[http://superset.fadi.cetic.be](http://superset.fadi.cetic.be) (the default credentials are `admin`/`password1`): @@ -317,10 +317,9 @@ For more information on how to use Superset, see the [official Superset user gui In this simple use case, we will try to access the data that is stored in the data lake. -* Head to the Jupyter notebook interface +Head to the Jupyter notebook interface by typing in your browser the `jupyter.traefikIngress.host`. E.g. : - * if you want to create a **Traefik ingress**, you can follow this [guide](doc/REVERSEPROXY.md#2-configure-the-various-services-to-use-traefik) - * you can also use a port-forwarding to access the interface `kubectl port-forward service/proxy-public 8081:80` and access the Jupyter dashboard from your browser at [localhost:8081](http://localhost:8081). +[http://jupyter.fadi.cetic.be](http://jupyter.fadi.cetic.be) Then, you can login using the default credentials `admin`/`password1`.