Deploying integration solutions to a production environment

After you create and populate a BAR file with the development resources, you can deploy the integration solution to an integration server.

Before you begin

Complete the following steps:
Note:

The mode in which your integration node is working can affect the number of integration servers and message flows that you can deploy, and the types of node that you can use. See Restrictions that apply in each operation mode.

About this task

Choose one of the following methods to deploy a BAR file:

If you change a BAR file, and want to propagate those changes to one or more integration nodes, you can redeploy the updated BAR file; see Redeploying integration solutions to a production environment.

By default, BAR file deployment is incremental, but you can choose to do a complete BAR file deployment if you prefer. For an explanation of the difference between a complete and an incremental BAR file deployment, see BAR file deployment.

Deploying a BAR file by using the web user interface

About this task

You can select a BAR file and deploy it to an integration server by using the web user interface.

You can also select an overrides file, which defines the BAR file properties that you want to change for a specific deployment. For more information, see mqsiapplybaroverride command.

Procedure

  1. Start the web user interface for your integration node; see Accessing the web user interface.
    The navigator is displayed on the left side of the pane, showing the servers (integration servers), message flows, and other resources that are owned by your integration node.
  2. Expand the Servers section and click the arrow beside the integration server (where you want to deploy the BAR file) to display the menu.
  3. Click Deploy.
    The Deploy BAR File dialog is displayed.
  4. To select a BAR file, click Browse, navigate to your BAR file and click Open.
    The BAR file properties and the associated values are displayed in the dialog.
  5. Optional: To select an overrides file, click the down arrow beside Overrides and click Select overrides file, navigate to the overrides file, and click Open.
    For information about the format of an overrides file, see mqsiapplybaroverride command.
    Any property values that are specified in the overrides file are displayed in the dialog, in place of the original property values. If you want to restore the original property values from the BAR file, click the down arrow beside Overrides and click Clear overrides file.
  6. Click Deploy.

Results

The BAR file is transferred to the integration node, which deploys the file contents to the integration server. In the web user interface navigator, the deployed resources are listed under the appropriate integration server.

Deploying a BAR file by using the IBM Integration Toolkit

About this task

To deploy a BAR file by using the IBM® Integration Toolkit, complete the following steps. You can deploy to only one integration server at a time.

Procedure

  1. Optional: Typically, an incremental BAR file deployment is done. To do a complete BAR file deployment, right-click the target integration server in the Integration Nodes view and click Delete > All Flows and Resources.
    Wait for the operation to complete before you continue.

    To refresh only some of the resources with the contents of the BAR file, do not click Delete > All Flows and Resources.

  2. Deploy a BAR file to an integration server by using one of the following methods.
    • Drag the BAR file onto your target integration server in the Integration Nodes view.
    • Right-click the BAR file, then click Deploy and select the target integration server.
    • Right-click the target integration server, click Deploy, select BAR from workspace or BAR from file system, select the BAR file that you want to deploy, and click OK.
  3. If the BAR file changed since you last edited it, you are asked whether you want to save the file before deployment. If you click Cancel, the BAR file is not saved and deployment does not take place.

Results

The BAR file is transferred to the integration node, which deploys the file contents (for example, message flows and message sets) to the integration server. In the Integration Nodes view, the deployed resources are added to the appropriate integration server.

Deploying a BAR file by using the mqsideploy command

About this task

To deploy a BAR file by using the mqsideploy command, complete the following steps.

Procedure

  1. Open a command window that is configured for your environment.
  2. Enter the appropriate command for your operating system and configuration, by using the following examples as a guide.
    On distributed systems: 
    mqsideploy -i ipAddress -p port -e intserver -a barfile

    The command completes an incremental deployment. To do a complete BAR file deployment, add the -m parameter.

    The -i (IP address) and -p (port) parameters represent the connection details for the queue manager that is associated with the integration node. If you created the integration node on the computer on which you run this command, you can specify the integration node name instead.

    You must also specify the -e (integration server name), and -a (BAR file name) parameters.

    On z/OS®:
    /f IBNODE,dp e=intserver a=barfile

    The command completes an incremental deployment. To do a complete BAR file deployment, add the m=yes parameter .

    In the example, IBNODE is the name of the integration node. You must also specify the names of the integration server and the BAR file (the e= and a= parameters).

    For more information, see mqsideploy command.

Results

The command reports when responses are received from the integration node. If the command completes successfully, it returns 0 (zero).

Deploying a BAR file by using the IBM Integration API

About this task

To deploy a BAR file by using the IBM Integration API, use the deploy method of the ExecutionGroupProxy class.

The following code shows how an application can do an incremental deployment:
import com.ibm.broker.config.proxy.*;
public class DeployBAR {

  public static void main(String[] args) {
    BrokerConnectionParameters bcp =
       new IntegrationNodeConnectionParameters("localhost", 4414);
    try {
      BrokerProxy b = BrokerProxy.getInstance(bcp);
      ExecutionGroupProxy eg = b.getExecutionGroupByName("default");
      DeployResult dr = eg.deploy("MyBAR.bar", true, 30000);
      System.out.println("Result = "+dr.getCompletionCode());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}
By default, the deploy method completes an incremental deployment. To do a complete deployment, use a variant of the method that includes a false value for the Boolean isIncremental parameter. For example, eg.deploy("MyBAR.bar", false, 30000).

Deploying a BAR file to IBM App Connect on IBM Cloud

Before you begin

Before you can deploy a solution to IBM App Connect on IBM Cloud, you must sign up for an App Connect service in IBM Cloud. For more information, see IBM App Connect in IBM Cloud.

About this task

App Connect on IBM Cloud provides a fully managed environment that you can use to deploy integration solutions to the cloud without the need to acquire and maintain an IT infrastructure.

You deploy a solution to App Connect on IBM Cloud by uploading the BAR file to the cloud. When you upload your BAR file to the cloud, an integration server is created in the cloud, and the contents of the BAR file are unpackaged and run on that integration server. Each integration server in App Connect on IBM Cloud contains the contents of a single BAR file. You can see your integration servers on the App Connect on IBM Cloud dashboard, where you can start and stop them. You can also configure authentication and secure connectivity between your resources in the cloud and on premises.

For detailed instructions about how to upload BAR files to the cloud, see IBM App Connect Enterprise on IBM Cloud.

What to do next

You can check the results of your deployment; see Checking the results of deployment.