Skip to content

chore: default spanner mysql config#2383

Open
taddes wants to merge 5 commits into
masterfrom
chore/default-spanner-mysql-config-STOR-477
Open

chore: default spanner mysql config#2383
taddes wants to merge 5 commits into
masterfrom
chore/default-spanner-mysql-config-STOR-477

Conversation

@taddes

@taddes taddes commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Description

Attempt to configure Spanner and MySQL for easy "out-of-the-box" runs.

Issue(s)

Closes STOR-477.

@taddes taddes self-assigned this Jun 10, 2026
@taddes taddes changed the title [WIP] chore: default spanner mysql config chore: default spanner mysql config Jun 17, 2026
@taddes taddes force-pushed the chore/default-spanner-mysql-config-STOR-477 branch from 1a81651 to 48461df Compare June 17, 2026 20:37
@taddes taddes marked this pull request as ready for review June 18, 2026 00:30
@taddes taddes force-pushed the chore/default-spanner-mysql-config-STOR-477 branch from c5b2421 to 093b5d3 Compare June 18, 2026 21:17
taddes added 5 commits June 18, 2026 17:17
…anner

Provide ready-to-edit, fully-annotated example configs for the two standard
builds. local.example.toml is now a documented MySQL defaut local.example.spanner.toml is a new template for the production
Spanner syncstorage + MySQL tokenserver.

Each setting notes its purpose, default, and backend relevance, and the
REQUIRED values a user must edit are called out explicitly.

Closes STOR-477
Add doc comments to the previously-undocumented public Settings fields
(host/port, statsd host/port, human_logs, pool size, quota toggles,
spanner_emulator_host, enabled, statsd_label) so the structs are the source of
truth for configuration defaults. Documentation only; no behavior change.

Closes STOR-477
Add a short How-To page describing the out-of-the-box configuration for the
standard MySQL and Spanner builds, the minimum required settings, and where the
full reference lives.

Add a one-shot MySQL docker compose recipe (DB + server, migrations applied
automatically, sync-1.5 service + node bootstrapped) so the stack comes up ready
to serve. The primary recipe builds the image from source (works from a
checkout with no published tag); an alternative uses a published image, noting
that images are tagged by commit SHA with no `latest` tag, so SYNCSERVER_VERSION
must be pinned. Register the new page in the book summary and How-To index.

Closes STOR-477
A merge left a stale settings block in the MySQL example config that
re-declared syncstorage.enabled/database_url/enable_quota and
limits.max_total_records, producing duplicate TOML keys and a parse failure
(`Cannot overwrite a value`). Remove the stale block, keeping the single
annotated definitions so the template parses and can be copied to local.toml.

Closes STOR-477
Use 9984 as the example syncstorage.limits.max_total_records value.

Closes STOR-477
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant