Configuring the target system and IBM UrbanCode Deploy server

To complete the tutorial, the IBM™ UrbanCode™ Deploy server must contain applications with snapshots. IBM UrbanCode Deploy snapshots are identified as application versions in IBM® UrbanCode Release.

  • Make sure that you have access to an IBM UrbanCode Deploy server.
  • You must have an account on the server with the permissions to create and edit applications, environments, and components, and to create and run processes.
In this tutorial, you use IBM UrbanCode Release to manage the deployment of an application on an IBM UrbanCode Deploy server.

You can use IBM UrbanCode Release to define and manage your entire release processes. If you also use IBM UrbanCode Deploy to manage your applications, you can run application deployments from within IBM UrbanCode Release. Because this tutorial focuses on IBM UrbanCode Release, you import the IBM UrbanCode Deploy elements that are required to work through this tutorial. You import an application that compresses files that are associated with a component and moves the compressed file to a specific location. To learn more about creating items in IBM UrbanCode Deploy, review its tutorials.

  1. Prepare a computer for use as the target system.
    This computer must meet the current IBM UrbanCode Deploy system requirements. Most of the examples in this tutorial show information for a simple Linux™ operating system such as Red Hat Enterprise Linux.
  2. Install an IBM UrbanCode Deploy agent on the target system.
  3. On the IBM UrbanCode Deploy server, verify that the agent is installed by clicking Resources > Agents. Your agent must be included in the list of agents with a status of Online, as shown in the following figure:

    The agent in the list of agents; the Status column shows that the agent is online
  4. Create a resource group for the application:
    1. To the left of the Agents tab, click the Resources tab.
    2. Click Create Top-Level Group, give the new group a name such as Integration tutorial, and click Save.
      This group is a container for resources, including agents.
  5. Create a resource group for the agent:
    1. On the same row as the new resource group, click Actions > Add Group, as shown in the following figure:

      Adding a group to the resource group
    2. In the Create Resource window, give the new group a name such as Integration dev, and click Save.
    3. On the same row as the Integration dev group, click Actions > Add Agent.
    4. In the Create Resource window, select the agent in the Agent list and click Save.
  6. Create another resource group for the application
    1. On the same row as the parent resource group, click Actions > Add Group again.
      Ensure that you select the highest-level resource group, not the new resource group that you created.
    2. In the Create Resource window, give the new group a name such as Integration prod, and click Save.
    3. On the same row as the Integration prod group, click Actions > Add Agent.
    4. In the Create Resource window, select the agent in the Agent list and click Save.
    The nested resource groups each contain the agent, as shown in the following figure:
    One agent is associated with both resource groups
  7. Download the artifacts_snapshots.zip file to your computer by clicking the following link: tutorial artifacts.
    This file contains all the required files for quickly copying the application that you must have to complete this tutorial on your IBM UrbanCode Deploy server. This file contains all the versioned artifact files that you must have to deploy the sample application's components. This file also contains a JavaScript Object Notation (JSON) file that describes the component processes, application process, snapshot, and environments that you use to deploy the application. Unlike when you use a production IBM UrbanCode Deploy server, you do not configure this server to update the components. By importing the snapshot, you load the files directly into CodeStation.
  8. Import the application into the IBM UrbanCode Deploy server:
    1. Click Applications.
    2. Click Import Applications.
    3. Select Import with Snapshots.
    4. Click Choose File and select the artifacts_snapshots.zip file.
    5. Accept the other defaults in the Import Applications window, and click Submit.
    The Integration tutorial application is shown on the Applications tab.
  9. Prepare the resources for the Dev environment:
    1. From the Applications tab, click the Integration tutorial application, and then click the Dev environment.
      The environment's Resources tab is displayed.
    2. Click Add Base Resources.
      The Add Resource to Environment window shows all the resources that are available on the server.
    3. Select the check box next to the agent in the Integration dev resource, and then click OK.
      Note: Be sure that the agent that you selected is in the Integration dev resource.
    4. On the same row as the base resource, click Actions > Add Component.
      The Actions button is not displayed until you hover the mouse over the resource.
    5. Select the component, and then click Save.
    The component is mapped to the target system, as shown in the following figure:
    The Resources tab for the environment, showing the agent with three components that are mapped to it
  10. Repeat the process to prepare the resources for the Prod environment:
    1. From the Applications tab, click the Integration tutorial application, and then click the Prod environment.
      The environment's Resources tab is displayed.
    2. Click Add Base Resources.
      The Add Resource to Environment window shows all the resources that are available on the server.
    3. Select the check box next to your agent in the Integration prod resource, and then click OK.
      Note: Be sure that the agent that you selected is in the Integration prod resource.
    4. On the same row as the base resource, click Actions > Add Component.
    5. Select the component and then click Save.
      If the application component was attached to the agent, you did not select the correct resource group for the environment. Remove the resource group from the environment, and add the correct resource group as a base agent.
    The components are mapped to the target system, as shown in the following figure:
    The Resources tab for the environment, showing the agent with three components that are mapped to it
  11. Set the deployment location for your application:
    1. Click Components, and then click the integration-files component.
    2. Click the Configuration tab that is within the component. Make sure to click the Configuration tab that is associated with the component and not the Configuration tab that is at the top of the page.
    3. Click Component Properties, and review the integration_working property.
    4. To change the folder that the application deploys to, in the same row as integration_working, click Edit, and specify a new value.
      If you use a Windows operating system, the folder name might look like the following string: C:/integration_tutorial. If you use a Linux operating system, the folder name might look like the following string: /root/integration_tutorial.
      When the application is deployed, it places the compressed file into a subfolder. The subfolder that is associated with each environment is specified as an environment property. You do not have to modify this property to complete the tutorial. For more information about properties, review the help topics about using IBM UrbanCode Deploy.
    5. Click Save to display the component properties.
The target system and IBM UrbanCode Deploy agent and server are configured for you to deploy the sample application with IBM UrbanCode Release.