Tools8.1 delivered by custom CLC plugins are supported for cloud analyses when:
- Server plugins are placed in a plugin repository that has the expected file organization (described below).
- The server plugins have the name
- The location of the custom plugin repository is configured when setting up the standard CLC Genomics Cloud infrastructure on AWS, as described at Establishing resources on AWS.
When the above requirements have been met, analyses using tools delivered by a custom plugin can be run on the cloud. The corresponding plugin in the custom repository is used for the cloud-based execution.
The custom plugin repository must have the structure and contents defined below. The term
<workbench_plugin_id> refers to the value of that field in the plugin.properties file.
- A top level folder per plugin. The folder name must be
- A subfolder named
- Within the
serverfolder, a subfolder with the name of the version of the plugin. e.g. "23.0" or "22.0.2".
This name must be the version of the plugin. This may be different to the version or your CLC Workbench or CLC Server.
- The plugin .cpa file and any other relevant files (e.g. plugin.properties) must be placed in this folder.
The plugin .cpa file must be named as
For example, a server plugin with the
example_plugin and version
23.0, the following structure in the plugin repository would be expected:
example_plugin/ server/ 23.0/ example_plugin.cpa plugin.properties
When a job is launched to run on the cloud, the exact version of the plugin in the CLC Workbench or CLC Server must be available in the repository. If it is not, the job will fail.
- Only tools that can be used within workflows can be submitted to run on a CLC Genomics Cloud. Tools that are not workflow-enabled cannot be run on the cloud.