Deploying WebSphere configurations and applications

To deploy WebSphere® configurations and applications, you use plug-ins to read information about a live deployment into a model in Resources. You then define components, applications, environments, and processes to automate deployments that create new instantiations of the modeled WebSphere environment.

Before you begin

The following setup and preparation is required.

1. Set up plug-ins in UrbanCode Deploy

About this task

In this task you prepare the required UrbanCode Deploy resources.

Procedure

  1. Install the Middleware Configuration for Websphere plug-in.
    1. In UrbanCode Deploy, go to Settings > Automation Plugins.
    2. Click Load Plugin.
    3. In the dialog, click Choose File, then choose the MCWASPlugin-<version>.zip
    4. Click Submit.
  2. Install the Application Deployment for WebSphere plug-in.
    1. In UrbanCode Deploy, go to Settings > Automation Plugins.
    2. Click Load Plugin.
    3. In the dialog, click Choose File, then choose the ApplicationDeploymentForWebSphere-<version>.zip file.
    4. Click Submit.
    During installation a component template is automatically created for Middleware Configuration for WebSphere. It is placed in the following file: <plugin_home>/imports/componenttemplates/Middleware Configuration for WebSphere.json.

2. Create a component for the configuration template

About this task

The component is at the center of the deployment process. It is associated with a configuration template and with resources so that it holds a configuration definition to be deployed.

Procedure

Create a component if one does not exist.
  1. Click the Components tab.
  2. Click Create New Component. Provide the following information:
    • Name: Enter a name for the component.
    • Template: select Middleware Configuration for WebSphere.
  3. Click Save.

3. Model a WebSphere cell in Resources

About this task

Using autodiscovery, you locate a WebSphere cell through the agent that is installed on the host where it is running. Using auto-configure, you populate the resource tree with data about the WebSphere cell. For non-ND environments, you model a server resource. The resource tree is the centralized source of configuration data. Multiple processes in UrbanCode Deploy can include components that contain resources selected from the resource tree.

Procedure

  1. In Urbancode Deploy, go to Resources.
  2. Click Create Top-Level Group to create a group.
  3. Optional: if you need to specify multiple profiles for the group, add websphere.profilePath as a property on the group and specify paths to the profiles in its value. See Specifying multiple profiles with the websphere.profilePath property for details.
  4. Add one or more agents, as required.
    1. Hover over the row for the resource group, click Actions, and select Add agent.
    2. Select the agent to add. Use the agent that is installed on the host for the WebSphere environment you are going to model.
    3. Wait 10 to 30 seconds, then click Refresh. A twisty is now next to the agent. When you expand it, there is a sub-resource cell, WebSphereCell.
    4. Hover over the row, then click Edit.
    5. Enter values for the following properties.

      If you want to use soap.properties to provide the values, you must leave the WebSphere User and WebSphere Password properties blank.

      • WebSphere Profile Path
      • WebSphere User
      • WebSphere Password

      Leave the Cell Name property blank.

    6. Optional: if you need the agent to manage multiple profiles, add websphere.profilePath as a property on the agent and specify paths to the profiles in its value. See Specifying multiple profiles with the websphere.profilePath property for details.
    7. Click Save.
  5. Set Auto configure options for WebSphereCell.
    1. Hover over the row for WebSphereCell, click Actions, then click Auto Configure.
    2. Click No auto configure for resource.
    3. Check Websphere Topology Discovery box.
    4. Click OK.
    5. Click Save.
    6. Wait 30-60 seconds, then click Refresh. A twisty is now next to WebSphereCell. Expand it and make sure the resource tree matches your WebSphere Application Server topology.
    7. On the WebSphereCell entry, click Edit. Check that Cell Name was filled in and is correct.

4. Map the desired resource to the configuration template component

About this task

During mapping you choose a scope from the resource tree to be used for deployments. Note that a captured scope configuration can be applied only to a like scope. For example, if you capture configuration information for a cluster scope, it can only be used to deploy a cluster configuration.

Procedure

  1. Click Resources to view the resource tree for the desired WebSphere cell.
  2. Add a component to the scope or scopes you want to use: cell, cluster, node, or server.
    1. Select the scope you want to manage. Hover over a row to select a single scope to show a menu, then click Add component in the menu.
    2. Select the component to use. You created it above.
    3. Click Save.

5. Associate the component with an application

About this task

Create the application if it does not exist. The application is the container for deployment data.

Procedure

  1. In the Dashboard, click Applications.
  2. Create the application if it does not exist.
    1. Click Create New Application.
    2. Enter an application name, then click Save.
  3. Add the component to the application.
    1. In the Dashboard, click Applications.
    2. Click the application to use.
    3. Click the Components tab, then add the component that you created for the configuration template.

6. Associate other needed components with the application

About this task

To deploy applications, you need to have components configured for the WAR or EAR files. Add them to the application.

Procedure

  1. In the Dashboard, click Applications.
  2. Click the application to use.
  3. Click the Components tab, then add the desired component.
  4. Repeat for all necessary components.

7. Associate the resources with an application environment

About this task

The resources define the configuration data to be deployed with the application.

Procedure

  1. In the Dashboard, click the Applications tab.
  2. Click the application you created.
  3. Create an application environment.
    1. Click Create New Environment.
    2. Enter an environment name, then click Save.
  4. Add the resource group to the environment.
    1. In the application, click Environments.
    2. Click the environment name.
    3. Click Add Base Resource. Choose the group for your exemplar cell and environment.
  5. Optional: view the environment properties for the component.
    1. In the Dashboard, click Components.
    2. Click the component.
    3. Click Configuration.
    4. Click Environment Property Definitions.

8. Generate a configuration template

About this task

Run an application process to generate the configuration template.

Procedure

  1. In the application you created, click the Processes tab.
  2. Define the process as follows.
    1. In the process design page, locate each component that you have added to the application.
    2. Click the component to show a Generate Template process step.
    3. Drag the Generate Template step to the process editor, then give the process a name.
    4. Click Save.
  3. Run the application process to generate the template.
  4. Enter information for the following fields.
    • New Component Version: Specify a new version to use. The configuration template files are associated with that version.
    • SkipConfigCapture: If this flag is enabled, an existing WebSphere Application Server configuration is used as a base template. Normally this flag is enabled in order to tokenize an existing template.
    • UseQuickCapture: Enabled by default. Leave it enabled unless there are problems generating the template. You may uncheck it to debug problems with generating the template.
  5. Click Submit.

    Wait for the process to finish running before continuing.

9. Deploy the configuration template

About this task

Create an application process of type Deployment for configuration and deployment, then run the process to test it.

Procedure

  1. In the Dashboard, click the Applications tab.
  2. Click the application you created.
  3. Click the Processes tab.
  4. Define the process.
    1. Drag and drop the Install Component step onto the process editor. Choose the Configure WebSphere Application Server component process.
    2. Select the component you created
    3. Choose the Configure WebSphere Application Server (Template) component process
  5. Click Save.
  6. Run the process to test the newly created component template.

Feedback