Update readme (#395)

This PR reorganise the README.md to make it easier to read it and easier to access the quick start via docker. It also updates the benchmarks and removes some old docs.
danielealbano · May 8, 2023 · 020d674 · 020d674
1 parent b034383
commit 020d674
Show file tree

Hide file tree

Showing 10 changed files with 117 additions and 178 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/architecture/modules/prometheus.md b/docs/architecture/modules/prometheus.md
@@ -41,15 +41,6 @@ The available metrics are:
 | cachegrand_storage_total_read_data                 | Total amount of read data from disk           | Counter |
 | cachegrand_storage_total_read_iops                 | Total amount of read IOPS                     | Counter |
 | cachegrand_storage_total_open_files                | Total amount of open files                    | Counter |
-| cachegrand_network_per_minute_received_packets     | Per minute amount of received packets         | Counter |
-| cachegrand_network_per_minute_received_data        | Per minute amount of received data (in bytes) | Counter |
-| cachegrand_network_per_minute_sent_packets         | Per minute amount of sent packets             | Counter |
-| cachegrand_network_per_minute_sent_data            | Per minute amount of sent data                | Counter |
-| cachegrand_network_per_minute_accepted_connections | Per minute amount of accepted connections     | Counter |
-| cachegrand_storage_per_minute_written_data         | Per minute amount of data written to disk     | Counter |
-| cachegrand_storage_per_minute_write_iops           | Per minute amount of write IOPS               | Counter |
-| cachegrand_storage_per_minute_read_data            | Per minute amount of read data from disk      | Counter |
-| cachegrand_storage_per_minute_read_iops            | Per minute amount of read IOPS                | Counter |
 | cachegrand_uptime                                  | Uptime in seconds                             | Counter |
 
 ### Metrics labels

diff --git a/docs/architecture/timeseries-db.md b/docs/architecture/timeseries-db.md
@@ -1,15 +1,4 @@
 Time-Series Database
 ====================
 
-Cachegrand relies on a Time-Series database to store the cache data on-disk, no only to be able to perform an efficient
-garbage collection but also, in the future, to allow access to historical data and better support data streams.
-
-## Architecture
-
-### Design
-
-TODO
-
-### Apis
-
 TODO
diff --git a/docs/benchmarks.md b/docs/benchmarks.md
diff --git a/docs/benchmarks/cachegrand-amd-epyc-7502p-get-ops.png b/docs/benchmarks/cachegrand-amd-epyc-7502p-get-ops.png
diff --git a/docs/benchmarks/cachegrand-amd-epyc-7502p-get-pipeline-ops.png b/docs/benchmarks/cachegrand-amd-epyc-7502p-get-pipeline-ops.png
diff --git a/docs/benchmarks/cachegrand-amd-epyc-7502p-latencies-t1.jpg b/docs/benchmarks/cachegrand-amd-epyc-7502p-latencies-t1.jpg
diff --git a/docs/benchmarks/cachegrand-amd-epyc-7502p-latencies-t64.jpg b/docs/benchmarks/cachegrand-amd-epyc-7502p-latencies-t64.jpg
diff --git a/docs/benchmarks/cachegrand-amd-epyc-7502p-set-ops.png b/docs/benchmarks/cachegrand-amd-epyc-7502p-set-ops.png
diff --git a/docs/benchmarks/cachegrand-amd-epyc-7502p-set-pipeline-ops.png b/docs/benchmarks/cachegrand-amd-epyc-7502p-set-pipeline-ops.png