Installing the Plug-in Development Kit

Download and install the Plug-in Development Kit to start building custom projects.

Procedure

  1. Download the Plug-in Development Kit (PDK):
    • On the Welcome page of the console, click the Download Tooling link, and select the Plug-in Development Kit.
  2. Extract the .zip file into a directory.
    The following files are extracted into the directory:
    File or directory Description
    docs Contains documentation for the PDK.
    • docs/index.html Open this file with your web browser to view a list of links to the documentation in the docs directory.
    • docs/PDKSampleUsersGuide.pdf
    • docs/javadoc

      This directory contains Javadoc for Cloud Pak System interfaces that the plug-ins can invoke from the Java™ code.

    • docs/pydoc

      This directory contains documentation for the maestro module that is used in lifecycle Python scripts for nodeparts and parts.

    iwd-pdk-workspace The root directory of your development workspace. Each software package, script package, plug-in, pattern type has its own project directory in this root directory. These directories can be used directly from the command line or imported into Eclipse as plug-ins.
    com.ibm.maestro.plugin.pdk.site.zip Contains an Eclipse plug-in that you can use in your Eclipse or Rational® Application Developer environment to create and edit some of the configuration files for your projects. For more information, see "Installing the Plug-in Development Kit Eclipse plug-in."
    pdk-debug-{version}.tgz This file is the debug plug-in that can be installed into the Cloud Pak System instance and used to develop and debug the plug-ins. The plug-in includes features to deploy and debug a topology document, which is a JSON object, and debug plug-in installation and lifecycle Python scripts on deployed nodes. It does not support debugging for Java code in plug-ins. For more information, see "Debug plug-in."
    pdk-unlock-{version}.tgz Use the unlock plug-in to delete a plug-in that is in use by a deployed application, replace it with an updated version, and activate the modified plug-in on deployed virtual machines in the application. For more information, see "Unlock plug-in."

What to do next

Set up the development environment.