diff --git a/README.md b/README.md index b47fe22..2ac0b62 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![License](https://img.shields.io/github/license/fmdlc/ISP-Checker) ![LastCommit](https://img.shields.io/github/last-commit/fmdlc/ISP-Checker) ![Build](https://github.com/fmdlc/ISP-Checker/workflows/Build/badge.svg) ![Docker](https://img.shields.io/badge/Docker-19.03.13-blue) -> A `docker-compose` and `kubernetes` stack to run a set of ISP controls and collect metrics on a [Raspberry Pi](https://www.raspberrypi.org/). +> A `docker-compose` and `kubernetes` stack to run a set of ISP controls and collect metrics on a [Raspberry Pi](https://www.raspberrypi.org/) or `amd64` architecture. [![Linkedin](https://i.stack.imgur.com/gVE0j.png) LinkedIn](https://www.linkedin.com/in/fmdlc) [![GitHub](https://i.stack.imgur.com/tskMh.png) GitHub](https://github.com/fmdlc) @@ -46,7 +46,7 @@ You can easily import this dashboard into your current Grafana installation gett ### kubernetes Kubernetes is in `beta` version. To install just run: ```bash -$: kubectl apply -f https://raw.githubusercontent.com/fmdlc/ISP-Checker/master/kubernetes/ISP-Checker-deploy.yaml +$ kubectl apply -f https://raw.githubusercontent.com/fmdlc/ISP-Checker/master/kubernetes/ISP-Checker-deploy.yaml ``` You need to expose the `grafana` service to get access. You can do it by creating a `LoadBalancer` service type or by using an `IngressController`. @@ -58,7 +58,6 @@ It's a super useful dashboard to monitor Hardware and Operating system stadistic - For detailed Kubernetes instructions check: [here](https://github.com/fmdlc/ISP-Checker/blob/master/kubernetes/README.md). ### Configuration @@ -70,7 +69,7 @@ $ curl -fsSL https://get.docker.com -o get-docker.sh | bash - You need to have `docker-compose` installed. To install it execute: ```bash -$: sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose +$ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose ``` Alternatively you can install it using `pip`: @@ -84,7 +83,7 @@ There are two users: * Read and Write user: Used by Telegraf to write metrics into the InfluxDB Database. ```bash -$: cat ./ISP-Checker/credentials.env +$: cat ./docker-compose/credentials.env #-------------------------------------------------- # Setup here credentials for InfluxDB and Telegraf @@ -103,11 +102,12 @@ INFLUXDB_READ_USER_PASSWORD=VerySecurePassword If your primary interface is not named `eth0` please take note of the right name and update it on demand by running the following command: ``` -~/ISP_monitor/ISP-Checker$: sed -i 's/eth0//gi' grafana/network-dashboard.json +$ sed -i 's/eth0//gi' docker-compose/grafana/network-dashboard.json ``` + For example, if your Interface is called `wlan0`: ```bash -~/ISP_monitor/ISP-Checker$: sed -i 's/eth0/wlan0/gi' grafana/network-dashboard.json +$ sed -i 's/eth0/wlan0/gi' docker-compose/grafana/network-dashboard.json ``` #### Installation @@ -117,7 +117,7 @@ Go to the `./ISP-Checker` directory, see the Makefile on this directory. $: make USAGE: make - - install : Bootstrap components in `docker-compose`. + - install : Bootstrap components in docker-compose. - kube-install: Bootstrap components in k8s cluster. - start : Start entire stack. - stop : Stops entire stack. diff --git a/img/img_4.png b/img/img_4.png index 22011ab..b18c980 100644 Binary files a/img/img_4.png and b/img/img_4.png differ diff --git a/img/pods.svg b/img/pods.svg deleted file mode 100644 index 4879a8e..0000000 --- a/img/pods.svg +++ /dev/null @@ -1,668 +0,0 @@ - - - - - - - - -cluster_192.168.0.200 - -192.168.0.200 - - -cluster_namespace_monitoring - -monitoring - - - -03bb06ee-3478-47de-a239-4ae5f8b31f08 - -Pod - -telegraf-dbsct - - - -7ee48df0-1e53-2f28-634a-283b31b48598 - -Container - -telegraf - - - -03bb06ee-3478-47de-a239-4ae5f8b31f08->7ee48df0-1e53-2f28-634a-283b31b48598 - - - - - -0c9eed70-f8b2-408a-a70a-865da103a5ff - -CronJob - -telefraf-mtr - - - -0ddc1c7d-49c2-4d22-b08f-f840d61032c1 - -ReplicaSet - -grafana-56858b8cc8 - - - -9e72b254-4954-41ad-962d-7ab0b90d6a30 - -Pod - -grafana-56858b8cc8-mpph6 - - - -0ddc1c7d-49c2-4d22-b08f-f840d61032c1->9e72b254-4954-41ad-962d-7ab0b90d6a30 - - - - - -1d221322-0b76-4aa0-9b18-184e78987b56 - -Endpoints - -influxdb-svc - - - -cd88c9c5-70bf-4287-8b28-7c0147076ed8 - -Pod - -influxdb-5d54bb97dc-hwbcb - - - -1d221322-0b76-4aa0-9b18-184e78987b56->cd88c9c5-70bf-4287-8b28-7c0147076ed8 - - - - - -22a5c89c-5015-bcf1-59ac-74bb664198ba - -Container - -telegraf-speedtest - - - -257231a5-5bff-4d64-98df-e9ac70ff1219 - -Endpoints - -grafana-svc - - - -257231a5-5bff-4d64-98df-e9ac70ff1219->9e72b254-4954-41ad-962d-7ab0b90d6a30 - - - - - -2738d264-549b-c4e7-4b21-b12830dc5064 - -Container - -telegraf - - - -3403f7e1-58c9-fd61-519f-236620837808 - -Container - -lb-port-3000 - - - -3465d92a-ab01-6ac0-b3dd-4aa8384263d9 - -Container - -influxdb - - - -425dfdfc-62fa-4c78-be84-c16c2afaa22f - -Pod - -svclb-grafana-svc-vsvlw - - - -d46f328c-1fda-055c-7df9-30dd6394a8b8 - -Container - -lb-port-3000 - - - -425dfdfc-62fa-4c78-be84-c16c2afaa22f->d46f328c-1fda-055c-7df9-30dd6394a8b8 - - - - - -4c69b87b-f38c-97bd-bf89-86f67b5fae91 - -Container - -telegraf-mtr - - - -4d34a878-8dd1-4eb5-a7dc-a3e72cbedbe9 - -Pod - -telegraf-bpbng - - - -4d34a878-8dd1-4eb5-a7dc-a3e72cbedbe9->2738d264-549b-c4e7-4b21-b12830dc5064 - - - - - -4e40c66c-500e-4221-abb8-d2e4b9586cc7 - -Job - -telefraf-speedtest-1603553400 - - - -d00db8a7-f362-4b9c-bb80-d7f82ab60771 - -Pod - -telefraf-speedtest-1603553400-dcbjp - - - -4e40c66c-500e-4221-abb8-d2e4b9586cc7->d00db8a7-f362-4b9c-bb80-d7f82ab60771 - - - - - -53c3d993-7c0f-4c67-bc5c-9a831e380156 - -Pod - -telegraf-g2ljs - - - -7428ea6f-16db-7e88-f676-ead77cee627c - -Container - -telegraf - - - -53c3d993-7c0f-4c67-bc5c-9a831e380156->7428ea6f-16db-7e88-f676-ead77cee627c - - - - - -54ade014-05ab-74b6-dc24-76aa2100c146 - -Container - -telegraf-mtr - - - -54e52f54-9c38-4dc2-b493-4c96c144fbef - -Pod - -telefraf-mtr-1603552800-pfh74 - - - -a5fdb550-74b2-16d8-be44-d3566ab1bcb2 - -Container - -telegraf-mtr - - - -54e52f54-9c38-4dc2-b493-4c96c144fbef->a5fdb550-74b2-16d8-be44-d3566ab1bcb2 - - - - - -57585d76-cf32-47f8-84d0-4d0f857ffb31 - -DaemonSet - -svclb-grafana-svc - - - -57585d76-cf32-47f8-84d0-4d0f857ffb31->425dfdfc-62fa-4c78-be84-c16c2afaa22f - - - - - -8d7ceda2-1e88-43d6-922b-0a2e97641c45 - -Pod - -svclb-grafana-svc-n4xxx - - - -57585d76-cf32-47f8-84d0-4d0f857ffb31->8d7ceda2-1e88-43d6-922b-0a2e97641c45 - - - - - -9d6ba88a-4d50-44c9-836b-4bbf2007c7fd - -Pod - -svclb-grafana-svc-8pdvf - - - -57585d76-cf32-47f8-84d0-4d0f857ffb31->9d6ba88a-4d50-44c9-836b-4bbf2007c7fd - - - - - -6635b32d-aca5-4247-82fc-d087bbfb6177 - -Secret - -influxdb-datasource-provisioner - - - -6963f53b-bb35-4af1-8ee8-daf47908d71b - -ReplicaSet - -influxdb-5d54bb97dc - - - -6963f53b-bb35-4af1-8ee8-daf47908d71b->cd88c9c5-70bf-4287-8b28-7c0147076ed8 - - - - - -6e84edfa-edf6-4636-bd98-007f031c762a - -Job - -telefraf-mtr-1603553400 - - - -e7ed50a0-3f0f-46ad-87b3-e5560dd7b540 - -Pod - -telefraf-mtr-1603553400-vqfjj - - - -6e84edfa-edf6-4636-bd98-007f031c762a->e7ed50a0-3f0f-46ad-87b3-e5560dd7b540 - - - - - -76027a23-e4d3-4973-969d-434a5b1e7b86 - -ConfigMap - -raspberry-dashboard - - - -842a6ce1-553e-c7cd-4d09-2178ba67026e - -Container - -lb-port-3000 - - - -8cac5625-129f-40a8-908e-169af3406be7 - -ConfigMap - -telegraf-config - - - -8d7ceda2-1e88-43d6-922b-0a2e97641c45->842a6ce1-553e-c7cd-4d09-2178ba67026e - - - - - -8e0e42d8-fcb9-4977-a82f-5483e186cf27 - -Pod - -telefraf-speedtest-1603552200-p8qps - - - -8e0e42d8-fcb9-4977-a82f-5483e186cf27->22a5c89c-5015-bcf1-59ac-74bb664198ba - - - - - -94f3661f-f0c2-7e80-5277-df25c5d6bbd3 - -Container - -telegraf-speedtest - - - -9ab0b5cc-83b2-4206-ab71-694ba607c75b - -Pod - -telefraf-mtr-1603552200-zctvz - - - -9ab0b5cc-83b2-4206-ab71-694ba607c75b->54ade014-05ab-74b6-dc24-76aa2100c146 - - - - - -9d6ba88a-4d50-44c9-836b-4bbf2007c7fd->3403f7e1-58c9-fd61-519f-236620837808 - - - - - -b477c141-6786-416c-5c7f-eb13828992a4 - -Container - -grafana - - - -9e72b254-4954-41ad-962d-7ab0b90d6a30->b477c141-6786-416c-5c7f-eb13828992a4 - - - - - -a575de8d-da11-4668-9a81-296423e8a32f - -Deployment - -grafana - - - -a7bee01b-df54-4973-af58-f28b90588b33 - -ConfigMap - -network-dashboard - - - -abf189c0-d2dd-423f-aa25-6b4e8f37bb2c - -PersistentVolumeClaim - -influxdb-pvc - - - -b1b84685-443a-42a6-81ed-07015506d1d0 - -PersistentVolumeClaim - -grafana-pvc - - - -b35842e2-1594-4cb3-a6a9-59e6e9985368 - -Job - -telefraf-mtr-1603552800 - - - -b35842e2-1594-4cb3-a6a9-59e6e9985368->54e52f54-9c38-4dc2-b493-4c96c144fbef - - - - - -b82c4469-4ccb-4111-8135-f79ffbaeb83c - -ConfigMap - -grafana-dashboard-provisioner - - - -bb877bad-242a-4f9f-aa20-b8220ec6cc73 - -CronJob - -telefraf-speedtest - - - -cd115076-b1ca-485f-8fd2-440d2c4221e1 - -Job - -telefraf-speedtest-1603552800 - - - -dddc3eb3-d8e6-47a6-a991-eefbdb9cd2bb - -Pod - -telefraf-speedtest-1603552800-tz9vt - - - -cd115076-b1ca-485f-8fd2-440d2c4221e1->dddc3eb3-d8e6-47a6-a991-eefbdb9cd2bb - - - - - -cd88c9c5-70bf-4287-8b28-7c0147076ed8->3465d92a-ab01-6ac0-b3dd-4aa8384263d9 - - - - - -e288e504-a4cd-d201-7b5d-e2eab62ebb22 - -Container - -telegraf-speedtest - - - -d00db8a7-f362-4b9c-bb80-d7f82ab60771->e288e504-a4cd-d201-7b5d-e2eab62ebb22 - - - - - -dddc3eb3-d8e6-47a6-a991-eefbdb9cd2bb->94f3661f-f0c2-7e80-5277-df25c5d6bbd3 - - - - - -e062a851-e054-4cc5-ab5e-cfebd5a5ee57 - -Secret - -isp-checker-secrets-ro - - - -e2883fcc-99f2-4d9b-815b-b28e22c7de51 - -Secret - -default-token-6njx8 - - - -e4fbd174-c479-4aad-ab6d-296923abe677 - -Secret - -isp-checker-secrets-rw - - - -e7ed50a0-3f0f-46ad-87b3-e5560dd7b540->4c69b87b-f38c-97bd-bf89-86f67b5fae91 - - - - - -e87be3ff-463b-466b-9068-7620af362375 - -Deployment - -influxdb - - - -f21fcd94-36e5-4bd3-8a41-85a821c6be9f - -DaemonSet - -telegraf - - - -f21fcd94-36e5-4bd3-8a41-85a821c6be9f->03bb06ee-3478-47de-a239-4ae5f8b31f08 - - - - - -f21fcd94-36e5-4bd3-8a41-85a821c6be9f->4d34a878-8dd1-4eb5-a7dc-a3e72cbedbe9 - - - - - -f21fcd94-36e5-4bd3-8a41-85a821c6be9f->53c3d993-7c0f-4c67-bc5c-9a831e380156 - - - - - -f2e5ddf6-31f9-4d00-ab26-7873c2db3581 - -Service - -grafana-svc - - - -f2e5ddf6-31f9-4d00-ab26-7873c2db3581->257231a5-5bff-4d64-98df-e9ac70ff1219 - - - - - -f2e5ddf6-31f9-4d00-ab26-7873c2db3581->57585d76-cf32-47f8-84d0-4d0f857ffb31 - - - - - -f8887fd4-869d-46b0-a43a-fa009411ad8f - -Job - -telefraf-mtr-1603552200 - - - -f8887fd4-869d-46b0-a43a-fa009411ad8f->9ab0b5cc-83b2-4206-ab71-694ba607c75b - - - - - -fe751f6d-5d0b-4730-936d-9292d40696e3 - -Service - -influxdb-svc - - - -fe751f6d-5d0b-4730-936d-9292d40696e3->1d221322-0b76-4aa0-9b18-184e78987b56 - - - - - -feeca386-facc-42ff-bb30-6a506cc6e7a3 - -Job - -telefraf-speedtest-1603552200 - - - -feeca386-facc-42ff-bb30-6a506cc6e7a3->8e0e42d8-fcb9-4977-a82f-5483e186cf27 - - - - -