There are two ways to install a plugin, the fully automated “Available Plugins” view and the “Upload Plugin” button, which accepts a zip file of the plugin code. Both are found in Kaholo Settings. Represented in the UI by the puzzle-piece-shaped icon, Plugins is the default page in Settings.
In Kaholo Settings | Plugins there are two tabs, Installed Plugins and Available Plugins. Installed Plugins are the plugins that are already installed. Available Plugins is a collection of packages served by a Kaholo repository, ready for one-click installation.
In the example below, the Helm plugin may be installed and the Google Cloud Kubernetes Engine plugin may be upgraded by clicking on the provided buttons in the right column.
Available Plugins are keyword searchable, so for example if working with a “container” and searching on that term, one will quickly find the Docker, Helm, and Kubernetes plugins.
Packaging and providing plugins in Available Plugins is a work in progress. The collection grows as each plugin is tested and released since the Available Plugins feature was introduced in mid 2023. If there is a specific plugin you’d like to see in the Available Plugins, or if you cannot find an appropriate plugin for your task at hand, please contact us.
Upload a Plugin
For plugins not listed in Available plugins, non-standard or otherwise customized plugins, Settings | Plugins has an “Upload Plugin” button. This allows the user to select a zip file for upload and installation as a Kaholo plugin. The Kaholo platform validates the plugin before installing. The requirements include:
- The zip file must be flat, not with main components in subdirectories.
- Must contain a file named
config.jsonwith a valid Kaholo plugin configuration for the plugin.
- Must be installable using npm install, including a valid
Note that using the “Download ZIP” feature in GitHub will not work because GitHub zips the files into a subdirectory named after the repository, i.e. not flat. For more details how to package and install a plugin, see the
INSTALL.md file included in most plugin repositories.