close

Filter

loading table of contents...

Blueprint Developer Manual / Version 2512.1

Table Of Contents
During Blueprint Build: Download and Include Plugins with Docker Images

It is also possible to include plugins directly with your Docker images. The process to do that is similar to the one of the Blueprint extensions, but more lightweight.

A plugin consists of one or more application-plugins for different applications of the CoreMedia system. The plugin-descriptor maps the application-plugin links to the applications.

Next to workspace-configuration/extensions is a workspace-configuration/plugins directory where you can configure the plugins you want to bundle. You can either provide plugin-descriptor files in the plugin-descriptors subdirectory directly, or reference them as URLs in the plugin-descriptors.json file.

To add the referenced application-plugins to the respective application workspaces, execute mvn generate-resources in the workspace-configuration/plugins directory. This will parse the plugin-descriptors and put the links of the application-plugins into plugins.json files in the corresponding application workspaces. The plugins.json files are then used in the build process of the distinct applications to download the application-plugins and add them to the Docker images.

In a particular project, you usually do not add or remove plugins very frequently, so this step is not part of the standard build turnaround. Therefore, it is recommended that you commit the changed plugins.json files to your version control system.

Workflow to add a Bundled Plugin

The recommended workflow to add a bundled plugin to your Blueprint is as follows:

  1. Go to workspace-configuration/plugins.

  2. Add the URL of the plugin-descriptor to the plugin-descriptors.json file.

  3. Execute mvn generate-resources.

  4. Commit the changes.

  5. Build the applications.

Removing a Bundled Plugin

To remove a bundled plugin, simply remove the descriptor from the plugin-descriptors.json file or the plugin-descriptors directory and re-run mvn generate-resources in workspace-configuration/plugins.

Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.