Deleting deployed plug-in files by using a DevOps script
When you develop and deploy custom plug-ins in IBM® IoT Connected Vehicle Insights, it is sometimes necessary to undeploy and delete your deployed custom plug-in code files. For example, you might want to undeploy a custom plug-in file that you are testing.
If you are an IBM representative, or a Business Partner, you can delete custom plug-in files for a service by running a script from the DevOps server.
About this task
You can use the fileutil.sh script to work with the following components of IBM IoT Connected Vehicle Insights:
| Component | Permitted component_type command values |
|---|---|
| The Vehicle Data Hub (VDH) component | @vdh |
| The Agent system component | @agent |
| The online Driver Behavior component | @drbonline |
| The offline Driver Behavior component | @drboffline |
Important: As with the DevOps Plug-in Deployment REST API, while you can delete a specified custom plug-in code file, you cannot delete the following customizable IBM IoT Connected Vehicle Insights configuration files:
| Component | Protected file name |
|---|---|
| VDH | gateway.properties |
| VDH | hbaseMapper.xml |
| VDH | mapping_def.xml |
| VDH | pos_mapping_def.xml |
| Driver Behavior (online driving behavior analysis) | DrbCustomizableConfig.xml |
| Driver Behavior (offline driving behavior analysis) | DrbCustomizableConfig.xml |
To delete a specified custom plug-in code files by using the DevOps fileutil script, complete the following procedure:
Procedure
-
Log on to the DevOps server. If you have access to the DevOps server, your DevOps login credentials are provided in your customer welcome pack.
-
Navigate to the
/data/custom/workfolder. -
To verify the configuration file that you would like to delete, get a list of all plug-in files that are deployed to your service. Enter the following command:
$
../bin/fileutil.sh -t <component_type> --get_plugin_listWhere component_type is the target server component, as outlined in the About this task section.
-
Delete the specified configuration file by entering the following command:
$
../bin/fileutil.sh -t <component_type> --delete_plugin_files <file_name>Where component_type is as defined in the previous step, and file_name is the name of the file to be deleted.
Example
To delete a custom plug-in file called my_test_plugin.jar from the VDH component, enter the following command:
$ ../bin/fileutil.sh -t @vdh --delete_plugin_files my_test_plugin.jar
Next
- Continue to develop your custom plug-in JAR files by using the Eclipse Plug-in SDK. For more information, see Developing custom plug-ins.
- Accordingly, modify the downloaded plug-in configuration and code files to support your use cases and other requirements.
- Upload and deploy your customizations by completing the instructions in Deploying a plug-in file by using a DevOps script.