Skip to Content

Jitterbit App Builder setup on Microsoft Azure

Setup instructions for running App Builder on Microsoft Azure using App Service for App Builder and VM for SQL Server Web.

Important

  • These instructions are intended for development and QA and production environments of App Builder.
  • The instructions are broken down into 3 parts. VNet setup, Database setup and App Service setup. These are guidelines and if an organization has standard practices for provisioning the VNet or database, they should use that.
  • For performance, it is important that the database VM and app service be provisioned in the same region.
  • In the screenshots that follow, arrows are used to highlight where settings were made / changed or saved.

Part i. VNet setup

If you already have a VNet configured, you can use that but otherwise it is recommended to configure a VNet for traffic between the App Builder App Service and the database.

(ref: https://learn.microsoft.com/en-us/azure/app-service/configure-vnet-integration-enable)

image1.png

image2.png

In this screenshot, the VNet was configured with a bastion (which was auto-provisioned) – this is optional. You must have a subnet available for the AppService, which is called "AppServiceSubnet" in the screenshot below:

image3.png

Part ii. Database setup

(Optional – if organization has another method for starting SQL Server instances use that)

Create a Windows VM with SQL Server already installed and running:

The screenshot below shows the settings we used for our qa/dev framework, using the default server sizing recommended. For production environments this might be larger.

databasesetupimage.png

The marketplace screen for selecting the Image above:

image5.png

We use primarily defaults for the additional settings:

image6.png

For networking you would likely use an existing Virtual Network

image7.png

image8.png

image9.png

image10.png

We enable SQL Authentication for the SQL Server instance:

image11.png

image12.png

image13.png

image14.png

image15.png

Part iii. App service setup

image16.png

image17.png

image18.png

Tip

To use a specific build of App Builder, specify its Image and Tag in the format jitterbit/vinyl:3.3.12345.

image19.png

image20.png

image21.png

image22.png

image23.png

Update configuration for Docker

image24.png

Note

The database we provisioned in our vnet was named "zudysqlserverqa" and is accessible via "zudysqlserverqa.internal.cloudapp.net"

ConnectionInfo__DatabaseType: SQLServer ConnectionInfo__HostName: zudysqlserverqa.internal.cloudapp.net ConnectionInfo__CommandTimeout: 300 ConnectionInfo__DatabaseName: App Builder ConnectionInfo__UserName: vinyl ConnectionInfo__Password: YourDatabasePassword

Enable VNet integration

image25.png

image26.png

image27.png

Create File Shares to be mounted by the app service

image28.png

We left all the screens with default settings

image29.png

image30.png

image31.png

App Builder requires 3 file shares to persist data permanently.

image32.png

image33.png

image34.png

Create 3 file shares for the data, keys and logs directories.

image35.png

Mount the disks on the app service

image36.png

All 3 added.

Important

Name and Mount Point must be named exactly as seen below:

image37.png

The values for Name and Mount path should be:

  • vinyl_data /app/data
  • vinyl_keys /app/keys
  • vinyl_logs /app/logs

Optional: Turn on app service logs:

image38.png

Confirm system up (it takes App Builder approximately 2 minutes to install the first time)

image39.png

Verify that the File Shares keys and logs contain files

image40.png

Appendix – Redis setup for multiple app service instances

Setup Redis

  • Go to Azure Cache for Redis and select Create
  • Select Standard C1 or Basic C0
  • Ensure the cache is in the correct resource group, region, and give it a unique name

image41.png

Select Private Endpoint and there is no need to actually create a private endpoint:

image42.png

Configure Azure app service to use Redis

Once the service is running, you can get the connection string for it from Access Keys page:

image43.png

In the App Builder App Service add the following properties:

  • SharedState__Provider: Redis
  • SharedState__RedisConnectionString: zudyazure1.redis.cache.windows.net:6380,password=<YourPassword>=,ssl=True,abortConnect=False

Save the configuration and App Builder will use Redis for coordination between instances.

image44.png