From 59512e097ae41ea7321348d0bed45d8f2911401d Mon Sep 17 00:00:00 2001 From: Ameer Ghani Date: Thu, 25 Jan 2024 19:21:00 -0500 Subject: [PATCH] docs: Use SSD and set random_page_cost --- docs/DEPLOYING.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/DEPLOYING.md b/docs/DEPLOYING.md index 64fdccb2b..c4a1412de 100644 --- a/docs/DEPLOYING.md +++ b/docs/DEPLOYING.md @@ -1,5 +1,27 @@ # Deploying Janus + +- [Deploying Janus](#deploying-janus) + - [Configuration](#configuration) + - [Common Configuration](#common-configuration) + - [Database Connection](#database-connection) + - [TLS](#tls) + - [Health Check](#health-check) + - [Observability](#observability) + - [Logging](#logging) + - [Metrics](#metrics) + - [Tracing](#tracing) + - [`tokio-console`](#tokio-console) + - [`aggregator` configuration](#aggregator-configuration) + - [`aggregation_job_creator` configuration](#aggregationjobcreator-configuration) + - [`aggregation_job_driver` configuration](#aggregationjobdriver-configuration) + - [`collection_job_driver` configuration](#collectionjobdriver-configuration) + - [Database](#database) + - [Datastore Keys](#datastore-keys) + - [Recommended Configuration](#recommended-configuration) + - [`janus_cli provision-tasks`](#januscli-provision-tasks) + + A full deployment of Janus is composed of multiple Janus components and a PostgreSQL database. The `aggregator` component is responsible for servicing DAP requests from other protocol participants, (client, collector, or leader) while @@ -173,6 +195,19 @@ encrypted under them has been deleted. [base64url]: https://datatracker.ietf.org/doc/html/rfc4648#section-5 +### Recommended Configuration + +It is recommended to run Janus on a PostgreSQL instance backed by solid-state +disks. + +When using a SSD-backed database, [set `random_page_cost` to `1.1`][random_page_cost]. + +This can be set in `postgresql.conf`. See the [PostgreSQL documentation][pgdoc] +or your PostgreSQL vendor's documentation for details on how to set this. + +[random_page_cost]: https://www.postgresql.org/docs/current/runtime-config-query.html#GUC-RANDOM-PAGE-COST +[pgdoc]: https://www.postgresql.org/docs/current/config-setting.html#CONFIG-SETTING-CONFIGURATION-FILE + ## `janus_cli provision-tasks` Currently, the simplest way to set up DAP tasks inside Janus is via the