Getting started with Perses (#6669)

Signed-off-by: Friedrich Gonzalez <[email protected]>

Author: friedrichg

docs/getting-started/.env

@@ -1,4 +1,5 @@
 CORTEX_VERSION=v1.19.0
 GRAFANA_VERSION=10.4.2
-PROMETHEUS_VERSION=v2.51.2
+PROMETHEUS_VERSION=v3.2.1
 SEAWEEDFS_VERSION=3.67
+PERSES_VERSION=v0.49-distroless-debug

docs/getting-started/_index.md

@@ -41,7 +41,8 @@ This example uses [Docker Compose](https://docs.docker.com/compose/) to set up:
 1. An instance of [SeaweedFS](https://github.com/seaweedfs/seaweedfs/) for S3-compatible object storage
 1. An instance of [Cortex](https://cortexmetrics.io/) to receive metrics.
 1. An instance of [Prometheus](https://prometheus.io/) to send metrics to Cortex.
-1. An instance of [Grafana](https://grafana.com/) to visualize the metrics.
+1. An instance of [Perses](https://perses.dev) for latest trend on dashboarding
+1. An instance of [Grafana](https://grafana.com/) for legacy dashboarding
 
 #### Instructions
 
@@ -53,14 +54,7 @@ $ cd cortex/docs/getting-started
 ##### Start the services
 
 ```sh
-# Start SeaweedFS to emulate S3 storage for Cortex.
-$ docker-compose up seaweedfs -d --wait
-# Create buckets in SeaweedFS.
-$ for bucket in cortex-blocks cortex-ruler cortex-alertmanager; do
-  curl --aws-sigv4 "aws:amz:local:seaweedfs" --user "any:any" -X PUT http://localhost:8333/$bucket
-done
-# Start the remaining services.
-$ docker-compose up -d --wait
+$ docker compose up -d
 ```
 
 We can now access the following services:
@@ -123,7 +117,7 @@ Other things to explore:
 ### Clean up
 
 ```sh
-$ docker-compose down
+$ docker compose down -v
 ```
 
 ## Microservice Mode

docs/getting-started/cortex-config.yaml

@@ -3,7 +3,7 @@
 # and development.
 
 # https://cortexmetrics.io/docs/configuration/configuration-file/#supported-contents-and-default-values-of-the-config-file
-target: all,compactor,alertmanager
+target: all
 
 # Disable the requirement that every request to Cortex has an
 # X-Scope-OrgID header. `fake` will be substituted in instead.
@@ -100,4 +100,4 @@ alertmanager_storage:
   backend: s3
   s3:
     <<: *s3
-    bucket_name: cortex-alertmanager
+    bucket_name: cortex-alertmanager

docs/getting-started/docker-compose.yaml

@@ -39,6 +39,16 @@ services:
       - ./dashboards/:/var/lib/grafana/dashboards/:ro
     ports:
       - "3000:3000"
+  perses:
+    image: persesdev/perses:${PERSES_VERSION}
+    command: "--config=/etc/perses/config/config.yaml"
+    ports:
+      - "8080:8080"
+    volumes:
+      - ./perses/config.yaml:/etc/perses/config/config.yaml:ro
+      - ./perses/datasource.yaml:/etc/perses/resources/datasource.yaml:ro
+      - ./perses/project.yaml:/etc/perses/resources/project.yaml:ro
+      - ./perses/dashboards/cortex-writes.yaml:/etc/perses/resources/cortex-writes.yaml:ro
   prometheus:
     image: prom/prometheus:${PROMETHEUS_VERSION}
     command:
@@ -55,8 +65,11 @@ services:
       - -s3.config=/workspace/seaweedfs-config.json
     ports:
       - "8333:8333"
+    post_start:
+    - command: /seaweedfs-init.sh
     volumes:
       - ./seaweedfs-config.json:/workspace/seaweedfs-config.json:ro
+      - ./seaweedfs-init.sh:/seaweedfs-init.sh:ro
     healthcheck:
       test: wget -qO- http://127.0.0.1:8333/status
       interval: 10s

docs/getting-started/perses/config.yaml

@@ -0,0 +1,21 @@
+security:
+  readonly: false
+  enable_auth: false
+  cookie:
+    same_site: lax
+    secure: false
+
+database:
+  file:
+    extension: yaml
+    folder: /perses
+
+schemas:
+  datasources_path: /etc/perses/cue/schemas/datasources
+  interval: 5m
+  panels_path: /etc/perses/cue/schemas/panels
+  queries_path: /etc/perses/cue/schemas/queries
+  variables_path: /etc/perses/cue/schemas/variables
+provisioning:
+  folders:
+    - /etc/perses/resources