Install with Helm Chart

Configure the Helm chart values file to install dynamic plugins during Red Hat Developer Hub deployment. The Helm chart approach provides fine-grained control over plugin packages and their initialization parameters.

Installing dynamic plugins using the Helm chart

You can deploy a Developer Hub instance by using a Helm chart, which is a flexible installation method. With the Helm chart, you can load dynamic plugins into your Developer Hub instance without having to recompile your code or rebuild the container.

To install dynamic plugins in Developer Hub using Helm, add the following dynamicPlugins parameters in your Helm chart:

  • plugins: the dynamic plugins list intended for installation. By default, the list is empty. You can populate the plugins list with the following fields:
    • package: a package specification for the dynamic plugin package that you want to install. You can use a package for either a local or an external dynamic plugin installation. For a local installation, use a path to the local folder containing the dynamic plugin. For an external installation, use a package specification from a public NPM repository.
    • integrity (required for external packages): an integrity checksum in the form of <alg>-<digest> specific to the package. Supported algorithms include sha256, sha384 and sha512.
    • pluginConfig: an optional plugin-specific app-config.yaml YAML fragment. See plugin configuration for more information.
    • enabled: enables the dynamic plugin if set to true. Default: true.
    • forceDownload: Set the value to true to force a reinstall of the plugin, bypassing the cache. The default value is false.
    • pullPolicy: Similar to the forceDownload parameter and is consistent with other image container platforms. You can use one of the following values for this key:
      • Always: This value compares the image digest in the remote registry and downloads the artifact if it has changed, even if you downloaded the plugin before.
      • IfNotPresent: This value downloads the artifact if it is not already present in the dynamic-plugins-root folder, without checking image digests. Note
        The pullPolicy setting is also applied to the NPM downloading method, although Always will download the remote artifact without a digest check. The existing forceDownload option remains functional, however, the pullPolicy option takes precedence. The forceDownload option might be deprecated in a future Developer Hub release.
  • includes: a list of YAML files using the same syntax.
Note

The system merges the plugins list in the includes file with the plugins list in the main Helm values. If both plugins lists mention a plugin package, the plugins fields in the main Helm values override the plugins fields in the includes file. The default configuration has the dynamic-plugins.default.yaml file, which has all of the dynamic plugins preinstalled in Developer Hub, whether enabled or disabled by default.

Example configurations

The following examples show how to configure the Helm chart for specific types of dynamic plugin installations.

Configuring a local plugin and an external plugin when the external plugin requires a specific configuration:

dynamicPlugins:
  plugins:
    - package: <alocal package-spec used by npm pack>
    - package: <external package-spec used by npm pack>
      integrity: sha512-<some hash>
      pluginConfig: ...

Disabling a plugin from an included file:

dynamicPlugins:
  includes:
    - dynamic-plugins.default.yaml
  plugins:
    - package: <some imported plugins listed in dynamic-plugins.default.yaml>
      enabled: false

Enabling a plugin from an included file:

dynamicPlugins:
  includes:
    - dynamic-plugins.default.yaml
  plugins:
    - package: <some imported plugin listed in dynamic-plugins.default.yaml>
      enabled: true

Enabling a plugin that an included file disables:

dynamicPlugins:
  includes:
    - dynamic-plugins.default.yaml
  plugins:
    - package: <some disabled plugin listed in dynamic-plugins.default.yaml>
      enabled: true # overrides enabled: false from the included file