Skip to Content

One-click deployment in Jitterbit App Builder

Introduction

Since App Builder 4.52, you can set up a semi-automated process to deploy an app from one App Builder environment (the source) to another (the target). (Since App Builder 4.53, you can automatically deploy and install packages with a single click, by marking a target environment as the default.)

An overview of the steps is as follows:

  1. On the target environment:

    1. Set up an API key.

    2. Set up the environment.

  2. On the source environment:

    1. Set up an HTTP security provider.

    2. Configure the source environment.

Tip

A typical use case for this feature is to streamline the deployment of apps, from, for example, development to QA, or QA to production. In these examples, source and target would be as follows:

flowchart LR DEV["Development
(Source)"] --> QA1["QA
(Target)"] QA2["QA
(Source)"] --> PROD["Production
(Target)"]

Prerequisites

The target environment's user (the one the API key is created for) must have the Deployment role.

The source environment's user (the one doing the deploying) needs either Administrator or Developer roles.

On the target

Set up an API key

To set up an API key on the target environment, follow these steps:

  1. Create an API key security provider:

    1. Select IDE > Security Providers.

    2. Click the + User Authentication button.

    3. On the Provider page, configure, enable, and save a provider with type API Key:

      Provider

  2. Set up a user to perform the one-click deploys:

    1. (Optional) Create a new user. If you want to perform the one-click deploys using an existing user, go to the next step.

    2. Go to IDE > User Management and open the Groups tab.

    3. In the Groups panel, select Deployment.

    4. The Membership panel now lists all users belonging to the group you've selected. Click the + Membership button.

    5. Use the dropdown menu to select the user you want to use and click the icon. That user now belongs to the group that has the necessary permissions to deploy a release.

  3. Generate an API key for the user that will perform the deploys:

    1. If you've left the User Management page, return to it by going to IDE > User Management.

    2. In the Users tab, the Users panel lists all users. Locate and select the one you want to authorize to perform deploys.

    3. Click the icon for the user you've selected. The User dialog opens.

    4. Go to More > Keys. The Keys dialog opens.

    5. Click Create. The Generate Key dialog opens.

    6. In the Provider field, select the security provider you created above. Click Save. App Builder will create an API key for the user.

      Warning

      The API key will only be shown once. Be sure to copy and store it safely.

Configure the target environment

To configure the target environment, follow these steps:

  1. Select IDE > Create Release.

  2. Select the Environments tab.

  3. Under Current Environment, click the Configure button.

  4. In the popup, set values for the following fields:

    • Name: A name for this target environment.

    • URL: This (target) environment's URL.

    • Authentication: Select the API key created in the previous section.

    • Enable Deployment: Selected.

    • Allow Install On Deploy: Selected.

  5. Click the Save button:

Target environment

On the source

Set up an HTTP security provider

To set up an HTTP security provider on the source environment, follow these steps:

  1. Select IDE > Security Providers.

  2. Click the + Data Source Authentication button.

  3. On the Provider page, configure, enable, and save a provider with type HTTP (listed under the Data Source Authentication section), and Authentication Type set to API Key.

  4. Click the Save button. Additional panels appear.

  5. Under Endpoints, click the + Credential button. The Credential popup opens.

  6. Set the following fields:

    • Type: API Key

    • Key: Enter the target's API key, which you created earlier.

  7. Close the Credential popup.

HTTP security provider

Configure the source environment

To configure the source environment, follow these steps:

  1. Set the current environment:

    1. Select IDE > Create Release.

    2. Select the Environments tab.

    3. Under Current Environment, click the Configure button.

    4. In the popup, set values for the following fields:

      • Name: A name for this source environment.

      • URL: This (source) environment's URL.

      • Enable Deployment: Selected.

      • Allow Install On Deploy: Selected.

    5. Click the Save button.

  2. Set the target environment:

    1. Under Target Environments, click the + Target Environment button.

    2. Set values for the following fields:

      • Name: Enter a name for the target environment.

      • URL: The target environment's access URL.

      • Authentication: Select the HTTP provider created in the previous section.

      • Supports Deployment: Selected.

        • Default: (Optional, appears when Supports Deployment is selected.) Select to automatically deploy to this environment unless another is selected.

      • Supports Install On Deploy: Selected.

        • Default: (Optional, appears when Supports Install on Deploy is selected.) Select to automatically install packages during deployment.

    3. Click the Save button, then close the Environment popup.

Source environment

Perform a one-click deployment

To use the one-click deploy feature, follow these steps:

  1. Create a release:

    1. Select IDE > Create Release.

    2. Select the Create a Release tab.

    3. Click the + Solution button.

    4. Use the Solution wizard to define what to deploy.

  2. Build the solution:

    1. Click the Build button for the new release template.

  3. Deploy the release:

    1. Wait for an App Builder notification that tells you the build is complete.

    2. Do either of the following:

      1. Click the notification's See Release button. The All Releases tab opens.

      2. Dismiss the notification, then select the All Releases tab.

    3. Click the Deploy button for the built solution.

    4. If Default is checked for Supports Deployment and Supports Install On Deploy in the target environment, no further action is needed.

      Otherwise, continue with the following steps:

      1. In the Deploy Release popup, open the Environment menu, then select the target environment.

      2. Select the Install On Deploy checkbox.

      3. Click the Deploy button.

Confirm that a release was deployed

After performing a one-click deployment, you can ensure that the release was deployed by doing the following:

  1. Sign into the target environment.

  2. Navigate to IDE > Install Release.

  3. Verify that the package exists and was installed.