Manage extensions on sovereign executors
The Knime Executor installation contains three scripts to manage extensions without a graphical user interface. The scripts are in the root folder of the installation, next to the knime.ini file.
| Linux | Windows | Purpose |
|---|---|---|
list-extensions.sh | list-extensions.bat | List the extensions on one or more update sites, with the ID that the install step needs |
install-extension.sh | install-extension.bat | Install one or more extensions |
update-executor.sh | update-executor.bat | Update the executor and its installed extensions to the versions on the given update sites |
Before you install an extension, check Extensions in sovereign executors to see which extensions the executor already includes.
Before you start
The scripts have these requirements:
- Run the scripts as the user that owns the executor installation, for example knime. The install and update scripts change the installation folder and stop if the user has no write access to it.
- The executor must have access to the update sites. Without internet access, download the update sites as ZIP files and give their paths instead of the URLs.
- On Windows, always run the
.batfile. It starts the PowerShell script with the same name and bypasses the PowerShell execution policy, which blocks scripts from a downloaded ZIP file by default.
Run the commands from the executor installation folder. If you followed Setting up sovereign executors, this is the knime folder.
Each script prints its usage when you call it with --help.
Specify update sites
All three scripts take a comma-separated list of update sites as their first argument. The dedicated Knime Executor update site is https://update.knime.com/executor/5.13. It is public and requires no customer login.
Follow these rules for the list:
- Separate the update sites with commas, without spaces.
- Give a ZIP file by its path. The file name must end in
.zip. On Linux, use the absolute path. - On Windows, put the list in double quotes. Without quotes, PowerShell splits the list at the commas and the script uses only the first update site.
Some extensions, particularly from community update sites, depend on extensions from other update sites. List all update sites that the extensions and their dependencies come from. These update sites cover most cases:
https://update.knime.com/executor/5.13https://update.knime.com/community-contributions/5.13https://update.knime.com/community-contributions/trusted/5.13https://update.knime.com/partner/5.13
For ZIP downloads of update sites, see Knime Community Extensions and Knime Partner Extensions.
List available extensions
The list script prints a table with the name, the ID, and the version of each extension on the given update sites. Use the ID to install the extension.
On Linux:
shell
./list-extensions.sh https://update.knime.com/executor/5.13On Windows:
powershell
.\list-extensions.bat "https://update.knime.com/executor/5.13"To leave out the extensions that are already installed, add --not-installed before the list of update sites.
For example, list only the extensions that are not installed yet, and filter for Python.
On Linux:
shell
./list-extensions.sh --not-installed https://update.knime.com/executor/5.13 | grep -i pythonOn Windows, in PowerShell:
powershell
.\list-extensions.bat --not-installed "https://update.knime.com/executor/5.13" | Select-String pythonInstall extensions
The install script takes two arguments: the comma-separated list of update sites, and the comma-separated list of extension IDs. Take the IDs from the ID column of the list script. Each ID ends in .feature.group.
On Linux:
shell
./install-extension.sh https://update.knime.com/executor/5.13 org.knime.features.python3.scripting.feature.groupOn Windows:
powershell
.\install-extension.bat "https://update.knime.com/executor/5.13" "org.knime.features.python3.scripting.feature.group"To install several extensions, from one or more update sites, separate the entries of both lists with commas.
On Linux:
shell
./install-extension.sh https://update.knime.com/executor/5.13,/tmp/my-update-site.zip org.knime.features.python3.scripting.feature.group,org.example.feature.groupOn Windows:
powershell
.\install-extension.bat "https://update.knime.com/executor/5.13,C:\sites\my-update-site.zip" "org.knime.features.python3.scripting.feature.group,org.example.feature.group"The script exits with code 0 if the installation succeeds. To check the result, run the list script with --not-installed. The installed extensions no longer appear in the list.
Update the executor and installed extensions
The update script updates the executor itself and its installed extensions. It compares the installed versions with the versions on the given update sites, and installs the version from the update sites wherever they differ. Extensions that are not on the update sites stay unchanged.
Stop the agent first, and start it again after the script finishes. The executor must restart for the update to take effect.
On Linux:
shell
./update-executor.sh https://update.knime.com/executor/5.13On Windows:
powershell
.\update-executor.bat "https://update.knime.com/executor/5.13"Give the update sites of all installed extensions, not only the Knime Executor update site. The script does not update extensions from update sites that are missing from the list. If all extensions are up to date, the script prints No updates found.
To update the executor to a new feature release, follow Updating sovereign executors instead.
Uninstall extensions
No script uninstalls extensions. To uninstall extensions, start the knime executable with the p2 director application and the -u option. Run the command from the executor installation folder:
shell
./knime -application org.eclipse.equinox.p2.director -nosplash -consolelog -r {{update-sites}} -u {{features}} -d {{installation-folder}}Replace the placeholders:
NaN: A comma-separated list of update-site URLs. Unlike the scripts, the p2 director requires local ZIP repositories injar:file:/tmp/my-update-site.zip!/format. Quote the entire list, for example'https://update.knime.com/executor/5.13,jar:file:/tmp/my-update-site.zip!/'.: The comma-separated list of extension IDs to uninstall, each ending in.feature.groupNaN: The absolute path of the executor installation folder
Troubleshooting
If a script fails, it exits with a code other than 0 and prints the error. Check the last lines of the output for the cause.
- Missing installable units or unsatisfied dependencies: An extension or one of its dependencies is not on the given update sites. Add the missing update site to the list and run the script again.
Current user does not have write access to <folder>: Run the script as the user that owns the executor installation.- Stack traces with
Unable to locate secure storage module: The executor prints these stack traces when it looks up proxy settings. They do not affect the result. - A Windows script uses only the first update site or extension: Put the comma-separated lists in double quotes.
- No output for several minutes on Windows: The Windows scripts show the output only after the query or the installation is complete. A query against a remote update site can take several minutes.