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
#customer intent: As a developer, I want to assess my Java application so that I can understand its readiness for migration to Azure.
10
11
---
11
12
12
13
# Azure Migrate application and code assessment for Java
@@ -15,7 +16,7 @@ This guide describes how to use the Azure Migrate application and code assessmen
15
16
16
17
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
18
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
+
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, Java Message Service (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
20
20
21
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
22
@@ -26,33 +27,33 @@ The tool is designed to help organizations modernize their Java applications in
26
27
With it, you can perform the following tasks:
27
28
28
29
* 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
-
* 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
+
* 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 to replatform your applications to Azure.
30
31
31
32
### Supported targets
32
33
33
-
The tool contains rules for helping you replatform your applications so you can deploy to, and leverage, different Azure services.
34
+
The tool contains rules for helping you replatform your applications so you can deploy to, and use, different Azure services.
34
35
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.
36
+
The rules used by Azure Migrate application and code assessment are grouped based on a *target*. A target is where or how the application runs, and general needs and expectations. When assessing an application, you can choose multiple targets. The following table describes the available targets:
| Azure App Service | Best practices for deploying an app to Azure App Service.|`azure-appservice`|
41
+
| Azure Spring Apps | Best practices for deploying an app to Azure Spring Apps.|`azure-spring-apps`|
42
+
| Azure Kubernetes Service| Best practices for deploying an app to Azure Kubernetes Service.|`azure-aks`|
43
+
| Azure Container Apps | Best practices for deploying an app to Azure Container Apps.|`azure-container-apps`|
44
+
| Cloud Readiness | General best practices for making an application Cloud (Azure) ready. |`cloud-readiness`|
45
+
| Discovery | Identifies technology usage such as libraries and frameworks.|`discovery`|
46
+
| Linux | General best practices for making an application Linux ready.|`linux`|
47
+
| OpenJDK 11 | General best practices for running a Java 8 application with Java 11. |`openjdk11`|
48
+
| OpenJDK 17 | General best practices for running a Java 11 application with Java 17. |`openjdk17`|
49
+
| OpenJDK 21 | General best practices for running a Java 17 application with Java 21. |`openjdk21`|
49
50
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.
51
+
When the tool assesses for Cloud Readiness and related Azure services, it can also report useful information for potential usage of different Azure services. The following list shows a few of the services covered:
51
52
52
53
* Azure Databases
53
54
* Azure Service Bus
54
55
* Azure Storage
55
-
* Azure CDN
56
+
* Azure Content Delivery Network
56
57
* Azure Event Hubs
57
58
* Azure Key Vault
58
59
* Azure Front Door
@@ -72,7 +73,7 @@ The `appcat` CLI is available for download as a ZIP file from [aka.ms/appcat/azu
72
73
73
74
-[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)
74
75
75
-
### Get started with `appcat`
76
+
### Get started with appcat
76
77
77
78
Unzip the zip file in a folder of your choice. You then get the following directory structure:
78
79
@@ -116,7 +117,7 @@ The following guides provide the main documentation for `appcat` for Java:
116
117
117
118
## Discover technology usage and Cloud readiness without an Azure service in mind
118
119
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.
120
+
Discovery of technologies and Cloud readiness targets provide great insight into application replatform and modernization to the Cloud. The tool scans the application and its components to gain a comprehensive understanding of its structure, architecture, and dependencies. It also finds potential issues that might be challenging in a Cloud environment. The `discovery` target in particular is used to create a detailed inventory of the application and its components. This inventory serves as the basis for further analysis and planning. For more information, see the [Discovery report](#discovery-report) section.
120
121
121
122
Use the following command to initiate discovery and cloud readiness:
122
123
@@ -128,21 +129,21 @@ Use the following command to initiate discovery and cloud readiness:
128
129
129
130
This type of report is useful when you don't have a specific Azure service in mind to deploy your application to.
130
131
131
-
The `discovery` is always performed by the tool whether or not it is included in the `--target` parameter.
132
+
The tool always performs the `discovery` whether or not you include that value in the `--target` parameter.
132
133
133
134
## Assess a Java application
134
135
135
136
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
137
-
Multiple targets may be selected in a space-delimited list of values to the `--target` argument.
138
+
You can select multiple targets by using a space-delimited list of values with the `--target` argument.
138
139
139
140
To check the available targets, run the following command:
140
141
141
142
```bash
142
143
./appcat --listTargetTechnologies
143
144
```
144
145
145
-
This command produces an output similar to the following example:
146
+
This command produces output similar to the following example:
146
147
147
148
```output
148
149
Available target technologies:
@@ -183,11 +184,11 @@ Whenever you assess an application for Azure deployment, we recommend you start
183
184
-`discovery`
184
185
-`cloud-readiness`
185
186
186
-
In addition to these, specify an Azure service in mind for deployment, such as `azure-appservice` or `azure-container-apps`.
187
+
Also, specify an Azure service for deployment, such as `azure-appservice` or `azure-container-apps`.
187
188
188
189
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
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
+
If you intend to move an application from an older version of the JDK to a newer version, we recommend that you pick the next major version compared to the previous version in use by the application. For example, use`openjdk11` when your application is currently deployed with Java 8.
191
192
192
193
## Get results from appcat
193
194
@@ -311,11 +312,11 @@ The complete guide for Rules Development is available at [azure.github.io/appcat
311
312
312
313
### 6.3.0.8
313
314
314
-
-Previously, a set of targets were enabled by default, making it difficult for certain customers to assess large applications with too many incidents related to less critical issues. To reduce noise in reports, users must now specify multiple targets, with the parameter `--target`, when executing `appcat`, giving them the option to select only the targets that matter.
315
+
Previously, a set of targets were enabled by default, making it difficult for certain customers to assess large applications with too many incidents related to less critical issues. To reduce noise in reports, users must now specify multiple targets, with the parameter `--target`, when executing `appcat`, giving them the option to select only the targets that matter.
315
316
316
317
### 6.3.0.7
317
318
318
-
-GA (Generally Available) release of Azure Migrate application and code assessment.
319
+
GA (Generally Available) release of Azure Migrate application and code assessment.
319
320
320
321
## License
321
322
@@ -343,7 +344,7 @@ Q: Where can I get some help when creating custom rules?
343
344
344
345
The best way to get help is to [create an issue on the appcat-rulesets GitHub repository](https://github.com/azure/appcat-rulesets/issues).
0 commit comments