You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Azure Migrate application and code assessment for Java
13
13
14
14
This guide describes how to use the Azure Migrate application and code assessment tool for Java to assess and replatform any type of Java application. The tool enables you to evaluate application readiness for replatforming and migration to Azure.
15
15
16
-
`appcat` is a command-line tool from Azure Migrate to assess Java application binaries and source code to identify replatforming and migration opportunities for Azure. It helps you modernize and replatform large-scale Java applications by identifying common use cases and code patterns and proposing recommended changes.
16
+
The `appcat`command line interface (CLI) is a command-line tool to assess Java application binaries and source code to identify replatforming and migration opportunities for Azure. It helps you modernize and replatform large-scale Java applications by identifying common use cases and code patterns and proposing recommended changes.
17
17
18
-
`appcat`discovers application technology usage through static code analysis, supports effort estimation, and accelerates code replatforming, helping you move Java applications to Azure. With a set of engines and rules, it can discover and assess different technologies such as Java 11, Java 17, Jakarta EE 10, Quarkus, Spring, and so on. It then helps you replatform the Java application to different Azure targets (Azure App Service, Azure Kubernetes Service, Azure Container Apps, and Azure Spring Apps) with specific Azure replatforming rules.
18
+
The tool discovers application technology usage through static code analysis, provides effort estimation, and accelerates code replatforming, helping you to prioritize and move Java applications to Azure. With a set of engines and rules, it can discover and assess different technologies such as Java 11, Java 17, Jakarta EE, Spring, Hibernate, JMS, and more. It then helps you replatform the Java application to different Azure targets (Azure App Service, Azure Kubernetes Service, Azure Container Apps, and Azure Spring Apps) with specific Azure replatforming rules.
19
19
20
-
`appcat` is open source and is based on [WindUp](https://github.com/windup), a project created by Red Hat and published under the [Eclipse Public License](https://github.com/windup/windup/blob/master/LICENSE).
20
+
This tool is open source and is based on [WindUp](https://github.com/windup), a project created by Red Hat and published under the [Eclipse Public License](https://github.com/windup/windup/blob/master/LICENSE).
21
21
22
22
## When should I use Azure Migrate application and code assessment?
23
23
24
-
`appcat` is designed to help organizations modernize their Java applications in a way that reduces costs and enables faster innovation. The tool uses advanced analysis techniques to understand the structure and dependencies of any Java application, and provides guidance on how to refactor and migrate the applications to Azure.
24
+
The tool is designed to help organizations modernize their Java applications in a way that reduces costs and enables faster innovation. The tool uses advanced analysis techniques to understand the structure and dependencies of any Java application, and provides guidance on how to refactor and migrate the applications to Azure.
25
25
26
-
With `appcat`, you can do the following tasks:
26
+
With it, you can perform the following tasks:
27
27
28
28
* Discover technology usage: Quickly see which technologies an application uses. Discovery is useful if you have legacy applications with not much documentation and want to know which technologies they use.
29
29
* Assess the code to a specific target: Assess an application for a specific Azure target. Check the effort and the modifications you have to do in order to replatform your applications to Azure.
30
30
31
-
### Supported Azure targets
31
+
### Supported targets
32
32
33
-
The tool contains rules for helping you replatform your applications so you can deploy to and use the following Azure services.
33
+
The tool contains rules for helping you replatform your applications so you can deploy to, and leverage, different Azure services.
34
34
35
-
You can use the following services as deployment targets:
35
+
The rules used by Azure Migrate application and code assessment are grouped based on a `target`. A target is where or how the application will run, as well as general needs and expectations. When assessing an application, you may choose multiple targets.
| Azure App Service | Best practices for deploying an app to Azure App Service | azure-appservice |
40
+
| Azure Spring Apps | Best practices for deploying an app to Azure Spring Apps | azure-spring-apps |
41
+
| Azure Kubernetes Service| Best practices for deploying an app to Azure Kubernetes Service | azure-aks |
42
+
| Azure Container Apps | Best practices for deploying an app to Azure Container Apps | azure-container-apps|
43
+
| Cloud Readiness | General best practices for making an application Cloud (Azure) ready | cloud-readiness |
44
+
| Discovery | Identifies technology usage such as libraries and frameworks | discovery |
45
+
| Linux | General best practices for making an application Linux ready | linux |
46
+
| OpenJDK 11 | General best practices for running a Java 8 application with Java 11 | openjdk11 |
47
+
| OpenJDK 17 | General best practices for running a Java 11 application with Java 17 | openjdk17 |
48
+
| OpenJDK 21 | General best practices for running a Java 17 application with Java 21 | openjdk21 |
47
49
48
-
You can use the following services as resource services:
50
+
When assessing for Cloud Readiness and related Azure services, the report may also include useful information for potential usage of different Azure services. Below we provide a list of a few services that are covered.
49
51
50
52
* Azure Databases
51
53
* Azure Service Bus
52
54
* Azure Storage
53
55
* Azure CDN
54
56
* Azure Event Hubs
55
57
* Azure Key Vault
58
+
* Azure Front Door
56
59
57
-
## Use Azure Migrate application and code assessment for Java
60
+
## How to use Azure Migrate application and code assessment for Java
58
61
59
-
To use `appcat`, you must download the ZIP file described in the next section, and have a compatible JDK 11+ installation on your computer. `appcat` runs on Windows, Linux, or Mac, both for Intel, Arm, and Apple Silicon hardware. You can use the [Microsoft Build of OpenJDK](/java/openjdk) to run `appcat`.
62
+
To use the `appcat` CLI, you must download the ZIP file described in the next section, and have a compatible JDK 11 or JDK 17 installation on your computer. The `appcat`CLI runs on any Java-compatible environment such as Windows, Linux, or Mac, both for Intel, Arm, and Apple Silicon hardware. We recommend you use the [Microsoft Build of OpenJDK](/java/openjdk).
60
63
61
64
### Download latest release
62
65
@@ -69,7 +72,7 @@ The `appcat` CLI is available for download as a ZIP file from [aka.ms/appcat/azu
69
72
70
73
-[Azure Migrate application and code assessment for Java 6.3.0.7](https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-6.3.0.7-preview.zip)
71
74
72
-
### Run appcat
75
+
### Get started with `appcat`
73
76
74
77
Unzip the zip file in a folder of your choice. You then get the following directory structure:
*[Rules Development Guide](https://azure.github.io/appcat-docs/rules-development-guide/)
114
116
115
-
## Discover technology usage without an Azure target in mind
117
+
## Discover technology usage and Cloud readiness without an Azure service in mind
116
118
117
-
Discovery of technologies is the first stage of application replatform and modernization. During the *discovery* phase, `appcat` scans the application and its components to gain a comprehensive understanding of its structure, architecture, and dependencies. This information is used to create a detailed inventory of the application and its components (see the [Discovery report](#discovery-report) section), which serves as the basis for further analysis and planning.
119
+
Discovery of technologies and Cloud readiness targets provide great insight into application replatform and modernization to the Cloud. The tool will scan the application and its components to gain a comprehensive understanding of its structure, architecture, and dependencies, as well as potential issues that may be challenging in a Cloud environment. The `discovery` target in particular is used to create a detailed inventory of the application and its components (see the [Discovery report](#discovery-report) section), which serves as the basis for further analysis and planning.
118
120
119
-
Use the following command to initiate discovery:
121
+
Use the following command to initiate discovery and cloud readiness:
120
122
121
123
```bash
122
124
./appcat \
123
125
--input ./<my-application-source-path or my-application-jar-war-ear-file> \
124
-
--target discovery
126
+
--target discovery cloud-readiness
125
127
```
126
128
127
-
The discovery phase is useful when you don't have a specific Azure target in mind. Otherwise, `appcat` runs discovery implicitly for any Azure target.
129
+
This type of report is useful when you don't have a specific Azure service in mind to deploy your application to.
128
130
129
-
## Assess a Java application for a specific target
131
+
The `discovery` is always performed by the tool whether or not it is included in the `--target` parameter.
130
132
131
-
The *assessment* phase is where `appcat` analyzes the application and its components to determine its suitability for replatorming and to identify any potential challenges or limitations. This phase involves analyzing the application code and checking its compliance with the selected Azure target or OpenJDK target.
133
+
## Assess a Java application
134
+
135
+
The *assessment* phase is where the `appcat` CLI analyzes the application and its components to determine its suitability for replatorming and to identify any potential challenges or limitations. This phase involves analyzing the application code and checking its compliance with the selected targets.
136
+
137
+
Multiple targets may be selected in a space-delimited list of values to the `--target` argument.
132
138
133
139
To check the available targets, run the following command:
134
140
135
141
```bash
136
142
./appcat --listTargetTechnologies
137
143
```
138
144
139
-
This command produces output similar to the following example:
145
+
This command produces an output similar to the following example:
140
146
141
147
```output
142
148
Available target technologies:
@@ -152,22 +158,37 @@ Available target technologies:
152
158
openjdk21
153
159
```
154
160
155
-
Then, you can run `appcat` using one of the available Azure targets, as shown in the following example:
161
+
Then, you can run `appcat` using one or a combination of available targets, as shown in the following example:
156
162
157
163
```bash
158
164
./appcat \
159
165
--input ./<my-application-source-path or my-application-jar-war-ear-file> \
160
-
--target azure-appservice
166
+
--target cloud-readiness linux azure-appservice
161
167
```
162
168
163
-
You can run `appcat`using one of the available OpenJDK targets, as shown in the following example:
169
+
You can also run `appcat`with one of the available OpenJDK targets, as shown in the following example:
164
170
165
171
```bash
166
172
./appcat \
167
173
--input ./<my-application-source-path or my-application-jar-war-ear-file> \
168
174
--target openjdk11
169
175
```
170
176
177
+
For OpenJDK (Java) targets, we recommend you choose only one at a time.
178
+
179
+
### Recommendation of targets for Azure assessment
180
+
181
+
Whenever you assess an application for Azure deployment, we recommend you start with the following targets:
182
+
183
+
-`discovery`
184
+
-`cloud-readiness`
185
+
186
+
In addition to these, specify an Azure service in mind for deployment, such as `azure-appservice` or `azure-container-apps`.
187
+
188
+
If you intend to move an application from a Windows environment into a Linux VM or container, we recommend you also add the `linux` target.
189
+
190
+
If you intend to move an application from an older version of the JDK to a newer version, we recommend you pick the next major version compared to the previous version in use by the application. For example, `openjdk11` when your application is currently deployed with Java 8.
191
+
171
192
## Get results from appcat
172
193
173
194
The outcome of the discovery and assessment phases is a detailed report that provides a roadmap for the replatforming and modernization of the Java application, including recommendations for the Azure service and replatform approach. The report serves as the foundation for the next stages of the replatforming process. It helps organizations learn about the effort required for such transformation, and make decisions about how to modernize their applications for maximum benefits.
@@ -190,7 +211,7 @@ The dashboard also shows the *story points*. The story points are an abstract me
190
211
191
212
### Discovery report
192
213
193
-
The discovery report is a report generated during the *Discovery Phase*. It shows the list of technologies used by the application in the *Information* category. This report is just informing you about the technology that `appcat` discovered.
214
+
The discovery report is a report generated during the *Discovery Phase*. It shows the list of technologies used by the application in the *Information* category. This report is just informing you about technology usage that `appcat` discovered.
194
215
195
216
:::image type="content" source="media/java/report-discovery.png" alt-text="Screenshot of the appcat discovery report." lightbox="media/java/report-discovery.png":::
0 commit comments