Set it up
1
Create an enrollment token
In your project, open step 1 of the setup (or Gateways, then Set up
a gateway), choose A server (Docker), keep Midplane URL, and
under Runs on choose Render. Click Create enrollment token,
above the tabs, and keep the page open.
2
Deploy the Blueprint
Click Deploy to Render, name the Blueprint, and apply it. Render makes
the worker and its disk. Its first start says
no config and stops: it
has no env file yet.3
Add the env file
In the worker’s Environment, choose Add from .env, paste the file
the page shows with each database’s connection string after its
=
(prepare your database), and save, choosing to
deploy.4
Check it on the page
The gateway sets itself up from the environment, joins your project,
and gets its certificate through the relay. The page then shows its URL
for agents. The worker’s Logs show what it says.
Run it
- A connection string changes. Change it in Environment and deploy.
- A database is added later. First append the database’s line to
/var/lib/midplane/midplane.yaml, in the worker’s Shell. Then add itsMIDPLANE_DSN_<ID>in Environment and deploy, so the gateway starts with both: the variable alone is ignored once the gateway has set itself up (adding databases). - Upgrade. In the worker’s Settings, change the image’s tag to the new version, and deploy (upgrading). The disk, and with it the gateway, stays.
- Remove it. Revoke the gateway on your project’s Gateways page, then delete the worker, which deletes its disk with the audit log.
deploy/render/render.yaml.
Tested by apps/gateway/test/deploy-templates.test.ts (one worker, the
version’s image, the gateway’s folder on its disk, no variable in the
Blueprint).