< Previous | Next >

Configure the tutorial system

Before you can run the tutorial project, you must configure your IBM® UrbanCode Build and IBM UrbanCode Deploy environments.

Before you begin

Before you begin the tutorial, make sure that you meet the Prerequisites.

About this task

To complete the tutorial, you must have an installation of IBM UrbanCode Build and IBM UrbanCode Deploy. Your IBM UrbanCode Build agent must have access to the IBM UrbanCode Deploy server.

Procedure

  • To prepare the tutorial system.
    1. Prepare a computer for use as the target system. This computer must meet the system requirements that are listed in System requirements.
    2. Install the plug-ins that are used in the tutorial. The tutorial uses several plug-ins. Most of them are installed when you install the product, but you must install some plug-ins yourself. Download and install these plug-ins:
      • Git
      • JUnit

      You can download plug-ins from the IBM UrbanCode Build plug-in site: https://developer.ibm.com/urbancode/plugins/ibm-urbancode-build/. For information about installing plug-ins, see Installing plug-ins.

    3. Install an agent on the target computer. For performance reasons, agents are not typically installed on the same computer where the IBM UrbanCode Build server is located. For the tutorial, installing the agent on the computer where the server is located is fine.
    4. Configure the agent. Your agent must be included in the list of configured agents on the Agents page with a status of Online.
    5. Create an agent pool and add the installed agent to it.
    6. Install the open source tools Git and Ant on the computer where the IBM UrbanCode Build agent is located. Add the home directory for each tool to the PATH variable on the target system.
    7. Create the artifact set used by the tutorial by completing these steps:
      1. From the IBM UrbanCode Build dashboard, click System, and then click Artifact Sets.
      2. In the Artifact Sets tab, click Create New Artifact Set.
      3. In the Name field, type dist.
      4. Click Save.
    8. Install IBM UrbanCode Deploy. You must know the version number of the server because the IBM UrbanCode Deploy plug-in works differently for versions before 6.1. The IBM UrbanCode Deploy server must be accessible by the IBM UrbanCode Build agent. When the tutorial project runs, the agent calls to the IBM UrbanCode Deploy REST API. The IBM UrbanCode Deploy server must be running when you run the tutorial project.
    9. Configure an integration with the IBM UrbanCode Deploy server you installed in the previous step. To complete the configuration, you will need the URL of the IBM UrbanCode Deploy server.
    10. In your IBM UrbanCode Deploy installation, create a component that is named Ant. When you create the component, provide the following property values:
      • Component Type: Standard
      • Source Configuration Type: none

      You can accept the default values for the other properties.

      Note: To complete this step, you need an IBM UrbanCode Deploy account with, at a minimum, permission to view, edit, and create components. See Prerequisites.
    11. In your IBM UrbanCode Deploy installation, create a version status and name it Success. The tutorial project assigns this status to the component version that it creates in IBM UrbanCode Deploy. Make sure that you create a version status and not an inventory or snapshot status.
      Note: To complete this step, you need an account with access to the IBM UrbanCode Deploy Settings page. See Prerequisites.

    Lesson checkpoint

    The servers and agent are configured for the tutorial. If you installed the agent on a remote system, you must know the credentials that are required to access the remote system.
    < Previous | Next >
    Feedback