mirror of
https://github.com/apache/superset.git
synced 2026-04-09 03:16:07 +00:00
2.2 KiB
2.2 KiB
title, sidebar_position
| title | sidebar_position |
|---|---|
| Deploying an Extension | 8 |
Deploying an Extension
Once an extension has been developed, the deployment process involves packaging and uploading it to the host application.
Packaging is handled by the superset-extensions bundle command, which:
- Builds frontend assets using Webpack (with Module Federation configuration).
- Collects backend Python source files and all necessary resources.
- Generates a
manifest.jsonwith build-time metadata, including the contents ofextension.jsonand references to built assets. - Packages everything into a
.supxfile (a zip archive with a specific structure required by Superset).
Uploading is accomplished through Superset's REST API at /api/v1/extensions/import/. The endpoint accepts the .supx file as form data and processes it by:
- Extracting and validating the extension metadata and manifest.
- Storing extension assets in the metadata database for dynamic loading.
- Registering the extension in the metadata database, including its name, version, author, and capabilities.
- Automatically activating the extension, making it immediately available for use and management via the Superset UI or API.
This API-driven approach enables automated deployment workflows and simplifies extension management for administrators. Extensions can be uploaded through the Swagger UI, programmatically via scripts, or through the management interface:
https://github.com/user-attachments/assets/98b16cdd-8ec5-4812-9d5e-9915badd8f0d