paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 46 Packages Projects Releases Wiki Activity

optional -> onPluginBootFailure

Browse Source 
Signed-off-by: Tim Hansen <timbonicush@spotify.com>
This commit is contained in:
Tim Hansen
2025-02-13 08:32:30 -07:00
parent 1d7a9277f4
commit 667fdb6766
5 changed files with 50 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-app-api/config.d.ts
Vendored
+13 -10
View File
@@ -27,22 +27,25 @@ export interface Config {
startup?: {
default?: {
/**
* The default value for `optional` if not specified for a particular plugin. This defaults to
* false, which means `optional: true` must be specified for individual plugins to be considered
* optional. This can also be set to true, which flips the logic for individual plugins so that
* they must be set to `optional: false` to be required.
* The default value for `onPluginBootFailure` if not specified for a particular plugin.
* This defaults to 'abort', which means `onPluginBootFailure: continue` must be specified
* for backend startup to continue on plugin boot failure. This can also be set to
* 'continue', which flips the logic for individual plugins so that they must be set to
* `onPluginBootFailure: abort` to be required.
*/
optional?: boolean;
onPluginBootFailure?: 'continue' | 'abort';
};
plugins?: {
[pluginId: string]: {
/**
* Used to mark plugins as optional, which allows the backend to start up even in the event
* of a plugin failure. Plugin failures without this configuration are fatal. This can
* enable leaving a crashing plugin installed, but still permit backend startup, which may
* help troubleshoot data-dependent issues.
* Used to control backend startup behavior when this plugin fails to boot up. Setting
* this to `continue` allows the backend to continue starting up, even if this plugin
* fails. This can enable leaving a crashing plugin installed, but still permit backend
* startup, which may help troubleshoot data-dependent issues. Plugin failures for plugins
* set to `abort` are fatal (this is the default unless overridden by the `default`
* setting).
*/
optional?: boolean;
onPluginBootFailure?: 'continue' | 'abort';
};
};
};