Download and Install the vRealize Orchestrator Plug-in SDK

You download and install the vRealize Orchestrator Plug-in SDK package on your local machine.

The procedure for downloading and installing the Plug-in SDK is required for vRealize Orchestrator 8.4 and later. For earlier versions of vRealize Orchestrator, you can access the SDK through the vRealize Orchestrator Appliance Maven repository. For more information, select EXPLORE DEVELOPER RESOURCES from the vRealize Orchestrator homepage.

Procedure

  1. Download the ZIP package that includes the Plug-in SDK.
  2. Install the SDK.
    1. Unzip the package that includes the Plug-in SDK.
    2. For Windows environments, run the install.ps1 script.
    3. For Mac OS or Linux environments, run the install.sh script.
      Note: By default, the install script does not accept arguments. The script installs the SDK to your default local Maven repository. However, you can specify a different installation location for a custom Maven repository by passing the path as an argument, such as the following:
      bash
./install.sh <custom-mvn-repo-location>
      Note: For more information regarding the Plug-in SDK, open the README.MD file in the SDK archive.
  3. Validate the installation, run the following command: 
    bash
mvn archetype:generate -Dfilter="com.vmware.o11n:"
    The Maven archetype:generate command generates projects from existing archetypes. After running the command, you should see a list of vRealize Orchestrator plug-in archetypes to choose from. This procedure verifies that the archetypes are present in your local Maven repository and the SDK installation is successful.
  4. (Optional) For existing plug-ins that you want to migrate to the new SDK, you should remove the `repositories` and `pluginRepositories` sections from the root `pom.xml` file of your project.
    Since you have installed the Plug-in SDK in your local Maven repository, you do not need to log into the vRealize Orchestrator Appliance to retrieve the SDK libraries and because of this, the pom.xml sections for a Maven repository are not needed. This step is not required but it is recommended. If your project uses internal vRealize Orchestrator libraries that are not present in the SDK ZIP package, you should try and find an alternative to them, but if finding an alternative is unfeasible, you should not do this step.
    If your plug-in depends on a package that is internal to vRealize Orchestrator and is not part of the SDK, see Can I use Maven packages that are internal to vRealize Orchestrator and are not part of the SDK in Introduction to the vRealize Orchestrator 8.x Plug-In SDK.
    It is recommended to move to an isolated ClassLoader for your plug-in in order to decouple its dependencies from the platform. See ClassLoaders.