From c2ca7b6b5ea6fc1e7f2263dcf0e0ebff8557691f Mon Sep 17 00:00:00 2001 From: Fotis Nikolaidis Date: Tue, 25 Jul 2023 01:40:24 +0300 Subject: [PATCH] fix the docs and the image directory Signed-off-by: Fotis Nikolaidis --- CHANGELOG.md | 1 + README.md | 2 +- charts/platform/Chart.yaml | 2 +- docs/grafana.md | 185 ------------------- docs/{images => }/logo.jpg | Bin {deploy => images}/annotator/Dockerfile | 0 {deploy => images}/annotator/builder.sh | 0 {deploy => images}/cadvisor/Dockerfile | 0 {deploy => images}/cadvisor/builder.sh | 0 {deploy => images}/ci-environment/Dockerfile | 0 {deploy => images}/ci-environment/builder.sh | 0 {deploy => images}/prometheus/Dockerfile | 0 {deploy => images}/prometheus/builder.sh | 0 13 files changed, 3 insertions(+), 187 deletions(-) delete mode 100644 docs/grafana.md rename docs/{images => }/logo.jpg (100%) rename {deploy => images}/annotator/Dockerfile (100%) rename {deploy => images}/annotator/builder.sh (100%) rename {deploy => images}/cadvisor/Dockerfile (100%) rename {deploy => images}/cadvisor/builder.sh (100%) rename {deploy => images}/ci-environment/Dockerfile (100%) rename {deploy => images}/ci-environment/builder.sh (100%) rename {deploy => images}/prometheus/Dockerfile (100%) rename {deploy => images}/prometheus/builder.sh (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b4c88edb..03c4c360a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## Changes Since Last Release ### Changed defaults / behaviours +- Move basic images from /deploy to /images - ... ### New Features & Functionality diff --git a/README.md b/README.md index 301da220b..89b22124c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

- +

diff --git a/charts/platform/Chart.yaml b/charts/platform/Chart.yaml index 6631a1591..f1a19b1e9 100755 --- a/charts/platform/Chart.yaml +++ b/charts/platform/Chart.yaml @@ -27,7 +27,7 @@ maintainers: email: nikolaidis.fotis@gmail.com url: https://www.linkedin.com/in/fotis-nikolaidis-444a6634/ -icon: https://github.com/CARV-ICS-FORTH/frisbee/blob/main/docs/images/logo.jpg +icon: https://github.com/CARV-ICS-FORTH/frisbee/blob/main/docs/logo.jpg dependencies: - name: openebs # Dynamic volume provisioning diff --git a/docs/grafana.md b/docs/grafana.md deleted file mode 100644 index bb32db299..000000000 --- a/docs/grafana.md +++ /dev/null @@ -1,185 +0,0 @@ -# Grafana API - - - -Start by setting the grafana url - -```bash -export grafana=http://grafana-skata-612.localhost -``` - - - -Assuming that the folder is `alarms` - - - -#### Get Alarm Rules - -```bash -curl ${grafana}/api/ruler/grafana/api/v1/rules/alarms -``` - - - - - -#### Set Alarms Rules - -``` -curl -H 'Content-Type: application/json' -d "@request.json" ${grafana}/api/ruler/grafana/api/v1/rules/alarms?subtype=cortex -``` - - - -the body of request.json: - -```json -{ - "name": "malakies", - "interval": "1m", - "rules": [ - { - "grafana_alert": { - "title": "Correlated Outbound Network Throughput", - "condition": "B", - "no_data_state": "NoData", - "exec_err_state": "Error", - "data": [ - { - "refId": "Throughput", - "queryType": "", - "relativeTimeRange": { - "from": 8603, - "to": 7468 - }, - "datasourceUid": "PBFA97CFB590B2093", - "model": { - "datasource": { - "type": "prometheus", - "uid": "PBFA97CFB590B2093" - }, - "exemplar": true, - "expr": "avg(rate(container_network_transmit_bytes_total{id=\"/\"}[$__rate_interval])) != 0", - "hide": false, - "interval": "", - "legendFormat": "Packets", - "refId": "Throughput", - "intervalMs": 15000 - } - }, - { - "refId": "Packets", - "queryType": "", - "relativeTimeRange": { - "from": 8603, - "to": 7468 - }, - "datasourceUid": "PBFA97CFB590B2093", - "model": { - "datasource": { - "type": "prometheus", - "uid": "PBFA97CFB590B2093" - }, - "exemplar": true, - "expr": "avg(rate(container_network_transmit_packets_total{id=\"/\"}[$__rate_interval])) != 0", - "hide": false, - "interval": "", - "legendFormat": "Throughput", - "refId": "Packets", - "intervalMs": 15000 - } - }, - { - "refId": "A", - "datasourceUid": "-100", - "queryType": "", - "model": { - "refId": "A", - "hide": false, - "type": "reduce", - "datasource": { - "uid": "-100", - "type": "__expr__" - }, - "conditions": [ - { - "type": "query", - "evaluator": { - "params": [], - "type": "gt" - }, - "operator": { - "type": "and" - }, - "query": { - "params": [ - "A" - ] - }, - "reducer": { - "params": [], - "type": "last" - } - } - ], - "reducer": "last", - "expression": "Throughput" - } - }, - { - "refId": "B", - "datasourceUid": "-100", - "queryType": "", - "model": { - "refId": "B", - "hide": false, - "type": "threshold", - "datasource": { - "uid": "-100", - "type": "__expr__" - }, - "conditions": [ - { - "type": "query", - "evaluator": { - "params": [ - 0 - ], - "type": "gt" - }, - "operator": { - "type": "and" - }, - "query": { - "params": [ - "B" - ] - }, - "reducer": { - "params": [], - "type": "last" - } - } - ], - "expression": "A" - } - } - ] - }, - "for": "5m", - "annotations": { - "__dashboardUid__": "summary", - "__panelId__": "158" - }, - "labels": {} - } - ] -} - -``` - - - - - diff --git a/docs/images/logo.jpg b/docs/logo.jpg similarity index 100% rename from docs/images/logo.jpg rename to docs/logo.jpg diff --git a/deploy/annotator/Dockerfile b/images/annotator/Dockerfile similarity index 100% rename from deploy/annotator/Dockerfile rename to images/annotator/Dockerfile diff --git a/deploy/annotator/builder.sh b/images/annotator/builder.sh similarity index 100% rename from deploy/annotator/builder.sh rename to images/annotator/builder.sh diff --git a/deploy/cadvisor/Dockerfile b/images/cadvisor/Dockerfile similarity index 100% rename from deploy/cadvisor/Dockerfile rename to images/cadvisor/Dockerfile diff --git a/deploy/cadvisor/builder.sh b/images/cadvisor/builder.sh similarity index 100% rename from deploy/cadvisor/builder.sh rename to images/cadvisor/builder.sh diff --git a/deploy/ci-environment/Dockerfile b/images/ci-environment/Dockerfile similarity index 100% rename from deploy/ci-environment/Dockerfile rename to images/ci-environment/Dockerfile diff --git a/deploy/ci-environment/builder.sh b/images/ci-environment/builder.sh similarity index 100% rename from deploy/ci-environment/builder.sh rename to images/ci-environment/builder.sh diff --git a/deploy/prometheus/Dockerfile b/images/prometheus/Dockerfile similarity index 100% rename from deploy/prometheus/Dockerfile rename to images/prometheus/Dockerfile diff --git a/deploy/prometheus/builder.sh b/images/prometheus/builder.sh similarity index 100% rename from deploy/prometheus/builder.sh rename to images/prometheus/builder.sh