datahub-mfe-configure-app
Configure a DataHub instance to load and display a Micro Frontend (MFE) app. Use when the user wants to register an MFE with DataHub, add an MFE to the nav sidebar, set up MFE config for local dev or production/k8s, or troubleshoot MFE loading issues.
datahub-project · Static checks on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add datahub-project/datahub-skills --skill datahub-mfe-configure-appAbout this skill
name: datahub-mfe-configure-app description: >- Configure a DataHub instance to load and display a Micro Frontend (MFE) app. Use when the user wants to register an MFE with DataHub, add an MFE to the nav sidebar, set up MFE config for local dev or production/k8s, or troubleshoot MFE loading issues.
Configure an MFE in DataHub
Walks through registering a Micro Frontend app with the DataHub frontend so it
loads at /mfe/<path> and optionally appears in the navigation sidebar. Covers
local development, production/k8s deployment, and troubleshooting.
Step 1: Gather Information
Use the AskQuestion tool to collect the following in a single call.
| Question | ID | Options |
|---|---|---|
| Are you configuring for local development or production/k8s? | env_target | Local development / Production / Kubernetes |
MFE app name — the name field inside new ModuleFederationPlugin({ name: '...' }) in the MFE's webpack.config.js. Must match exactly. | mf_name | testAppMFE / N/A - I'll fill it in later |
URL path where the MFE should be accessible, e.g. /dashboard (must start with /) | mfe_path | /test_page / N/A - I'll fill it in later |
remoteEntry.js URL, e.g. http://localhost:3002/remoteEntry.js | remote_entry_url | http://localhost:3002/remoteEntry.js / N/A - I'll fill it in later |
Display label for navigation, e.g. Team Dashboard | display_label | Test Dashboard / N/A - I'll fill it in later |
| Should the MFE appear in the left nav sidebar? | show_in_nav | Yes / No |
| Nav icon | nav_icon | ChartBar / Trophy / Gear / HandWaving / Lightning / MagnifyingGlass / Database / Users / Shield / Bell / Flag / Star / Heart / Cube / Table / Code / Globe / Rocket |
If env_target is Local development, ask one follow-up question using
AskQuestion before proceeding:
| Question | ID | Options |
|---|---|---|
| How are you running DataHub locally? | local_mode | Docker / datahub-dev.sh (standard) / Play server directly (sbt / IntelliJ) |
For the N/A - I'll fill it in later fields (mf_name, mfe_path,
remote_entry_url, display_label), do NOT invent or suggest values from the
workspace. The user will type their own.
Finding the MFE app name: Open the MFE's
webpack.config.jsand look for theModuleFederationPluginblock. Thenameproperty is what goes here:new ModuleFederationPlugin({ name: 'teamDashboardMFE', ... }) // ^^^^^^^^^^^^^^^^^ ← this valueIf the name in the YAML config doesn't match this exactly, the MFE will fail to load. If you used the
datahub-mfe-create-appskill, the name was printed in the summary as "Module Federation name".
Step 2: Generate the YAML Config Entry
Build the config entry from the gathered values:
- id: __MFE_ID__
label: __DISPLAY_LABEL__
path: __MFE_PATH__
remoteEntry: __REMOTE_ENTRY_URL__
module: __MF_NAME__/mount
flags:
enabled: true
showInNav: __SHOW_IN_NAV__
navIcon: __NAV_ICON__
Where __MFE_ID__ is derived from the path (strip leading /, replace /
with -), e.g. path /dashboard becomes id dashboard.
Step 3: Apply the Configuration
Local Development — Docker / datahub-dev.sh (standard)
The Docker image has MFE_CONFIG_FILE_PATH baked in at build time pointing to
/datahub-frontend/conf/mfe.config.dev.yaml (set in docker/datahub-frontend/Dockerfile).
**This is the file to edit for any Docke