Overview

Workflow agent is currently controlled by Docker. When the Workflow Agent software is installed, some new images are added from disk. Some volumes (local storage) and a network are also created.

There are several ways to remove the software, depending on the level required. The simplest method is to remove the current version via docker-compose, but this article contains some contingency methods to remove the components manually using docker itself.

Simple Removal

The simplest method of removal is to use docker-compose to undo the changes made. This assumes Workflow Agent is installed in the default directory, (~/WorkflowAgent) and that the service is currently running.

cd ~/WorkflowAgent 
docker-compose down -v --remove-orphans --rmi all

By entering this, all of the software will be removed, but there will still be docker images left over from the installation. These will have to be removed manually.
This can be done individually:

docker image rm workflow-agent-core:<version>
docker image rm workflow-agent-db-migration:<version>
docker image rm workflow-agent-nodered-engine:<version>

This can also be done more aggressively using the following method.

NOTE: This will remove all images regardless of if they are part of Workflow Agent or not. If your docker installation manages other images, this may have unforeseen consequences.

docker image prune -a

At this point you can check the images are removed using the following command:

docker images

This will list all the available images. 

At this point, if you do not plan to install another image, the entire ~/WorkflowAgent directory can be removed. 

NOTE: Do not do this if you wish to reinstall it later.

Removal by Docker Commands

For a more nuanced uninstallation, the docker components can be manually removed.

First, the docker container needs to be stopped as normal:

cd ~/WorkflowAgent 
docker-compose down

Then the components can be removed individually:

docker image rm workflow-agent-core:<version>
docker image rm workflow-agent-db-migration:<version>
docker image rm workflow-agent-nodered-engine:<version>

The current images will also need to be removed:

docker image rm workflow-agent-core:current
docker image rm workflow-agent-db-migration:current
docker image rm workflow-agent-nodered-engine:current

Any created volumes should then be removed:

docker volume rm workflowagent_local-logs
docker volume rm workflowagent_local-mysql-data
docker volume rm workflowagent_local-nodered-data
docker volume rm workflowagent_local-workflows

Following this, no images or volumes related to Workflow Agent should be left over.