Configure the tutorial system

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

Before you begin the tutorial, make sure that you meet the Prerequisites.
To complete the tutorial, you must have an installation of Build and IBM® DevOps Deploy (Deploy). Your Build agent must have access to the Deploy server.
To prepare the tutorial system.
  1. Prepare a computer for use as the target system.
  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 Build plug-in site: https://developer.ibm.com/urbancode/plugins/ibm-urbancode-build/. For information about installing plug-ins, see Installing plug-ins.

  3. Typically, agents are not installed on the same computer where the 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 tool Git on the computer where the Build agent is located.
    Add the home directory for the tool to the PATH variable on the target system.
    Note: The tutorial also requires Ant. Ant is installed with the agent when the agent is installed.
  7. Create the artifact set used by the tutorial by completing these steps:
    1. From the Build dashboard, click System, and then click Artifact Sets.
    2. In the Artifact Sets tab, click Create New Artifact Set.
    3. In the New Artifact Set dialog box, in the Name field, type dist.
    4. Click Save.
  8. Install Deploy.
    You must know the version number of the server because the Deploy plug-in works differently for versions before 6.1. The Deploy server must be accessible by the Build agent. When the tutorial project runs, the agent communicates with the Deploy REST API.
    Note: The Deploy server must be running when you run the tutorial project.
  9. Configure an integration with the Deploy server you installed in the previous step. To complete the configuration, you need the URL of the Deploy server.
  10. In your 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 Deploy account with, at a minimum, permission to view, edit, and create components. If you have your own component, you can use that. However, the tutorial uses the name of the component in one of its properties and you will have to substitute the name of your component for the name used in the tutorial. See Prerequisites.
  11. In your Deploy installation, create a version status and name it Success.
    The tutorial project assigns this status to the component version that it creates in 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 Deploy Settings page. See Prerequisites.
Your Build environment is ready to being the tutorial.
The tutorial project is also available in a file that you can download and import. To import the tutorial project, follow these steps:
  1. Navigate your browser to the file repository URL:http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/product_doc/UrbanCode/uBuild/.
  2. Download the file named Ant.xml.
  3. On the Build Project page, click Import, and then select the downloaded file.
    Note: Make sure that you install the plug-ins described earlier in this topic before you import the file.
  4. In the Import window, click Import. The server imports the project. The server does not import plug-ins when it imports a project, so you still need to install the plug-ins described earlier in this topic.

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.