Feature Flags ​
To configure Busola, override the default values of its defaultConfig.yaml file.
Features Priority ​
Initialization of the Busola features is based on the stage property, which can take one of the following values:
PRIMARY- the feature is resolved while the application bootstraps. Features that must be immediately visible must be set asPRIMARY, for example, the main navigation structure.SECONDARY- the feature is resolved after the application is ready, it must be used for non-critical features, for example, additional navigation nodes.
If the stage property is not set, the feature is loaded only on demand, most often by an iframe. Use the useFeature hook to request usage of such a feature.
NOTE
Some features must be run before the application starts the bootstrap process, so they are out of the ordinary feature flow.
Configurable Flags for Frontend ​
TIP
The list is in alphabetical order.
This table lists the frontend configurable feature flags, their descriptions, and default values.
| Feature flag | Description | Default value |
|---|---|---|
| EXTENSIBILITY | Indicates whether the Busola extensibility feature is enabled. | isEnabled: true |
| EXTENSIBILITY_CUSTOM_COMPONENTS | Indicates whether any custom extensions can be added to Busola. See Set Up Your Custom Busola Extension. | isEnabled: false |
| EXTENSIBILITY_INJECTIONS | Indicates whether extensibility injections can be added to Busola. For more information, see Widget Injection. | isEnabled: true |
| EXTERNAL_NODES | Provides a list of links to external websites. category: a category name, icon: an optional icon, scope: either namespace or cluster (defaults to cluster), children: a list of pairs (label and link). |
|
| FEEDBACK | Determines whether the feedback icon, which redirects the user to the survey, is displayed in the top bar. |
|
| GET_HELP_LINKS | Shows or hides helper links. In config, you can find the unchangeable keys (for example, you cannot use helpSapCom instead of help-sap-com). The keys include the default link, which takes you to the default address. |
|
| HIDDEN_NAMESPACES | Defines a list of namespaces that are considered system and are hidden by default. |
|
| KUBECONFIG_ID | Configures the URL to which Busola sends a request to download a kubeconfig file. If you add ?kubeconfigID={your ID} to the Busola URL, Busola tries to download the kubeconfig from {kubeconfigUrl}/{yourID}. If the operation succeeds, Busola adds the kubeconfig file to the cluster. If you use a full address in the kubeconfigUrl field, Busola also reads it. With the optional showClustersOverview you can instruct Busola to show Clusters Overview rather than the current context cluster, after the clusters are loaded. defaultKubeconfig defines the optional default KUBECONFIG_ID to load this kubeconfig when you visit Busola homepage / and there are no saved clusters in the application. |
|
| LEGAL_LINKS | Shows or hides legal links. In config, you can find the unchangeable keys (you cannot use legalDisclosure instead of legal-disclosure). The keys include both the default link, which takes you to the default address, and a link that depends on your chosen language. The link under the given key is selected based on your language code (de, en, pl, and more). If the code is not available, the default link is used. |
|
| PROTECTED_RESOURCES | Blocks the edit and delete functions based on the determined rules. If the resource meets the rule requirements, the resource becomes protected and cannot be edited/deleted. Each resource requires the match field, which includes a list of key-value pairs. The proper rule description is when the definition given in the key matches the value. To switch comparison mode from standard to regex, set the regex parameter to true. Optionally, you can provide the message parameter, which displays a simple message, or messageSrc, which is a YAML path where the message to be displayed is included. If neither message nor messageSrc is provided, a generic message is used. |
|
| RESOURCE_VALIDATION | Determines the selected policies for resource validation. They can be overwritten in the user settings. |
|
| SENTRY | Enables monitoring of uncaught exceptions, which are then analyzed and repaired. The address to which you send the information is located under the dsn key. |
|
| SNOW | Determines if the snow animation is enabled in Busola. | isEnabled: false |
Configurable Flags for Backend ​
NOTE
Backend features cannot be modified at the cluster ConfigMap level.
| Feature flag | Description | Default value |
|---|---|---|
| GZIP | Indicates whether responses from the backend server should be compressed. | isEnabled: true |