Environment

Every MIGKIT_* variable an operator may set: nothing needs one, and each only changes what its words say.

Variables

VariableKindDefaultWhat it does
GRANTS_IGNORE_ROLESlist-accounts and roles the grant checks leave out, beside the servers' and providers' own
MIGKIT_ACCEPT_TERMSlist-the programs whose terms are accepted for an unattended install, or all
MIGKIT_AItext-the model provider asked, where one is: openai, anthropic or google
MIGKIT_AIMD_AUTOSIZINGflagoffenable additive-increase multiplicative-decrease chunk sizing
MIGKIT_AIMD_EXPAND_FACTORnumber1.5expansion multiplier when adaptive chunk latency stays below the floor
MIGKIT_AIMD_MAX_CHUNKwhole50000maximum chunk size in rows under adaptive chunk sizing
MIGKIT_AIMD_MAX_LATENCYnumber5.0seconds per chunk above which adaptive chunk sizing halves the batch
MIGKIT_AIMD_MAX_ROW_BYTESwhole65536row byte threshold above which adaptive chunk sizing halves the batch
MIGKIT_AIMD_MIN_CHUNKwhole100minimum chunk size in rows under adaptive chunk sizing
MIGKIT_AIMD_MIN_LATENCYnumber1.0seconds per chunk below which adaptive chunk sizing expands the batch
MIGKIT_AI_KEYsecret-the provider's key
MIGKIT_AI_MODELtext-the model
MIGKIT_AI_SHARElist-what may be sent: code, detail
MIGKIT_AI_URLtext-the provider's address
MIGKIT_ALLOWED_NETWORKSlist-CIDR networks or addresses permitted during partial-access verification
MIGKIT_ARGStext-its arguments, split as a shell would
MIGKIT_BUNDLEpath-an offline bundle doctor --install installs from, with no network
MIGKIT_BUNDLE_BUILDpath-the directory doctor --install builds an offline bundle in, installing nothing
MIGKIT_BUNDLE_KEYpath-the private SSH key an offline bundle's sums are signed with
MIGKIT_BUNDLE_PLATFORMtext-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_SIGNERSpath-the allowed signers file an offline bundle's signature is checked against
MIGKIT_CATALOG_REFRESHflagoffrefresh the machine catalogue from the provider's API where this machine has its credentials
MIGKIT_CDCtext-how changes are carried: native (the servers' own replication) or follow (driven from here)
MIGKIT_CLOUD_POLLnumber-seconds between looks at a cloud's restore or clone
MIGKIT_CLOUD_WAITnumber-seconds a cloud's restore or clone is given
MIGKIT_COMMANDtextcheckthe command a CI step runs
MIGKIT_COMPARE_WITHpath-another tool's own check report to hold this run's answers against, in place of the hop's compare_with
MIGKIT_CONFpath-the hops file, where it is not ./conf/hops.yaml or the user's config directory
MIGKIT_CROSSCHECKflagoffread the data a second way beside the first
MIGKIT_CUTOVERtext-unproven: tear the stream down whatever the last check found
MIGKIT_DB2_CLIENT_LIBtext-the Db2 client library's file, where it is not on the library path
MIGKIT_DB2_CONNECT_LICENSEpath-the Db2 Connect licence file
MIGKIT_DIAGNOSEpath-doctor writes a problem-report bundle to this file
MIGKIT_EGRESSlist-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_TOlist-the hosts anything that leaves may go to: names, shell patterns, addresses and networks
MIGKIT_EVIDENCE_KEYpath-the private SSH key the evidence is signed with
MIGKIT_EXCLUDElist-databases or tables left alone for this run, on top of the hop's exclude
MIGKIT_EXPLAINflagoffprint why each way was chosen
MIGKIT_EXTRA_UNSAFE_PATTERNSlist-additional regular expressions flagged as destructive SQL in rollback sets
MIGKIT_FAIL_ON_DIFFERENCEflagonwhether a CI step fails on a difference
MIGKIT_FENCE_TIMEOUTnumber30.0seconds to wait for CDC apply position crossover
MIGKIT_FOLLOW_TIMEOUTnumber1800seconds a follow of changes is given to catch up
MIGKIT_GENERATIONSwhole-how many times the proof reads again only the parts that still differ
MIGKIT_GOALtext-the goal init writes into the hop
MIGKIT_HEADROOM_RATCHETwhole10000sequence headroom addition before syncback cutover
MIGKIT_HEARTBEAT_INTERVALnumber20.0seconds between application background heartbeats
MIGKIT_HOPtext-the hop's name for init and for a CI step; set for a cutover's own commands
MIGKIT_HUAWEI_SDK_PYTHONpath-the interpreter Huawei Cloud's API is driven from, in its environment of its own
MIGKIT_IDENTITYpath~/.ssh/id_ed25519the private key files held at rest are read back with
MIGKIT_INSTANCESpath~/.cache/migkit/instances.jsonthe machine catalogue refreshed from a provider's API
MIGKIT_INSTANT_ETAflagoncompute instant byte-weighted cold-start ETA before the first unit finishes
MIGKIT_KEEPALIVE_COUNTwhole3number of unacknowledged keepalive probes before declaring failure
MIGKIT_KEEPALIVE_IDLEwhole15seconds a quiet connection waits before it is probed
MIGKIT_KEEPALIVE_INTERVALwhole5seconds between keepalive probes
MIGKIT_KNOWLEDGEpath~/.local/share/migkitwhere what migkit has measured about this machine is kept; never sent anywhere
MIGKIT_LEASE_SECONDSnumber60the term of the hop's lease
MIGKIT_LOB_THRESHOLDwhole65536bytes above which a LOB column is hashed via server projection
MIGKIT_MAX_BATCH_SIZEwhole-maximum rows per batch for adaptive execution bounds
MIGKIT_MAX_LOG_BYTESwhole65536maximum bytes retained per log file in a support reproducer bundle
MIGKIT_MAX_LOG_LINESwhole500maximum log lines retained per log file in a support reproducer bundle
MIGKIT_MAX_WORKERSwhole-maximum concurrent worker count for adaptive execution bounds
MIGKIT_MERKLE_BUCKETSwhole1024number of buckets per Merkle level
MIGKIT_MERKLE_LEAF_THRESHOLDwhole16rows per bucket below which Merkle bisects to exact keys
MIGKIT_MERKLE_MAX_DEPTHwhole8maximum recursion depth for Merkle tree bisection
MIGKIT_MERKLE_THRESHOLDwhole1000000minimum rows to trigger adaptive Merkle bucket diffing
MIGKIT_METRICS_TOKENsecret-the bearer a scraper reads /metrics with; without it only someone signed in reads it, their own hops
MIGKIT_MIN_BATCH_SIZEwhole-minimum rows per batch for adaptive execution bounds
MIGKIT_MIN_WORKERSwhole-minimum concurrent worker count for adaptive execution bounds
MIGKIT_MIRROR_NETWORKtexthostthe network a topic mirror's container runs on
MIGKIT_MOVERtext-one way of copying forced, to diagnose - migkit decides it otherwise
MIGKIT_NOTIFYlist-addresses told about every hop
MIGKIT_ORACLE_READERtext-one way of reading Oracle's changes forced: logminer or redo-files
MIGKIT_ORACLE_WRITEtext-one way of writing into Oracle put first, to diagnose
MIGKIT_OUTPUTSpath-the directory a workflow step's outputs and evidence are written to
MIGKIT_PORTABLE_FORMAT_VERSIONwhole1schema version stamped on portable state and manifest exports
MIGKIT_PREFLIGHTtext-warn: say what would stop a run and go on
MIGKIT_PROBE_FROMwhole268435456the table size from which a copy's first stretch is timed
MIGKIT_PROBE_SECONDSnumber1.5how long a copy's first stretch is timed for
MIGKIT_PROOF_COLD_LEAVESwhole256how many of those are read in one check
MIGKIT_PROOF_COLD_SECONDSnumber300the age after which a kept proof's parts are read again
MIGKIT_PROOF_OLDEST_SECONDSnumber86400the age after which every part is read again
MIGKIT_READ_TIMEOUTwhole3600seconds one MySQL read may take
MIGKIT_REPAIR_TEXTflagofflet the repair of double-encoded text write its fixes to the target; off, it only says what it would change
MIGKIT_REPORTSpath-where reports and the state of runs are kept
MIGKIT_RING_BUFFER_BYTESwhole-memory ceiling in bytes for store-and-forward ring buffer
MIGKIT_SAFE_TEST_IPSlist-synthetic IPv4 addresses exempt from privacy redaction in support bundles
MIGKIT_SCHEDULEDflagoffthe command runs in its hop's schedule
MIGKIT_SCHEDULE_RESUMEflagoffgo on with a schedule its last slots stopped
MIGKIT_SECOND_READER_PYTHONpath-the interpreter the second reader runs in
MIGKIT_SECRETStext-where init keeps the passwords it is given: keychain or env
MIGKIT_SEED_START_WAITnumber-seconds a copy of the pages is given to start
MIGKIT_SOURCEtext-the source's address for init, and for a step that writes its hop
MIGKIT_SOURCE_PASSWORDsecret-the source's password for init, and for a copy migkit runs in a process of its own
MIGKIT_STALL_SECONDSnumber300seconds without progress before a copy is ended as stalled
MIGKIT_STANDBY_SECONDSnumber15the 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_SIZEwhole-initial rows per batch for adaptive execution bounds
MIGKIT_START_WORKERSwhole-initial concurrent worker count for adaptive execution bounds
MIGKIT_STATE_KEYsecret-the passphrase restore points and state kept away from the machine are sealed with
MIGKIT_STORE_FORWARDflagoffenable store-and-forward ring buffer stream
MIGKIT_SUBSCRIBE_TIMEOUTwhole-seconds a subscription is given to copy and catch up
MIGKIT_TABLE_COPYtext-one way every table of a copy between two engines takes where it holds, forced for measuring
MIGKIT_TAIL_APPLY_ALLflagoffapply every change, for measuring what the tail leaves out
MIGKIT_TARGETtext-the target's address for init
MIGKIT_TARGET_ENGINEtextpostgresdefault target database engine assumed by lineage evidence analysis
MIGKIT_TARGET_PASSWORDsecret-the target's password, the same way
MIGKIT_TARGET_VERSIONtext15.0default target engine version assumed by lineage evidence analysis
MIGKIT_TELEMETRYflagonproduct telemetry, kept on this machine and never sent: off stops it and deletes what was kept
MIGKIT_TELEMETRY_POLICYpath/etc/migkit/policy.yamlthe organisation's policy file; telemetry: off or egress: none in it turns telemetry off for everyone
MIGKIT_TELEMETRY_SPOOLpath-where telemetry events are kept, where not beside the state of runs
MIGKIT_TOOLSpath~/.migkit/toolswhere migkit keeps the programs it builds for itself
MIGKIT_UI_BINDtext127.0.0.1the address the web view (and the dashboard) listens on; for the web view, anything but this machine's loopback needs TLS
MIGKIT_UI_HOSTSlist-more host names the web view and the dashboard answer to
MIGKIT_UI_PROXY_SECRETsecret-the secret a signing-in proxy sends in X-Migkit-Proxy: without it the user header is not believed
MIGKIT_UI_USER_HEADERtext-the header a signing-in proxy names the dashboard's user in
MIGKIT_VERIFY_SLOT_BEFORE_SNAPSHOTflagoffverify logical replication slot exists before snapshot export
MIGKIT_WEB_IDLE_MINUTESnumber60minutes without a request before a sign-in ends
MIGKIT_WEB_OIDC_CLIENT_IDtext-the client the provider registered for the web view
MIGKIT_WEB_OIDC_CLIENT_SECRETsecret-its secret, or a reference to where it is kept
MIGKIT_WEB_OIDC_GROUPStextgroupsthe claim a person's groups are in
MIGKIT_WEB_OIDC_ISSUERtext-the OpenID Connect provider people sign in through, its issuer's address
MIGKIT_WEB_OIDC_SCOPESlistopenid,email,profilethe scopes asked for
MIGKIT_WEB_PLAINflagoffserve 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_PROXIESlist-the addresses of the reverse proxies in front of the web view: the only ones answered, and whose forwarded headers are read
MIGKIT_WEB_RESETflagoffprint an address that sets the local operator's password again
MIGKIT_WEB_SAML_ENCRYPTEDflagoffdemand an encrypted assertion from the SAML identity provider: a plain one is refused
MIGKIT_WEB_SAML_GROUPStextgroupsthe attribute a person's groups are in
MIGKIT_WEB_SAML_METADATApath-the SAML identity provider's metadata, as it publishes it
MIGKIT_WEB_SAML_NAMEtext-the attribute naming the person, where not the name identifier
MIGKIT_WEB_SCIM_TOKENsecret-the bearer token the provider provisions people and groups with; set, only people it provisioned sign in
MIGKIT_WEB_SESSION_HOURSnumber12the longest a sign-in lasts
MIGKIT_WEB_STATEpath~/.local/share/migkit/webwhere the web view keeps its sessions, the people provisioned and its signing key
MIGKIT_WEB_TLS_CERTpath-the web view's certificate (PEM, its chain after it)
MIGKIT_WEB_TLS_KEYpath-the certificate's private key
MIGKIT_WEB_TOKEN_DAYSnumber90the longest an API token lasts
MIGKIT_WEB_URLtext-the address people open the web view at, https:// behind a proxy or with a certificate
MONGO_IGNORE_ROLESlist-MongoDB roles the account checks leave out, beside the providers' own
MONGO_IGNORE_USERSlist-MongoDB accounts the account checks leave out, beside the providers' own
MIGKIT_<HOP>_<SIDE>_PASSWORDsecret-a password a hop's reference names