Integrating with DevOps Deploy

Integrate IBM® DevOps Deploy (Deploy) with IBM DevOps Release (Release) to import Deploy artifacts.

Install the Deploy plug-in. If you are using an earlier version of Release, the internal integration provided for Deploy is now deprecated.

In Deploy, generate an authentication token for the admin user. Ensure that the server is available and that you have its URL.

When you run the integration, Deploy applications, snapshots, environments, processes, and components are imported into Release. You can assign the applications to releases and run them with automatic tasks when you run deployments.

When the integration runs, it refreshes the imported data with changes made since the last time the integration ran.

  1. Click the navigation list arrow, and then click Integrations > Add New.
  2. In the Name field, type a name for the integration.
  3. From the Integration list, select IBM DevOps Deploy Plugin.
  4. By default, the Manual Update is selected in the frequency list. Users can run Manual Update at any time using Run integration.
    From the Frequency list, select a frequency.
    The frequency determines how often Deploy is polled for changes. If Deploy has numerous applications and components, frequent updates might affect performance. Specify a frequency of 30 min initially.
  5. In the Base IBM DevOps Deploy URL field, enter the URL where the Deploy server is located.
    The format is [HOST]:[PORT]. For example, http://myserver.company.com:8080.
  6. In the Administrator Auth Token field, enter or paste an authentication token that you generated from Deploy.
    Note: The user for the token must be admin.
  7. Optional: Test the connection by clicking Check Authentication. If the connection is made, a Connection Successful message is displayed. Otherwise, use the View Log command to view information about the error.
  8. Full synchronization is done with the initial sync to import all objects from Deploy.
    1. If the Full Sync check box is enabled, then the integration will import the full/complete set of data from the Deploy server on every sync.
    2. If the Full Sync check box is disabled (Delta sync), it will import the data which is newly created or modified since the last execution/integration timestamp.
    Note: For best results use Full Sync only for the first time when you set up the integration. Subsequently, use Delta sync for the better performance by avoiding the duplication of imports.
  9. Click Save to save your work.
    Note:
    1. If you delete the integration in Release, the scheduled deployments will fail to deploy the required application and you will not be able to schedule any deployments in future.
    2. If the authentication token is deleted or expired in DevOps Deploy, all scheduled deployments will fail to run in Release and you must update the existing integration with the new token in Release.
    3. If the authentication token is deleted or expired in DevOps Deploy and the integration is deleted in Release, you must create a new authentication token in DevOps Deploy and then add a new integration in Release with DevOps Deploy.
    4. If you delete the integration in Release, the scheduled deployments will fail to deploy the required application and you will not be able to schedule any deployments in future. To run the already scheduled future deployments, you must create a new integrations with new authentication token. After creating new integration, you must update existing deployment with new authentication token.
      1. Run PS_PROP_VALUE:: SELECT * FROM dbschema.PS_PROP_VALUE WHERE NAME ='deployToken'; SQL query in Release database to retrieve all records from table.

        Replace dbschema with schema name of your database.

      2. Run UPDATE dbschema.PS_PROP_VALUE SET VALUE='Token' WHERE NAME ='deployToken'; SQL query to update the old token with new token in Release database.

        Replace dbschema with schema name of your database and Token with new token.

Deploy applications and components are integrated into Release. All version and snapshot statuses are synchronized between Deploy and Release. For information about the imported applications, see Managing applications with the Applications page.

Review a tutorial that illustrates how to use imported applications.