Before you begin

Complete the prerequisites list .

Initializing an MQ SaaS deployment

To initialize an MQ SaaS deployment, complete the following steps:

1. In the IBM Cloud home page, expand the navigation menu and select Projects.

2. Select the project you want to configure.

3. Go to the Configurations tab, expand Stack, and locate the MQ SaaS instance.

4. In the Draft Status, click Edit.

5. In the Configure section, click Required and enter the value for existing_mq_capacity_crn, which you can find by following these steps:

   • Expand the navigation menu and select Resource List > Integration.

   • Select the row for your Reserved Capacity Instance (avoid clicking on the name itself).

   • In the pop-out panel, copy the value of CRN.

6. Go to the Optional tab and provide the following details:

   • A unique value for deployment_name.

   • Your email address in the user_email field.

   • Update the application_name field, ensuring it does not contain underscores.

7. This step is optional and is only needed if you are using a secrets manager: Enter the values for existing_secrets_manager_crn and existing_secret_group_id.

   Follow these steps to get the values for existing_secrets_manager_crn and existing_secret_group_id:

   • Expand the navigation menu and select Resource List > Security.

   • Select the row for your Secrets Manager (avoid clicking on the name itself).

   • In the pop-out panel:

     • Copy the value of CRN into existing_secrets_manager_crn.

     • copy the value of GUID into existing_secret_group_id.

8. Click Save.

9. Click Validate.

10. In the Approval pending field, enter information about the approval and then click Approve.

11. Click Deploy. The deployment process might take a few minutes, after which the MQ SaaS instance is deployed.

Note: Each MQ SaaS deployment requires a unique Queue Manager name.

Connecting to MQ SaaS instances

To connect to deployed MQ instances, add configuration details to your Enterprise Application Service deployment:

1. In your source repository, open the server.xml file.

2. Set the correct values for userName and password that were left blank previously:

   • The values for userName and password must be generated. Follow these steps to generate the userName and password:

     1. Expand the navigation menu and select Resource List > Integration.

     2. Click the name you entered for deployment_name in MQ SaaS.

     3. Go to the Application credentials tab.

     4. Click Add to create credentials.

     5. Enter a name, and then click Add and generate API key.

        • Use this name as the userName in server.xml.

     6. Copy the generated API key and use it as the password.

3. Set the correct value for the hostname in the MQ connection factory tag:

   • Retrieve the hostname as follows:

     1. Expand the navigation menu and select Resource List > Integration.

     2. Click the name you entered for deployment_name in MQ SaaS.

     3. Click the name again to open details.

     4. Copy the value listed for hostname.

4. Commit your changes.

5. Go to your configuration repository.

6. Open the environment.yaml file and uncomment the services section.

7. Update the following values:

   • crn: Use the MQ CRN value entered for MQ SaaS.

   • name: Enter an appropriate name.

   • type: Enter mq.

8. Commit these changes.

9. After the build for your source code changes is complete.

   • Update your version in the configuration repository.

   • Deploy your Enterprise Application Service. It will now connect to your MQ instance.

Note: MQ SaaS deployments are limited to 2 channels and 3 queues with preassigned names. The server.xml from Application Modernization Accelerator has been updated with these preassigned names.

Note: If more than 3 queues are required for a queue manager, additional queues must be created and configured manually. For more information, see the IBM MQ SaaS documentation.

Deploying Db2 SaaS instances

IBM Db2 SaaS provides a secure and scalable solution for database management in the cloud, enabling seamless integration with other IBM Cloud services. Proper configuration ensures reliable performance and efficient connectivity, supporting smooth migration and robust application operations. These steps ensure that the Db2 service integrates securely and efficiently with other components in your IBM Cloud environment.

Before you begin

1. Ensure that you have an IBM Cloud account and all the required permissions to manage configurations.

2. Retrieve the Cloud Resource Name (CRN) for the following:

   • CRNs of other services (MQ, Db2) to be bound to the application.

Initializing Enterprise Application Service deployment automation

1. In the IBM Cloud home page, expand the navigation menu and select Projects.

2. Choose the project you wish to configure.

3. Click the Configurations tab, expand the Stack and locate the Enterprise Application Service Deployment Automation instance.

4. Click the options icon and select Edit.

5. Under Configure, click Required.

6. (Optional) Update the plan.

7. Under Draft status, click Validate.

   The validation takes a few minutes to complete.

8. In Approval Pending field, enter the text for approval and then click Approve.

9. Click Deploy. Deployment takes a couple of minutes and then the Enterprise Application Service instance is deployed.

Note: Each Enterprise Application Service deployment has a prefix value, noted in the Required section. This value must be unique for each of your deployments.

Deployment configuration in Enterprise Application Service

To configure the deployment in Enterprise Application Service complete the following steps:

1. Go to Configurations.

2. Select the name of the Enterprise Application Service deployment.

3. Select Outputs and

   • Locate the ease_instance_dashboard_url value.
   • Click the link to access the Enterprise Application Service dashboard.

4. Click Install and Configure.

5. Choose the Deploy, and run your application option if you have a an existing application ear file in a repo that you would like to use to deploy to EASeJ.

6. Choose the Build, deploy, and run your application option if you have a code source repository from which you would like to build the application ear file from and then deploy to EASeJ.

7. Follow the on-screen instructions to configure the GitHub source and configuration repositories.

Note: The Application Modernization Accelerator migration bundle provides a pre-configured environment.yaml file for your application. Replace the existing boilerplate file in your configuration repository with this pre-configured file.

Confirming the build

To confirm the build, complete the following steps:

1. In the IBM Enterprise Application Service for Java page, expand the navigation menu and select Builds > Release builds.

2. Your first build appears with the commit message Initial commit.

3. When the build completes, additional icons will appear at the end of the row.

4. Click the Deploy to staging icon.

5. Follow the on-screen steps to update your configuration repository.

Updating the server.xml

The migration bundle from Application Modernization Accelerator includes a pre-configured server.xml file. To make this file compatible with Enterprise Application Service, some manual modifications are necessary.

To update the file and ensure that the application deploys and runs successfully, complete the following steps:

1. Open the server.xml file in your source repository.

2. Update the references to library files with the following value (for example, someJar.jar is an example jar name):

   • Replace

     ${shared.config.dir}/lib/global/someJar.jar
     

   with

   ${server.config.dir}/lib/someJar.jar
   

3. If your application has MQ dependencies, make the following additional changes:

   • Add the <feature> element for SSL support if it is not already present:

     <feature>ssl-1.0</feature>
     

   • Update the MQ connection factory tags with these attributes:

     transportType="CLIENT"
     port="443"
     sslCipherSuite="TLS_AES_128_GCM_SHA256"
     userName=""
     password=""
     

Note: The userName and password values are provided in a later step during connection configuration.

Validating the configuration

To validate the configuration, complete the following steps:

1. Go to Configuration Jobs > Deployments.

   • Check for errors by clicking on the Job ID.

   • Fix the issues, in the environment.yaml file and re-run the validation.

2. After validation succeeds, go to Configuration Jobs > Deployments andf review the logs for errors and confirm that service bindings are created successfully.

Testing and validating the deployment

To test and validate the deployment, complete the following steps in the Enterprise Application Service:

1. Select Environments > Staging.

   • check the Application runtime log for errors.

   • Click Actions and select Open Application to validate the deployed application.

   • Add the root context, for example, /modresorts, to the application URL to verify accessibility.

Note: The application should deploy and run successfully. However, because IBM MQ and IBM Db2 dependencies have not yet been created and configured, the application might not function as expected. These dependencies are addressed in later steps.