Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Use SSD and set random_page_cost #2549

Merged
merged 1 commit into from
Jan 26, 2024
Merged

docs: Use SSD and set random_page_cost #2549

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/DEPLOYING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Deploying Janus

<!--toc:start-->
- [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)
<!--toc:end-->

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
Expand Down Expand Up @@ -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
Expand Down
Loading