Repository navigation
docs: describe the single binary and plugin sideloading - #837
Merged
Merged
Conversation
`make build` now produces one `bin/lake` with the framework, the API and every official plugin compiled in, and a deployed binary still loads extra `.so` plugins from PLUGIN_DIR. - Rewrite the "Compiling" section, which was rendered as a code block and documented two things that do not exist: `PLUGIN=<name>` (the variable is DEVLAKE_PLUGINS) and `make build-worker`. - Add a "Sideloading plugins" section: where the .so files go, why they must be built with the matching toolchain, and that a plugin which fails to load is skipped rather than taking the server down. - Document PLUGIN_DIR in the environment variables reference, including the container mount path and the override warning.
The image ships one binary with every official plugin, so adding a plugin means mounting a directory over /app/bin/plugins rather than rebuilding it. Adds an FAQ entry with the compose snippet, the naming/override rule and the "build it in the matching lake-builder image" constraint.
klesh
marked this pull request as ready for review
October 31, 2026 04:54
The build no longer produces one .so per plugin for the release: a generated registry links every official plugin into bin/lake, and the image ships that binary alone. Document the model where plugin authors and operators will look for it. - Architecture: state that official plugins are compiled into the lake binary, and add a "Plugin packaging" section covering the generated registry, DEVLAKE_PLUGINS/GO_PLUGINS selection, Python plugins, and how PLUGIN_DIR sideloading fits on top. - Plugin implementation: describe how a plugin gets into the registry, how to regenerate it, the core-only builds, and when to sideload instead. - Developer setup: note the checked-in registry and the CI drift check, the debug build flag, and document how to build a core-only server.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the packaging change tracked in apache/devlake#9276: DevLake ships as one
lakebinary containing the framework, the API and every official plugin, chosen at build time from a generated registry, and a deployed binary still loads extra.soplugins fromPLUGIN_DIR.Five files:
docs/Overview/Architecture.md— says the official plugins are compiled into the server binary, and adds a "Plugin packaging" section: the generatedplugins/allregistry,DEVLAKE_PLUGINS/GO_PLUGINSselection, Python plugins, and where sideloading fits.docs/DeveloperManuals/PluginImplementation.md— how a plugin becomes part of the binary: theplugins/*/impllayout, the generated registry, when to regenerate it, core-only builds, and when to build a.soand sideload instead.docs/DeveloperManuals/DeveloperSetup.md— the "Compiling" section was indented four spaces, so it rendered as a code block, and it documented two things that do not exist:PLUGIN=<name>(the variable isDEVLAKE_PLUGINS) andmake build-worker. Rewritten for the single-binary default, with theDEVLAKE_PLUGINSsubset, the registry drift check, the debug build flag, and the core-only andmake build-pluginpaths. A "Sideloading plugins" section explains where the.sofiles go, why they must be built with the matching toolchain, and that a plugin that fails to load is skipped instead of taking the server down.docs/GettingStarted/Environment.md— newPLUGIN_DIRentry: default value, the container mount path (/app/bin/plugins), the skip-on-failure behaviour and the override warning.docs/GettingStarted/DockerComposeSetup.md— FAQ entry showing the compose volume that sideloads a plugin into the image, since adding a plugin no longer means rebuilding the image.Dependency (merge after the implementation)
The behaviour described here lands in two
devlakePRs:make buildproduces one binary, and the image copies only that binary; the.sofiles never leave the builder stage.Both are merged into
feat/single-binary.Does this close any open issues?
Refs apache/devlake#9276.