In this code pattern, we will use Transformation Advisor to evaluate an on-premise traditional WebSphere application for deployment on public and/or private cloud environments. We'll use Transformation Advisor's integration with Microclimate to deploy the app in a Liberty container running on IBM Cloud Private. We'll also download the generated migration bundle and use its Helm chart to deploy the containerized app to IBM Cloud Kubernetes Service (public cloud).
A sample web app is provided to demonstrate migration from on-premise to the cloud.
When the reader has completed this code pattern, they will understand how to:
- Use Transformation Advisor to create a custom Data Collector
- Run the custom Data Collector to analyze a traditional WebSphere app
- Review the Transformation Advisor reports to see migration complexity, cost, and recommendations
- Generate artifacts to containerize the app
- Move the modernized app to IBM Cloud Private using Microclimate
- Move the modernized app to IBM Cloud Kubernetes Service using a generated migration bundle
- Developer downloads a custom Data Collector from Transformation Advisor
- Developer runs the Data Collector on the traditional WebSphere Application Server host
- Data Collector analysis is uploaded (automatically or manually)
- Developer reviews recommendations in Transformation Advisor and creates a migration bundle
- Transformation Advisor deploys the modernized app as a containerized Liberty app on IBM Cloud Private via Microclimate
- Developer downloads migration bundle
- Developer uses Docker to build an image and upload it to IBM Cloud Container Registry
- Developer uses generated Helm chart to deploy the modernized app as a containerized Liberty app on IBM Cloud Kubernetes Service
- Transformation Advisor: Not every workload should move to cloud. The right choice can yield large cost savings and speed time to market. The Transformation Advisor tool can help you decide.
- Microclimate: Create, build, test and deploy applications in one seamless experience to help development teams modernize existing applications.
- IBM Cloud Kubernetes Service: IBM Cloud Kubernetes Service manages highly available apps inside Docker containers and Kubernetes clusters on the IBM Cloud.
- WebSphere Liberty: A dynamic and easy-to-use Java EE application server, with fast startup times, no server restarts to pick up changes, and a simple XML configuration.
- IBM Cloud Private: Drive innovation. Transform your enterprise. IBM Cloud Private: speed of public, control of private. IBM Cloud. The cloud for smarter business.
- Cloud: Accessing computer and information technology resources through the Internet.
- Containers: Virtual software objects that include all the elements that an app needs to run.
- Java: A secure, object-oriented programming language for creating applications.
- Verify Microclimate prerequisites
- Get started with the Transformation Advisor
- Download and run the Data Collector
- Upload results, if necessary
- View the recommendations and cost estimates
- Complete your migration bundle
- Create a GitHub or GitLab repository
- Deploy your application
- Deploy to IBM Cloud Kubernetes Service (IKS)
Before you install Microclimate, decide if you will deploy to the IBM Cloud Kubernetes Service (IKS)!
In order to be able to deploy to IKS, you need to specify a Docker registry URL in the
jenkins.Pipeline.Registry.URLproperty when you install Microclimate. Both Microclimate and IKS need to access this registry. The Deploy to IBM Cloud Kubernetes Service (IKS) instructions assume the use of the IBM Cloud Container Registry. For the IBM Cloud Container Registry, the Docker registry URL should be in the following format:registry.<region>.bluemix.net/<my_namespace>
Ensure that you have Microclimate running on IBM Cloud Private and take note of its URL. If you do not see Microclimate in your deployments, you will need to install Microclimate from the Helm chart. The instructions for deploying Microclimate are here.
To find your Microclimate deployment:
-
Go to your IBM Cloud Private UI and use the
☰button to show the sidebar menu. -
Select
Workloads ▷ Deployments.
-
You should see Microclimate deployments listed. Go to the
Launchlink and launch the portal.
-
This will take you to the Microclimate Projects page. Take note of the URL. You will need this later. For example:
If you do not yet have the Transformation Advisor installed follow the installation instructions here.
To get started with the Transformation Advisor:
-
Go to your IBM Cloud Private UI and use the
☰button to show the sidebar menu. -
Select
Platform ▷ Transformation.
-
On the welcome screen, click the
+to add a workspace.
-
Create a new workspace that will be used to house your recommendations. The workspace name can be any string you want, such as the project name or the name for the portfolio of applications you will be analysing -- basically anything that will help you to easily identify your work when you return to it at a later date.
-
You will then be asked to enter a collection name. This is an opportunity for you to subdivide your work even further into a more focused grouping. It would typically be associated with a single run of the Data Collector and may be the name of the individual WAS server that you will be running the Data Collector on. It can be any string and can be deleted later -– so don’t be afraid to get creative!
-
Hit
Let’s Go.
If you don't want to run our sample app and the Data Collector in your own WAS environment, you can use the files that we already collected and saved in data/examples. Just upload them in the next step to continue.
The Data Collector identifies which profiles are associated with the WebSphere installation along with the installed WebSphere and Java versions. It also identifies all WebSphere applications within each deployment manager and standalone profile. The tool generates one folder per profile and places analysis results within that directory.
Note: The Data Collector will collect configuration information in WAS installations at version 7 or later.
The Data Collector tab should now display the screen shown below. The Data Collector is a downloadable zip file that needs to be extracted and run on your target server where the applications you wish to migrate are located (i.e., your WAS application server machine). You should choose the correct Data Collector for your target server’s operating system.
-
Download the zip file to your browser's download directory.
WARNING: The Data Collector is likely to consume a significant amount of resources while gathering data. Therefore, we recommend you run the tool in a pre-production environment. Depending on the number, size and complexity of your applications the Data Collector may take quite some time to execute and upload results.
Once downloaded, follow these steps:
-
Copy/FTP from your download directory to your target server. Put the zip file in a directory where you have read-write-execute access.
-
Decompress the downloaded file. Your file name will be specific to your platform/version/collection.
tar xvfz transformationadvisor-2.1_Linux_example.tgz -
Go to the Data Collector directory.
cd transformationadvisor-2.1 -
Perform analysis of app, .ear and .war files on IBM WebSphere applications.
./bin/transformationadvisor -w <WEBSPHERE_HOME_DIR> -p <PROFILE_NAME> <WSADMIN_USER> <WSADMIN_PASSWORD> -no-version-check
If there is a connection between your system and your new collection, the Data Collector will send your application data for you. Use the Recommendations tab to see the results and continue with the following section:
5. View the recommendations and cost estimates.
If there is no connection, the Data Collector will return a .zip file containing your application data. Use the Recommendations tab to upload the .zip file(s).
-
Find the results for each profile. These are zip file(s) created by the Data Collector with the same name as the profile. You will find the zip file(s) in the transformationadvisor directory of the Data Collector.
-
Copy the zip file(s) to your local system and select them use the
Drop or Add Filebutton. -
Use the
Uploadbutton to upload the files.
Selecting the Recommendations tab after the Data Collector has completed and uploaded results should display a screen similar to that shown below. Please be aware that any cost estimates displayed by the tool are high-level estimates only and may vary widely based on skills and other factors not considered by the tool.
Note: You can use the
Advanced Settingsgear icon to change theDev cost multiplierandOverhead costand adjust the estimates for your team.
The recommendations tab shows you a table with a summary row for each application found on your application server. Each row contains the following information:
| Column | Description |
|---|---|
| A drop-down arrow lets you expand the summary row to see the analysis for other targets. | |
| Alert icons may appear to indicate apps that are incompatible with a target. | |
| Application | The name of the EAR/WAR file found on the application server. |
| An indicator to show how complex Transformation Advisor considers this application to be if you were to migrate it to the cloud. | |
| Tech match | This is a percentage and if less than 100% it indicates that there may be some technologies that are not suitable for the recommended platform. You should investigate the details and ensure your application is actually using the technologies. |
| Dependencies | This shows potential external dependencies detected during the scan. Work may be needed to configure access to these external dependencies. |
| Issues | This indicates the number and severity of potential issues migrating the application. |
| Est. dev cost | This is an estimate in days of the development effort to perform the migration. |
| Total effort | This is the total estimate in days of the overhead and development costs in migration up to the point of functional testing. |
The Migration plan button will take you to the Migration page for the application. |
Each column in the table is sortable. There is also a Search items box which allows you to filter out rows of data. You can use the + symbol to see only rows that match all your terms (e.g., Liberty+Simple). You can filter by complexity using the filter button.
Clicking on your application name will take you to more information about the discovered Complexity and Application Details. For starters, the complexity rating is explained for you.
You will also see details for each issue and dependency discovered:
There will be additional sections to show any technology issues, external dependencies, and additional information related to your application transformation.
Scroll to the end of the recommendations screen to find three links to further detailed reports.
The three reports are described as follows:
The binary scanner’s detailed migration report digs deeper to understand the nitty-gritty details of the migration. The detailed report helps with migration issues like deprecated or removed APIs, Java SE version differences, and Java EE behavior differences. Please note that the Transformation Advisor uses a rule system based on common occurring events seen in real applications to enhance the base reports and to provide practical guidance. As a result of this some items may show a different severity level in Transformation Advisor than they do in the detailed binary scanner reports.
The binary scanner can examine your application and generate the Application Evaluation Report, which shows which editions of WebSphere Application Server are best suited to run the application. The report provides a list of Java EE programming models that are used by the application, and it indicates on which platforms the application can be supported.
The binary scanner has an inventory report that helps you examine what’s in your application including the number of modules and the technologies in those modules. It also gives you a view of all the utility JAR files in the application that tend to accumulate over time. Potential deployment problems and performance considerations are also included.
Select the Application you wish to migrate from the Recommendations tab and hit the Migration plan button.
Transformation Advisor will automatically generate the artifacts you need to get your application deployed and running in a Liberty container on IBM Cloud Private, including...
- server.xml
- Dockerfile
- Helm Charts
- deployment.yaml
It also creates the build artifacts needed by Microclimate to build and deploy your application, including...
- Jenkinsfile
- pom.xml
You will need to add the application binary itself (EAR/WAR file) and any external dependencies that may be particular to your application such as database drivers. These files can easily be added on the migration plan page at the click of a button.
Once all required application dependencies are uploaded, you will be able to use the buttons to Download bundle and/or Deploy Bundle.
-
To deploy to IBM Cloud Private, press the
Deploy Bundlebutton and continue with steps 7 and 8 ( Create a GitHub or GitLab repository and Deploy your application) to automatically deploy the application using Microclimate. -
To manually deploy to IBM Cloud Kubernetes Service, hit the
Download bundlebutton and follow step 9 (Deploy to IBM Cloud Kubernetes Service (IKS)).
If you don’t already have a GitHub account that you can use, signup for one here.
-
Once you have an account, create a repository to upload your migrating application to.
-
Take note of the URL to your Git repository.
-
Optionally, generate an access token (so you don't need to use your password).
- Go to your user settings and select
Developer settingsand thenPersonal access tokens. - Click on the
Generate new tokenbutton, give it a description and define scopes and then hitGenerate token. - Copy the token! You will need it later.
- Go to your user settings and select
After you hit the Deploy Bundle button, you will be asked on the next screen to fill in the details you saved from earlier steps as shown below...
Use the Git URL and credentials and the Microclimate URL you gathered earlier. The Microclimate project name can be anything you want as long as it’s unique and a lowercase string.
Hit the Deploy button and Transformation Advisor will begin the three-step process of deploying the application to IBM Cloud Private by...
- Pushing the bundle to Git
- Connecting with Microclimate and creating a project
- Kicking off the Jenkins pipeline in Microclimate to pull the migration bundle from Git, containerize your application, and deploy it.
Once these steps are complete, you should see the three steps complete as below.
You can see the files you have pushed to Git by following the View bundle in Github link. If you wish, you can edit the migration bundle files directly in Git.
At this point TA has handed off the build and deployment work to Microclimate. You can follow the links to View and edit project in Microclimate or View and track pipeline in Jenkins.
If you chose to view the project, you will be taken to Microclimate Projects UI.
If you chose to track the pipeline, you will be taken to Jenkins.
It may take several minutes to complete, you can view the log files for each stage from this UI also.
Once complete you can go back to the ICP Dashboard and check that your application is deployed and running. Check under Workloads ▷ Deployments in the ☰ "hamburger" menu.
Access the migrated app on ICP by going to this address (note the fragment for the resorts app example):
http://<Ingress IP>:<TCP PORT>/resorts/
-
You must have at least one cluster available on IKS. If not, create one following this guide. Hint: Follow the In the IBM Cloud console link. It's the easy path.
-
You must have the following installed in your developer environment:
-
Run the following commands to add the IBM Cloud Container plug-ins to your IBM Cloud CLI:
ibmcloud plugin install container-registry -r Bluemix ibmcloud plugin install container-service -r Bluemix -
You can confirm that all required plugins (container-registry and container-service) are installed with this command:
ibmcloud plugin list
-
Login to IKS from a terminal (use
ibmcloud help loginto see more options):ibmcloud loginAfterwards, a one time passcode link will be prompted. Go to that link and copy the passcode back to the terminal to proceed.
-
Set the region to your cluster's region (use
ibmcloud ks regionsto see all available regions):ibmcloud cs region-set <region-name> -
Login to the IBM Cloud Container Registry:
ibmcloud cr login -
Find your namespace in the list:
ibmcloud cr namespace-list -
Add a Microclimate token:
To deploy to the IKS, the Microclimate Helm chart must be configured so that pipelines push images to a registry that is accessible by both IBM Cloud Private and IKS, for example, the IBM Cloud Container Registry. For the IBM Cloud Container Registry, the Docker registry URL should be in the format:
registry.<region>.bluemix.net/<my_namespace>To access the registry, Microclimate needs a non-expiring token with read-write access. This can be created by using the IBM Cloud Container Registry command line plugin as follows:
ibmcloud cr token-add --description "Microclimate token" --non-expiring --readwriteThe Docker registry secret for Microclimate should specify this token as the password, and a username of
token. Run the following command with your own<token_value>,<region>, and<namespace>.kubectl create secret docker-registry microclimate-registry-secret \ --docker-server=registry.<region>.bluemix.net/<namespace> \ --docker-username=token \ --docker-password=<token_value> \ --docker-email=nullThe default service account in the IKS namespace to which applications are deployed must be configured to have at least read access to this registry.
-
Initialize Helm:
The IKS cluster must also have Helm initialized without TLS authentication:
helm initNote: Microclimate has been tested with Helm versions 2.7.2 and 2.8.2.
-
Set the CLI context to your cluster (use
ibmcloud ks clustersto list all):Access to the IKS cluster is provided to Microclimate by defining a secret containing the cluster configuration. The cluster configuration can be retrieved from IKS by using the IKS command line plugin and the following command:
ibmcloud cs cluster-config <cluster_name>This exports a
*.ymlfile that contains the configuration and a corresponding certificate in a*.pemfile. Do not export theKUBECONFIGenvironment variable as instructed by the command output as this may result in additional cluster configuration being added to the file. -
Create and label a secret:
Change to the directory that contains the
*.ymland*.pemfiles and then issue the following commands to create a secret in the namespace that contains Microclimate, labelled to indicate that it contains a cluster configuration. The secret name can be any valid Kubernetes resource name.kubectl create secret generic <secret_name> \ --from-file=kube-config.yml=<yaml_file>.yml \ --from-file=<certificate_file>.pem kubectl label secret <secret_name> microclimate-type=cluster-config
-
Copy the Migration Bundle that you downloaded from Transformation Advisor to the machine where you have completed the install of the CLIs above.
-
Unzip the zip file. Use the unzipped directory as <MIGRATION_BUNDLE_HOME> in the steps below.
-
Use docker to build an image. Build at the same level as Dockerfile.
Note: Use your
regionandnamespaceand give your app aninstance-nameand versiontag.cd <MIGRATION_BUNDLE_HOME> docker build -t registry.<region>.bluemix.net/<namespace>/<instance-name>:<tag> . -
Upload the docker image to the IKS private registry:
docker push registry.ng.bluemix.net/<namespace>/<instance-name>:<tag>Check if your image has been uploaded successfully:
ibmcloud cr image-list -
Edit the
values.yamlfile under<MIGRATION_BUNDLE_HOME>/chart/<application-name>/as follows:- Edit the repository value to the new IKS private registry link. For example:
repository: "registry.ng.bluemix.net/<namespace>/<instance-name>" - Edit the “tag” field to match the tag used in your IKS private registry.
- Edit the repository value to the new IKS private registry link. For example:
-
Run the Helm install command:
cd <MIGRATION_BUNDLE_HOME>/chart/<application-name>/ helm install . --name <application-name> -
Access your app running in the public cloud:
Run this command to find the port for your application:
helm status <application-name>Note: The port information is in the command output under the column "PORT(S)" with a value like 9080:30845/TCP, and in this case the 2nd number, 30845, is the port to use.
Run this command to find the public IP for your cluster:
ibmcloud cs workers <cluster_name>Note: The public IP information is in the command output under the column "Public IP".
Access the migrated app on IKS by going to this address (note the fragment for the resorts app example):
http://<IP>:<PORT>/resorts/
- Watch the video
- Transformation Advisor introductory video
- IBM Microclimate demo video
- Microclimate learning resources and documentation
- Deploying Transformation Advisor
- Tutorial: Deploying apps into Kubernetes clusters
- Install Transformation Advisor locally
- Artificial Intelligence Code Patterns: Enjoyed this code pattern? Check out our other AI Code Patterns.
- AI and Data Code Pattern Playlist: Bookmark our playlist with all of our Code Pattern videos
- With Watson: Want to take your Watson app to the next level? Looking to utilize Watson Brand assets? Join the With Watson program to leverage exclusive brand, marketing, and tech resources to amplify and accelerate your Watson embedded commercial solution.
- Kubernetes on IBM Cloud: Deliver your apps with the combined the power of Kubernetes and Docker on IBM Cloud
This code pattern is licensed under the Apache Software License, Version 2. Separate third party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 (DCO) and the Apache Software License, Version 2.