Settings reference

Every field on the two settings documents, what it controls, and what it reads
on a running host.

Who this is for. Whoever changes how benches are built and placed.

Before you start. Read the values here as measured, not as documented.
Every number below was read off a live site with the command in
How these values were read. A defaults table
copied out of a JSON file is wrong the first time somebody edits one in Desk.

The two documents, and the two places they are edited

BenchPress has two settings Singles. Neither is fully exposed in the app.

The app's Settings dialog is deliberately a subset — the ten fields an
operator changes while setting a host up. Everything else is a Desk form at
/app/benchpress-settings and /app/credit-settings.

[Screenshot to be added — docs/images/operator/settings-reference/01-settings-network.png: The BenchPress settings dialog, Bench network panel, showing Subnet base 10.20, Bridge count 16 and Slots per bridge 1000, each with a one-line explanation underneath.]

The dialog groups its ten fields into four panels — Domains, Docker, Bench
network and Container defaults — and prints who saved last and when at the
bottom. The Bench network panel above holds bench_subnet_base 10.20,
bench_bridge_count 16 and bench_slots_per_bridge 1000.

Steps

1. Open /app/benchpress-settings in Desk for the full form, or Settings
   in the app's account menu for the ten common fields.
2. Change one field.
3. Save.
4. Read What a change costs — some fields apply to the
   next deploy, and some apply immediately to running benches.

Verify

Read the value back from the server rather than from the form you just saved.
A cached Single is the usual reason a change looks like it did not take.

bench --site <site> execute frappe.client.get_value \
  --kwargs "{'doctype':'BenchPress Settings','fieldname':'bench_bridge_count'}"

BenchPress Settings

Docker configuration

The bench network

Bridge i is <subnet base>.<i × 16>.0/20. Bridges are created as they are
needed, not up front.

On this host that arithmetic gives 15,985 free bench slots across three
created bridges — the number Diagnostics reports
as bridge_capacity.

Health probes

These configure the Docker healthcheck written into each bench container.

Ten minutes of start period is not caution. A first deploy runs migrations
inside the container, and a shorter grace marks a healthy bench unhealthy
while it is still working.

Container defaults

Applied to a new lab unless the lab overrides them.

Reconciliation and events

Three fields on this host read 0, and 0 does not mean zero. Each is read
as cint(value) or DEFAULT, so a stored 0 means "use the built-in", and the
built-in is the number in the Falls back to column.

That fallback pattern is worth knowing before you clear a field to "turn it
off". Clearing it restores the built-in instead.

Credits

Leave this at 0 unless you are running BenchPress for a team. With it
on, every deploy is charged against a balance and capped by concurrency, and
users who have no Credit Account are refused. Nothing on the self-hosted
path needs it.

Credit Settings

Every field here is inert while enable_credits is 0. Each function in the
credits package checks the switch before it does anything, so with credits off
there are no accounts, no ledger rows and no extra queries.

Grants and charges

Instance lifecycle

An email goes out two days before the teardown, so nobody loses work to a rule
they had forgotten.

Leases

lease_reclaim_seconds reads 60 here against a shipped 300, and
lease_max_attempts reads 0, which falls back to 5. Both are examples of
why this table is measured rather than copied.

Free but capped

max_concurrent_uncredited is the field most often read backwards. It applies
only while enable_credits is 0, and 0 there means unlimited, not
zero. Turning credits on does not engage it — the cap becomes
max_concurrent_free or max_concurrent_paid instead. See
Admission and limits.

Self-serve signup

See Self-serve signup.

What a change costs

How these values were read

Off the live site, from the document rather than from the DocType JSON:

bench --site <site> execute frappe.client.get_value \
  --kwargs "{'doctype':'BenchPress Settings','fieldname':'default_bench_runtime'}"

To dump every field with its stored value and its shipped default at once, use
bench console:

import frappe
d = frappe.get_cached_doc("BenchPress Settings")
for f in frappe.get_meta("BenchPress Settings").fields:
    if f.fieldtype not in ("Section Break", "Column Break", "Tab Break", "HTML"):
        print(f.fieldname, "=", d.get(f.fieldname), "| ships as", f.default)

A multi-line block fed to bench console on a pipe is truncated at the first
blank line, and it fails silently. Type it into an interactive console, or
wrap it in a single exec() call.

Troubleshooting

Related

• Diagnostics — checks that read the host, not the settings.
• Admission and limits — what the caps do when credits are on.
• Credits and billing — the switch this page keeps telling you to leave alone.
• Golden images — the two settings that decide deploy speed.