[RemoteSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [RemoteSettings] of settings/migration.ini.
File
settings/migration.ini; override it in settings/override/migration.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| RemoteList[] | (empty array) | Remotes: other installations this one deploys its migrations to (./console exp:migration:deploy --remotes=...), all at once and in sync. One [Remote_<id>] section for each id of RemoteList[]; set them in settings/override. A remote section never holds a secret: Credential names one of the secret store (Setup > Secrets) or an environment variable (env:VARIABLE). Guide: doc/eng-us/guides/migrations-remote-deploy.md [Remote_production1] Environment=production alpha, dev, stage, beta, production, post, arch ... (the label reports show) Transport=rsync ssh (scp), sftp, rsync (over ssh), ftp, ftps (files only), local (this host) Host=node1.example.com Port=22 User=deploy Path=/var/www/site the installation's root on the remote Php=php the PHP CLI there Credential=sshkey:deploy_production1 Groups[]=production --remotes=production selects every remote of the group HostKeyFingerprint=SHA256:... optional: the host key must have it (else it is learnt on first contact) Trigger=https://node1.example.com/migration/trigger ftp and ftps only: the remote's signed HTTP trigger runs the migrations there ([TriggerSettings] on the remote); without it FTP only sends TriggerSecret=trigger_node1 the secret the trigger's requests are signed with (a secret name or env:VARIABLE) |
| Parallel | 4 | How many remotes are worked on at the same time. The switch (every remote applies) always runs on all at once. |
| Timeout | 900 | Seconds one remote may take for one phase (preflight, transfer, verify, switch, rollback). |
| Retries | 2 | How often a connection failure (ssh exit 255, a timeout, a dropped FTP transfer) is tried again in the preflight, the transfer and the verification. A run on a remote is never started twice. |
| StoreReports | enabled | enabled: every deploy that sends or runs something keeps its report in var/<site>/migration/deploy/reports/. |
| StageOrder[] | alpha; dev; test; stage; beta; production; post; arch | A staged deploy (--staged, the administration's "Staged") puts the remotes in stages by their Environment, in this order (an environment that is not listed comes last); each stage is switched all or nothing, and a gate waits for someone to approve the next one (--continue=<deploy id>, or Approve on the deploy's page). |
| Notify[] | failure; gate | Notices by e-mail about a deploy: failure (refused, failed, taken back, out of sync), gate (a staged deploy waits for approval), success (deployed or transferred). Plain text, mail category admin. |
| NotifyEmail | (empty) | Where the notices go; empty: site.ini [MailSettings] AdminEmail. |
| SelfHeal[] | (empty array) | Self-healing: the fixes a deploy may make on a remote (./console exp:migration:heal there), each only when listed, each written to the remote's fixes in the report. Before the preflight: stale-lock (a run lock whose process is gone, older than StaleLockAge, held on that host by the same user), paths (missing migration folders), modes (the permissions of [FileSettings] on the migration folders and var/<site>/migration, only added); after the switch: caches (ini and template-override). Never fixed, only reported: PHP or extension versions, a migration's own error. |
| StaleLockAge | 7200 | Seconds from which a held run lock whose process is gone counts as stale (SelfHeal[]=stale-lock). |
| DiskMargin | 50M | The free disk space a remote must have beyond the size of the files a deploy sends to it (bytes, or with K, M, G). |
| PhpCheck | major | The PHP version of a remote against this installation's: major (the same major version, else the deploy stops), minor (the same major.minor), warn (a difference is only a warning), off. |
| ExtensionCheck | migrations | The extensions of a remote against this installation's: migrations (every extension whose migrations are sent is active there with the same version, else the deploy stops; other differences are warnings), all (every active extension), warn (differences are only warnings), off. |
See also
Generated example: migration.ini [RemoteSettings]
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/migration.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment