Initialization & Sync Commands (./fm init, ./fm sync)
Initialize and synchronize FlowMaker instances with ConfigHub.
Initialize Instance (./fm init)
Initialize a new instance by setting up environment configuration, creating a default scheduler, and registering Hub app entries.
./fm init <instance>
Overview
The init command performs three main tasks:
- Environment Configuration - Sets CDN and DataCatalog URLs in ConfigHub
- Scheduler Creation - Creates a default "Scheduler 1" scheduler
- Hub App Registration - Upserts
flowmakeranddatacatalogin Hub API with frontend URLs
[WARNING!error/INSTANCE MUST BE RUNNING] ConfigHub must be accessible for initialization. The instance must be running.
[NOTE!info/INTERNAL API PATHS]
inituses internal network endpoints (non-ingressed) for initialization calls.
Examples
Basic Initialization
$ ./fm init v2
ℹ Initializing instance 'v2' via https://confighub.v2.flowmaker.localhost
=== Environment config ===
environment/cdn = https://cdn.v2.flowmaker.localhost
environment/datacatalog = {"url": "https://datacatalog-api.v2.flowmaker.localhost"}
=== Scheduler ===
Scheduler 1 url=https://scheduler.v2.flowmaker.localhost logger=https://logger.v2.flowmaker.localhost
=== Hub apps (hub-api/apps) ===
flowmaker frontend=https://frontend.v2.flowmaker.localhost
datacatalog frontend=https://datacatalog-ui.v2.flowmaker.localhost
? Reset environment config? [y/N]: y
✓ environment/cdn = https://cdn.v2.flowmaker.localhost
✓ environment/datacatalog = {"url": "https://datacatalog-api.v2.flowmaker.localhost"}
? Reset scheduler? [y/N]: y
✓ Scheduler created: https://scheduler.v2.flowmaker.localhost
? Upsert hub apps (flowmaker/datacatalog)? [y/N]: y
✓ Hub app upserted: flowmaker -> https://frontend.v2.flowmaker.localhost
✓ Hub app upserted: datacatalog -> https://datacatalog-ui.v2.flowmaker.localhost
Environment Configuration
| Key | Value | Description |
|---|---|---|
environment/cdn |
https://cdn.<domain> |
CDN URL for package serving |
environment/datacatalog |
{"url": "https://datacatalog-api.<domain>"} |
DataCatalog API URL |
Scheduler Creation
| Property | Value |
|---|---|
| Name | "Scheduler 1" |
| URL | https://scheduler.<domain> |
| Log Server URL | https://logger.<domain> |
| Color | Random pastel color |
| Is Default | true |
[NOTE!lightbulb/RANDOM SCHEDULER COLOR] The scheduler is assigned a random pastel color for UI identification. If scheduler already exists (HTTP 409 Conflict), it's updated instead.
Hub App Registration
init upserts two Hub app records:
| App ID | Frontend URL |
|---|---|
flowmaker |
https://frontend.<domain> |
datacatalog |
https://datacatalog-ui.<domain> |
Common Workflows
Fresh Instance Setup
./fm create dev
./fm up dev --workers
./fm init dev
Reset Scheduler
./fm init dev
# Say "n" to environment config
# Say "y" to scheduler
Troubleshooting
"Connection refused" to ConfigHub
./fm ps dev
./fm logs dev flowmaker-confighub
./fm down dev && ./fm up dev
Scheduler Not Appearing in UI
./fm init dev
./fm logs dev flowmaker-scheduler
Sync Versions (./fm sync)
./fm sync <instance>
Syncs instance versions from the release-tracker (if configured).
References
deployment/fm-cmd_initandcmd_syncfunctions- Deployment README
- Start Instance