Using Plug-In Workflow Steps

Embotics provides plug-in workflow steps for common DevOps scenarios from the publicly accessible Embotics GitHub Repository. You can download packages of grouped plug-in workflow steps, as required, and add them to your vCommander installation (version 7.0.2 or higher).

Using these plug-in steps can save you development time when compared to creating custom workflow steps in house. It is also allows you to download workflow steps that are specifically suited to your development needs, only when you need them. You can use plug-in steps in a workflow as long as the workflow types and target types match.

Plug-in steps are provided in JAR (Java ARchive) packages that can contain one or more workflow steps defined as YAML files. Each step can be used independently in a workflow. Multiple steps may be present in a JAR file, because they are related to common tasks.

When you are creating or editing a workflow, any plug-in steps that have been added to your system will appear as available steps in the Workflow configuration dialogs.

In this topic:

Adding plug-in workflow steps

To add plug-in workflow steps to your system:

  1. Go to the Embotics GitHub Repository (https://github.com/Embotics/Plug-in-Workflow-Steps) and download the Plug-in-Workflow-Steps repository. This repo contains plug-in workflow step JAR packages that plug-in workflow steps that you can use in vCommander.
  2. Stop the vCommander service.

    See Managing vCommander Services with the Control Panel for information.

  3. To add plug-in workflow steps to your vCommander installation, copy the downloaded JAR file to the wfplugins directory of your vCommander installation (<vCommander_install_directory>\tomcat\wfplugins\).
  4. Restart the vCommander service, then log in to vCommander.

    Now when you are creating or editing a workflow, any added plug-in workflow steps will appear at the bottom of the list of available steps in the Workflow Configuration dialog.

    When you add a JAR file that contains a collection of related plug-in steps, they will be grouped together. For example, below, Kubernetes, PKS, Snapshot, and Text Processing are all collections of related plug-in steps.

    Pluggable Workflow Steps

Removing plug-in workflow steps

To remove plug-in workflow steps from a vCommander installation:

  1. Edit each workflow and module that includes the plug-in steps and remove those plug-in steps.

    If you don't remove the plug-in steps from workflows and modules before you remove the plug-in step JAR from the system, unexpected behavior may occur when you try to import, export, or run those workflows and modules. This is because the workflow definition will refer to a plug-in, which will no longer exist on the system.

  2. Stop the vCommander service.

    For information on how to start, stop and restart the vCommander service, see Managing vCommander Services with the Control Panel.

  3. Remove the JAR file that contains the steps you no longer want to appear in the Workflow configuration dialogs step from the wfplugins directory of your vCommander installation (<vCommander_install_directory>\tomcat\wfplugins\).
  4. Restart the vCommander service, then log in to vCommander.

    The workflow steps included that JAR file will no longer be available in the Workflow configuration dialogs.

Updating plug-in workflow steps

If there are updates to a group of plug-in workflow steps that you have installed, you can replace the installed JAR to use the updated plug-in workflow steps.

To update plug-in workflow steps:

  1. Go to the Embotics GitHub Repository (https://github.com/Embotics/Plug-in-Workflow-Steps) and download the updated JAR package file.

    By default, the JAR file will be saved to your local Downloads directory. However, depending on your browser, you may be able to change the directory it's downloaded to.

  2. Ensure that the vCommander service is not running.

    For information on how to start, stop, and restart the vCommander service, see Managing vCommander Services with the Control Panel.

  3. Remove the JAR file that you want to replace from the wfplugins directory of your vCommander installation (<vCommander_install_directory>\tomcat\wfplugins\).
  4. Copy the updated JAR file that you downloaded to the same wfplugins directory.
  5. Restart the vCommander service, then log in to vCommander.

    Now when you are creating or editing a workflow, the updated plug-in workflow steps will appear as available steps in the Workflow configuration dialogs.