Environment
Every MIGKIT_* variable an operator may set: nothing needs one, and each only changes what its words say.
Variables
| Variable | Kind | Default | What it does |
|---|---|---|---|
GRANTS_IGNORE_ROLES | list | - | accounts and roles the grant checks leave out, beside the servers' and providers' own |
MIGKIT_ACCEPT_TERMS | list | - | the programs whose terms are accepted for an unattended install, or all |
MIGKIT_AI | text | - | the model provider asked, where one is: openai, anthropic or google |
MIGKIT_AIMD_AUTOSIZING | flag | off | enable additive-increase multiplicative-decrease chunk sizing |
MIGKIT_AIMD_EXPAND_FACTOR | number | 1.5 | expansion multiplier when adaptive chunk latency stays below the floor |
MIGKIT_AIMD_MAX_CHUNK | whole | 50000 | maximum chunk size in rows under adaptive chunk sizing |
MIGKIT_AIMD_MAX_LATENCY | number | 5.0 | seconds per chunk above which adaptive chunk sizing halves the batch |
MIGKIT_AIMD_MAX_ROW_BYTES | whole | 65536 | row byte threshold above which adaptive chunk sizing halves the batch |
MIGKIT_AIMD_MIN_CHUNK | whole | 100 | minimum chunk size in rows under adaptive chunk sizing |
MIGKIT_AIMD_MIN_LATENCY | number | 1.0 | seconds per chunk below which adaptive chunk sizing expands the batch |
MIGKIT_AI_KEY | secret | - | the provider's key |
MIGKIT_AI_MODEL | text | - | the model |
MIGKIT_AI_SHARE | list | - | what may be sent: code, detail |
MIGKIT_AI_URL | text | - | the provider's address |
MIGKIT_ALLOWED_NETWORKS | list | - | CIDR networks or addresses permitted during partial-access verification |
MIGKIT_ARGS | text | - | its arguments, split as a shell would |
MIGKIT_BUNDLE | path | - | an offline bundle doctor --install installs from, with no network |
MIGKIT_BUNDLE_BUILD | path | - | the directory doctor --install builds an offline bundle in, installing nothing |
MIGKIT_BUNDLE_KEY | path | - | the private SSH key an offline bundle's sums are signed with |
MIGKIT_BUNDLE_PLATFORM | text | - | the machine an offline bundle is built for: linux-x86_64, darwin-arm64, or a Linux named after them (linux-x86_64-ubuntu-22.04) |
MIGKIT_BUNDLE_SIGNERS | path | - | the allowed signers file an offline bundle's signature is checked against |
MIGKIT_CATALOG_REFRESH | flag | off | refresh the machine catalogue from the provider's API where this machine has its credentials |
MIGKIT_CDC | text | - | how changes are carried: native (the servers' own replication) or follow (driven from here) |
MIGKIT_CLOUD_POLL | number | - | seconds between looks at a cloud's restore or clone |
MIGKIT_CLOUD_WAIT | number | - | seconds a cloud's restore or clone is given |
MIGKIT_COMMAND | text | check | the command a CI step runs |
MIGKIT_COMPARE_WITH | path | - | another tool's own check report to hold this run's answers against, in place of the hop's compare_with |
MIGKIT_CONF | path | - | the hops file, where it is not ./conf/hops.yaml or the user's config directory |
MIGKIT_CROSSCHECK | flag | off | read the data a second way beside the first |
MIGKIT_CUTOVER | text | - | unproven: tear the stream down whatever the last check found |
MIGKIT_DB2_CLIENT_LIB | text | - | the Db2 client library's file, where it is not on the library path |
MIGKIT_DB2_CONNECT_LICENSE | path | - | the Db2 Connect licence file |
MIGKIT_DIAGNOSE | path | - | doctor writes a problem-report bundle to this file |
MIGKIT_EGRESS | list | - | what may leave the machine, for every hop: none, or the kinds that may (notify, traces, assist, evidence, anchor, telemetry); all that is configured where unset |
MIGKIT_EGRESS_TO | list | - | the hosts anything that leaves may go to: names, shell patterns, addresses and networks |
MIGKIT_EVIDENCE_KEY | path | - | the private SSH key the evidence is signed with |
MIGKIT_EXCLUDE | list | - | databases or tables left alone for this run, on top of the hop's exclude |
MIGKIT_EXPLAIN | flag | off | print why each way was chosen |
MIGKIT_EXTRA_UNSAFE_PATTERNS | list | - | additional regular expressions flagged as destructive SQL in rollback sets |
MIGKIT_FAIL_ON_DIFFERENCE | flag | on | whether a CI step fails on a difference |
MIGKIT_FENCE_TIMEOUT | number | 30.0 | seconds to wait for CDC apply position crossover |
MIGKIT_FOLLOW_TIMEOUT | number | 1800 | seconds a follow of changes is given to catch up |
MIGKIT_GENERATIONS | whole | - | how many times the proof reads again only the parts that still differ |
MIGKIT_GOAL | text | - | the goal init writes into the hop |
MIGKIT_HEADROOM_RATCHET | whole | 10000 | sequence headroom addition before syncback cutover |
MIGKIT_HEARTBEAT_INTERVAL | number | 20.0 | seconds between application background heartbeats |
MIGKIT_HOP | text | - | the hop's name for init and for a CI step; set for a cutover's own commands |
MIGKIT_HUAWEI_SDK_PYTHON | path | - | the interpreter Huawei Cloud's API is driven from, in its environment of its own |
MIGKIT_IDENTITY | path | ~/.ssh/id_ed25519 | the private key files held at rest are read back with |
MIGKIT_INSTANCES | path | ~/.cache/migkit/instances.json | the machine catalogue refreshed from a provider's API |
MIGKIT_INSTANT_ETA | flag | on | compute instant byte-weighted cold-start ETA before the first unit finishes |
MIGKIT_KEEPALIVE_COUNT | whole | 3 | number of unacknowledged keepalive probes before declaring failure |
MIGKIT_KEEPALIVE_IDLE | whole | 15 | seconds a quiet connection waits before it is probed |
MIGKIT_KEEPALIVE_INTERVAL | whole | 5 | seconds between keepalive probes |
MIGKIT_KNOWLEDGE | path | ~/.local/share/migkit | where what migkit has measured about this machine is kept; never sent anywhere |
MIGKIT_LEASE_SECONDS | number | 60 | the term of the hop's lease |
MIGKIT_LOB_THRESHOLD | whole | 65536 | bytes above which a LOB column is hashed via server projection |
MIGKIT_MAX_BATCH_SIZE | whole | - | maximum rows per batch for adaptive execution bounds |
MIGKIT_MAX_LOG_BYTES | whole | 65536 | maximum bytes retained per log file in a support reproducer bundle |
MIGKIT_MAX_LOG_LINES | whole | 500 | maximum log lines retained per log file in a support reproducer bundle |
MIGKIT_MAX_WORKERS | whole | - | maximum concurrent worker count for adaptive execution bounds |
MIGKIT_MERKLE_BUCKETS | whole | 1024 | number of buckets per Merkle level |
MIGKIT_MERKLE_LEAF_THRESHOLD | whole | 16 | rows per bucket below which Merkle bisects to exact keys |
MIGKIT_MERKLE_MAX_DEPTH | whole | 8 | maximum recursion depth for Merkle tree bisection |
MIGKIT_MERKLE_THRESHOLD | whole | 1000000 | minimum rows to trigger adaptive Merkle bucket diffing |
MIGKIT_METRICS_TOKEN | secret | - | the bearer a scraper reads /metrics with; without it only someone signed in reads it, their own hops |
MIGKIT_MIN_BATCH_SIZE | whole | - | minimum rows per batch for adaptive execution bounds |
MIGKIT_MIN_WORKERS | whole | - | minimum concurrent worker count for adaptive execution bounds |
MIGKIT_MIRROR_NETWORK | text | host | the network a topic mirror's container runs on |
MIGKIT_MOVER | text | - | one way of copying forced, to diagnose - migkit decides it otherwise |
MIGKIT_NOTIFY | list | - | addresses told about every hop |
MIGKIT_ORACLE_READER | text | - | one way of reading Oracle's changes forced: logminer or redo-files |
MIGKIT_ORACLE_WRITE | text | - | one way of writing into Oracle put first, to diagnose |
MIGKIT_OUTPUTS | path | - | the directory a workflow step's outputs and evidence are written to |
MIGKIT_PORTABLE_FORMAT_VERSION | whole | 1 | schema version stamped on portable state and manifest exports |
MIGKIT_PREFLIGHT | text | - | warn: say what would stop a run and go on |
MIGKIT_PROBE_FROM | whole | 268435456 | the table size from which a copy's first stretch is timed |
MIGKIT_PROBE_SECONDS | number | 1.5 | how long a copy's first stretch is timed for |
MIGKIT_PROOF_COLD_LEAVES | whole | 256 | how many of those are read in one check |
MIGKIT_PROOF_COLD_SECONDS | number | 300 | the age after which a kept proof's parts are read again |
MIGKIT_PROOF_OLDEST_SECONDS | number | 86400 | the age after which every part is read again |
MIGKIT_READ_TIMEOUT | whole | 3600 | seconds one MySQL read may take |
MIGKIT_REPAIR_TEXT | flag | off | let the repair of double-encoded text write its fixes to the target; off, it only says what it would change |
MIGKIT_REPORTS | path | - | where reports and the state of runs are kept |
MIGKIT_RING_BUFFER_BYTES | whole | - | memory ceiling in bytes for store-and-forward ring buffer |
MIGKIT_SAFE_TEST_IPS | list | - | synthetic IPv4 addresses exempt from privacy redaction in support bundles |
MIGKIT_SCHEDULED | flag | off | the command runs in its hop's schedule |
MIGKIT_SCHEDULE_RESUME | flag | off | go on with a schedule its last slots stopped |
MIGKIT_SECOND_READER_PYTHON | path | - | the interpreter the second reader runs in |
MIGKIT_SECRETS | text | - | where init keeps the passwords it is given: keychain or env |
MIGKIT_SEED_START_WAIT | number | - | seconds a copy of the pages is given to start |
MIGKIT_SOURCE | text | - | the source's address for init, and for a step that writes its hop |
MIGKIT_SOURCE_PASSWORD | secret | - | the source's password for init, and for a copy migkit runs in a process of its own |
MIGKIT_STALL_SECONDS | number | 300 | seconds without progress before a copy is ended as stalled |
MIGKIT_STANDBY_SECONDS | number | 15 | the term of the lease a hop with a standby is moved under, and of a shared range's claim: a machine not heard from for as long is taken over |
MIGKIT_START_BATCH_SIZE | whole | - | initial rows per batch for adaptive execution bounds |
MIGKIT_START_WORKERS | whole | - | initial concurrent worker count for adaptive execution bounds |
MIGKIT_STATE_KEY | secret | - | the passphrase restore points and state kept away from the machine are sealed with |
MIGKIT_STORE_FORWARD | flag | off | enable store-and-forward ring buffer stream |
MIGKIT_SUBSCRIBE_TIMEOUT | whole | - | seconds a subscription is given to copy and catch up |
MIGKIT_TABLE_COPY | text | - | one way every table of a copy between two engines takes where it holds, forced for measuring |
MIGKIT_TAIL_APPLY_ALL | flag | off | apply every change, for measuring what the tail leaves out |
MIGKIT_TARGET | text | - | the target's address for init |
MIGKIT_TARGET_ENGINE | text | postgres | default target database engine assumed by lineage evidence analysis |
MIGKIT_TARGET_PASSWORD | secret | - | the target's password, the same way |
MIGKIT_TARGET_VERSION | text | 15.0 | default target engine version assumed by lineage evidence analysis |
MIGKIT_TELEMETRY | flag | on | product telemetry, kept on this machine and never sent: off stops it and deletes what was kept |
MIGKIT_TELEMETRY_POLICY | path | /etc/migkit/policy.yaml | the organisation's policy file; telemetry: off or egress: none in it turns telemetry off for everyone |
MIGKIT_TELEMETRY_SPOOL | path | - | where telemetry events are kept, where not beside the state of runs |
MIGKIT_TOOLS | path | ~/.migkit/tools | where migkit keeps the programs it builds for itself |
MIGKIT_UI_BIND | text | 127.0.0.1 | the address the web view (and the dashboard) listens on; for the web view, anything but this machine's loopback needs TLS |
MIGKIT_UI_HOSTS | list | - | more host names the web view and the dashboard answer to |
MIGKIT_UI_PROXY_SECRET | secret | - | the secret a signing-in proxy sends in X-Migkit-Proxy: without it the user header is not believed |
MIGKIT_UI_USER_HEADER | text | - | the header a signing-in proxy names the dashboard's user in |
MIGKIT_VERIFY_SLOT_BEFORE_SNAPSHOT | flag | off | verify logical replication slot exists before snapshot export |
MIGKIT_WEB_IDLE_MINUTES | number | 60 | minutes without a request before a sign-in ends |
MIGKIT_WEB_OIDC_CLIENT_ID | text | - | the client the provider registered for the web view |
MIGKIT_WEB_OIDC_CLIENT_SECRET | secret | - | its secret, or a reference to where it is kept |
MIGKIT_WEB_OIDC_GROUPS | text | groups | the claim a person's groups are in |
MIGKIT_WEB_OIDC_ISSUER | text | - | the OpenID Connect provider people sign in through, its issuer's address |
MIGKIT_WEB_OIDC_SCOPES | list | openid,email,profile | the scopes asked for |
MIGKIT_WEB_PLAIN | flag | off | serve the web view without TLS beyond this machine's loopback - only where the network to it is the operator's own: a container published on the host's loopback |
MIGKIT_WEB_PROXIES | list | - | the addresses of the reverse proxies in front of the web view: the only ones answered, and whose forwarded headers are read |
MIGKIT_WEB_RESET | flag | off | print an address that sets the local operator's password again |
MIGKIT_WEB_SAML_ENCRYPTED | flag | off | demand an encrypted assertion from the SAML identity provider: a plain one is refused |
MIGKIT_WEB_SAML_GROUPS | text | groups | the attribute a person's groups are in |
MIGKIT_WEB_SAML_METADATA | path | - | the SAML identity provider's metadata, as it publishes it |
MIGKIT_WEB_SAML_NAME | text | - | the attribute naming the person, where not the name identifier |
MIGKIT_WEB_SCIM_TOKEN | secret | - | the bearer token the provider provisions people and groups with; set, only people it provisioned sign in |
MIGKIT_WEB_SESSION_HOURS | number | 12 | the longest a sign-in lasts |
MIGKIT_WEB_STATE | path | ~/.local/share/migkit/web | where the web view keeps its sessions, the people provisioned and its signing key |
MIGKIT_WEB_TLS_CERT | path | - | the web view's certificate (PEM, its chain after it) |
MIGKIT_WEB_TLS_KEY | path | - | the certificate's private key |
MIGKIT_WEB_TOKEN_DAYS | number | 90 | the longest an API token lasts |
MIGKIT_WEB_URL | text | - | the address people open the web view at, https:// behind a proxy or with a certificate |
MONGO_IGNORE_ROLES | list | - | MongoDB roles the account checks leave out, beside the providers' own |
MONGO_IGNORE_USERS | list | - | MongoDB accounts the account checks leave out, beside the providers' own |
MIGKIT_<HOP>_<SIDE>_PASSWORD | secret | - | a password a hop's reference names |