Skip to content

Commit e2e7968

Browse files
committed
edits
1 parent 5f7efdf commit e2e7968

File tree

7 files changed

+191
-159
lines changed

7 files changed

+191
-159
lines changed

articles/migrate/appcat/appcat7-cli-guide.md

Lines changed: 104 additions & 88 deletions
Large diffs are not rendered by default.

articles/migrate/appcat/appcat7-interpret-report.md

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,79 @@
11
---
2-
title: Interpret the AppCAT 7 report
2+
title: Interpret the AppCAT 7 Report
33
description: Azure Migrate application and code assessment tool - Interpret AppCAT report.
44
author: KarlErickson
55
ms.author: karler
66
ms.reviewer: brborges
77
ms.service: azure
8-
ms.custom:
9-
- devx-track-java
10-
- devx-track-extended-java
11-
- build-2025
8+
ms.custom: devx-track-java, build-2025
129
ms.topic: overview
13-
ms.date: 01/15/2025
10+
ms.date: 06/27/2025
1411
#customer intent: As a developer, I want to assess my Java application so that I can understand its readiness for migration to Azure.
1512
---
1613
# Interpret the AppCAT 7 report
17-
This document guides you through the AppCAT report to help you well understand it for assessing the migration readiness of your Java application to Azure. The report provides a comprehensive overview of the application and its components. You can use this report to gain insights into the structure and dependencies of the application, and to determine its suitability for replatform and modernization.
14+
15+
This article guides you through the AppCAT report to help you well understand it for assessing the migration readiness of your Java application to Azure. The report provides a comprehensive overview of the application and its components. You can use this report to gain insights into the structure and dependencies of the application, and to determine its suitability for replatform and modernization.
16+
1817
## Application list view
1918
The landing page of the report presents a overall view of all analyzed applications. From here, you can navigate to individual application reports to explore detailed findings.
2019

2120
:::image type="content" source="media/java/appcat-7-report-applist.png" alt-text="app list of the AppCAT assessment report." lightbox="media/java/appcat-7-report-applist.png":::
21+
2222
## Application view
23+
2324
The application report consists of 3 sections:
25+
2426
- **Application Information**: Reveals the basic information of your application including Java version, framework, build tool, etc.
2527
- **Issue Summary**: shows the issue overview for three domains with percentage on issue criticality.
2628
- The detail report is organized into 4 sub sections:
2729
- **Issues**: Provides a concise summary of all issues that require attention.
2830
- **Dependencies**: Displays all Java-packaged dependencies found within the application.
2931
- **Technologies**: Displays all embedded libraries grouped by functionality, allowing you to quickly view the technologies used in the application.
3032
- **Insights**: Detailed files and information to better understand detected technologies.
31-
33+
3234
:::image type="content" source="media/java/appcat-7-report-app.png" alt-text="app view of the AppCAT assessment report." lightbox="media/java/appcat-7-report-app.png":::
35+
3336
### Issues
34-
Access this part by clicking the Issues tab. It provides a categorized issue list of various aspects of Azure readiness, cloud native, and Java modernization that you need to address to successfully migrate the application to Azure. Learn more about domain and criticality via below sections.
3537

36-
|Domain|Description|
37-
|---------|---------|
38-
|Azure readiness|Identifies app dependencies and suggests equivalent Azure solutions|
39-
|cloud native|Assesses how well the app follows cloud-native practices like scalability and containerization|
40-
|Java modernization|Identifies JDK and framework issues for version upgrade|
38+
Access this part by clicking the Issues tab. It provides a categorized issue list of various aspects of Azure readiness, cloud native, and Java modernization that you need to address to successfully migrate the application to Azure. Learn more about domain and criticality via below sections.
39+
40+
| Domain | Description |
41+
|--------------------|------------------------------------------------------------------------------------------------|
42+
| Azure readiness | Identifies app dependencies and suggests equivalent Azure solutions |
43+
| cloud native | Assesses how well the app follows cloud-native practices like scalability and containerization |
44+
| Java modernization | Identifies JDK and framework issues for version upgrade |
4145

42-
|Criticality|Description|
43-
|---------|---------|
44-
|Mandatory|Issues that must be fixed for migration to Azure|
45-
|Potential|Issues that might impact migration and need review|
46-
|Optional|Low-impact issues; fixing them is recommended but optional|
46+
| Criticality | Description |
47+
|-------------|------------------------------------------------------------|
48+
| Mandatory | Issues that must be fixed for migration to Azure |
49+
| Potential | Issues that might impact migration and need review |
50+
| Optional | Low-impact issues; fixing them is recommended but optional |
4751

4852
:::image type="content" source="media/java/appcat-7-report-issues.png" alt-text="issues of the AppCAT assessment report." lightbox="media/java/appcat-7-report-issues.png":::
4953

5054
Each reported issue can be expanded, by clicking on the title, to obtain additional details. The following information is provided:
55+
5156
- A list of files where the incidents occurred, along with the number of code lines impacted. If the file is a Java source file, then clicking the filename will direct you to the corresponding Source report.
5257
- A detailed description of the issue. This description outlines the problem, provides any known solutions, and references supporting documentation regarding either the issue or resolution.
5358

5459
:::image type="content" source="media/java/appcat-7-report-issue-detail.png" alt-text="issue detail of the AppCAT assessment report." lightbox="media/java/appcat-7-report-issue-detail.png":::
5560

5661
:::image type="content" source="media/java/appcat-7-report-issue-code.png" alt-text="issue code of the AppCAT issue code report." lightbox="media/java/appcat-7-report-issue-code.png":::
57-
62+
5863
### Technologies
59-
Access this part by clicking the Technologies tab. The report lists the occurrences of technologies, grouped by function, in the analyzed application. It is an overview of the technologies found in the application, and is designed to assist users in quickly understanding each application’s purpose.
64+
65+
Access this part by clicking the Technologies tab. The report lists the occurrences of technologies, grouped by function, in the analyzed application. It is an overview of the technologies found in the application, and is designed to assist users in quickly understanding each application's purpose.
6066

6167
:::image type="content" source="media/java/appcat-7-report-technologies.png" alt-text="technologies of the AppCAT assessment report." lightbox="media/java/appcat-7-report-technologies.png":::
68+
6269
### Dependencies
70+
6371
Access this part by clicking the Dependencies tab. Displays all Java-packaged dependencies found within the application.
6472

6573
:::image type="content" source="media/java/appcat-7-report-dependencies.png" alt-text="dependencies of the AppCAT assessment report." lightbox="media/java/appcat-7-report-dependencies.png":::
74+
6675
### Insights
76+
6777
Access this part by clicking the Insights tab. Detailed files and information to better understand detected technologies.
6878

6979
:::image type="content" source="media/java/appcat-7-report-insights.png" alt-text="Insights of the AppCAT assessment report." lightbox="media/java/appcat-7-report-insights.png":::

articles/migrate/appcat/appcat7-quick-start.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
11
---
2-
title: Quick start to assess a java project using AppCAT 7
2+
title: "Quickstart: Assess a Java Project using AppCAT 7"
33
description: Azure Migrate application and code assessment tool - Quick start to assess a java project.
44
author: KarlErickson
55
ms.author: karler
66
ms.reviewer: brborges
77
ms.service: azure
8-
ms.custom:
9-
- devx-track-java
10-
- devx-track-extended-java
11-
- build-2025
8+
ms.custom: devx-track-java, build-2025
129
ms.topic: overview
13-
ms.date: 01/15/2025
10+
ms.date: 06/27/2025
1411
#customer intent: As a developer, I want to assess my Java application so that I can understand its readiness for migration to Azure.
1512
---
16-
# Quick start to assess a java project using AppCAT 7
17-
This document describes how to download, install and run AppCAT 7 against a sample Java project.
13+
14+
# Quickstart: Assess a java project using AppCAT 7
15+
16+
This article describes how to download, install and run AppCAT 7 against a sample Java project.
1817

1918
## Prerequisites
19+
2020
Before downloading AppCAT, please make sure JDK is installed and configured correctly.
21+
2122
- [Download](/java/openjdk/download#openjdk-17) and [install Microsoft Build of OpenJDK 17](/java/openjdk/install). Ensure that the `JAVA_HOME` environment variable is set.
2223

2324
## Download and install
@@ -74,34 +75,33 @@ Extract the binary from the downloaded file. You should see the following folder
7475
```
7576

7677
## Run AppCAT against a sample Java project
78+
7779
In following steps, let's do application assessment using AppCAT against [Airsonic-Advanced](https://github.com/airsonic-advanced/airsonic-advanced) - a community-driven, web-based media streamer that enables you to access and share your music collection.
7880

7981
1. To run `appcat` from any location in your terminal, extract the archive to your desired location. Then, update the `PATH` environment variable to include the directory where you extracted the archive.
8082

81-
> [!NOTE]
82-
> When the `appcat` binary is called, it first looks for its dependencies in the executable folder specified in the `PATH` environment variable. If the dependencies aren't found, it falls back to the user's home directory - **~/.appcat** on Linux/Mac or **%USERPROFILE%\\.appcat** on Windows.
83-
84-
2. Clone the application repository to a local folder using the following command:
83+
> [!NOTE]
84+
> When the `appcat` binary is called, it first looks for its dependencies in the executable folder specified in the `PATH` environment variable. If the dependencies aren't found, it falls back to the user's home directory - **~/.appcat** on Linux/Mac or **%USERPROFILE%\\.appcat** on Windows.
8585
86-
```sh
87-
git clone https://github.com/airsonic-advanced/airsonic-advanced.git
88-
```
86+
1. Clone the application repository to a local folder using the following command:
8987

90-
3. Run the assessment scripts living in samples folder of the downloaded AppCAT release package with providing the path to the cloned folder above. Depending on your operating system, run the appropriate script, as shown in the following example. The reports are automatically generated and opened in your web browser. You can find the reports under **../samples/report-\*** (Linux/macOS) or **..\samples\report-\*** (Windows).
88+
```sh
89+
git clone https://github.com/airsonic-advanced/airsonic-advanced.git
90+
```
9191

92-
# [Linux / macOS](#tab/linux)
92+
1. Run the assessment scripts living in samples folder of the downloaded AppCAT release package with providing the path to the cloned folder above. Depending on your operating system, run the appropriate script, as shown in the following example. The reports are automatically generated and opened in your web browser. You can find the reports under **../samples/report-\*** (Linux/macOS) or **..\samples\report-\*** (Windows).
9393

94-
```bash
95-
./samples/run-assessment <path-to-airsonic-advanced>
96-
```
94+
### [Linux / macOS](#tab/linux)
9795

98-
# [Windows](#tab/windows)
96+
```bash
97+
./samples/run-assessment <path-to-airsonic-advanced>
98+
```
9999

100-
```cmd
101-
.\samples\run-assessment.bat <path-to-airsonic-advanced>
102-
```
100+
### [Windows](#tab/windows)
103101

104-
---
102+
```cmd
103+
.\samples\run-assessment.bat <path-to-airsonic-advanced>
104+
```
105105

106106
> [!NOTE]
107107
> Ensure that the file permissions for scripts in the extracted folder are set to allow execution.
@@ -115,6 +115,7 @@ In the **samples** directory, you can find the following scripts to run differen
115115
- **run-assessment-package-only**: Produces a report by assessing specific packages.
116116

117117
## Next steps
118+
118119
- [Interpret the report](appcat7-interpret-report.md)
119120
- [CLI Command Guide for AppCAT 7](appcat7-cli-guide.md)
120121
- [Create custom rules for AppCAT 7](appcat7-rule-guide.md)

articles/migrate/appcat/appcat7-release-notes.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
---
2-
title: Release notes for AppCAT 7
2+
title: Release Notes for AppCAT 7
33
description: Azure Migrate application and code assessment tool - release notes.
44
author: KarlErickson
55
ms.author: karler
66
ms.reviewer: brborges
77
ms.service: azure
8-
ms.custom:
9-
- devx-track-java
10-
- devx-track-extended-java
11-
- build-2025
8+
ms.custom: devx-track-java, build-2025
129
ms.topic: overview
13-
ms.date: 01/15/2025
10+
ms.date: 06/27/2025
1411
#customer intent: As a developer, I want to assess my Java application so that I can understand its readiness for migration to Azure.
1512
---
1613

1714
# Release notes
15+
1816
### 7.7.0.0 (GA)
17+
1918
This release contains the following fixes and enhancements:
19+
2020
- Added graceful error handling with well-defined exit codes for different kinds of errors.
2121
- Removed `appcat test` command.
22-
- Enhanced report with adding application overview section.
23-
- Bug Fix: fixed mvnw is not executable in Linux and macOS.
22+
- Enhanced report by adding application overview section.
23+
- Bug fix: `mvnw` is now executable in Linux and macOS.
2424

2525
### 7.6.0.7
2626

@@ -31,13 +31,13 @@ This release contains the following fixes and enhancements.
3131
- Show assessment progress by displaying the number of rules processed during assessment.
3232
- Removed Maven from prerequisites.
3333
- Replaced `airsonic.war` with `airsonic-advanced` as the sample application in the released artifacts.
34-
34+
3535
### 7.6.0.6
3636

3737
This release contains the following fixes and enhancements.
3838

3939
- A default **.appcat-ignore** file is now included in the release package by default. This file causes the tool to exclude specified folders or paths that don't need to be analyzed.
40-
- Fixed the issue of missing dependencies in the report when using `full` mode (specified by using `--mode`).
40+
- Fixed the issue of missing dependencies in the report when using `full` mode - specified by using `--mode`.
4141
- Scoped analysis to AppCAT-supported targets when no targets are specified.
4242
- Ignored comment lines during analysis.
4343
- Fixed incorrect location for XML rules.
@@ -107,13 +107,14 @@ This release is based on a different set of components of the Konveyor project.
107107
- New engine based on the [Konveyor Analyzer LSP](https://github.com/konveyor/analyzer-lsp) project, with a CLI based on the [Konveyor Kantra](https://github.com/konveyor/kantra/) project.
108108

109109
## Known issues
110+
110111
### 7.7.0.0
111112

112113
- Rules issues:
113114
- The `azure-system-config-01000` rules aren't being triggered.
114115
- The `azure-password-01000` rule detects only one violation, even when multiple violations exist in the same file.
115116
- An error in the Watcher Error channel on Windows: `Windows system assumed buffer larger than it is, events have likely been missed`. This error message appears on the command line during long-running jobs on Windows.
116-
117+
117118
### 7.6.0.7
118119

119120
- Rules issues:

articles/migrate/appcat/appcat7-rule-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.reviewer: brborges
77
ms.service: azure
88
ms.custom: devx-track-java, devx-track-extended-java
99
ms.topic: overview
10-
ms.date: 05/28/2025
10+
ms.date: 06/27/2025
1111
#customer intent: As a developer, I want to assess my Java application so that I can understand its readiness for migration to Azure.
1212
---
1313

@@ -19,7 +19,7 @@ For more information, see the Introduction to the [Azure Migrate application and
1919

2020
The AppCAT contains rule-based migration tools that analyze the APIs, technologies, and architectures used by the applications you plan to migrate. In fact, the AppCAT analysis process is implemented using AppCAT rules. AppCAT uses rules internally to extract files from archives, decompile files, scan and classify file types, analyze XML and other file content, analyze the application code, and build the reports.
2121

22-
## Getting start with rules
22+
## Get started with rules
2323

2424
The [AppCAT ruleset project ](https://github.com/Azure/appcat-konveyor-rulesets) contributes future rules to aid static code analysis as well as issues shared by subject matter experts to aid creation of richer Rulesets.
2525

articles/migrate/appcat/java-6.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.date: 07/12/2024
1414
# Azure Migrate application and code assessment for Java
1515

1616
> [!NOTE]
17-
> This version of *Azure Migrate application and code assessment for Java* is under no maintenance and going to be deprecated. We have released a new version 7.x, based on a new analyzer engine. To download and experiment with the new engine, available for Windows, Linux, and macOS, see [Azure Migrate application and code assessment for Java version 7](./java.md)
17+
> This version of *Azure Migrate application and code assessment for Java* is under no maintenance and going to be deprecated. We have released a new version 7.x, based on a new analyzer engine. To download and experiment with the new engine, available for Windows, Linux, and macOS, see [Azure Migrate application and code assessment for Java version 7](./java.md)
1818
1919
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. This tool is offered as a CLI (command-line interface) and assesses 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.
2020

@@ -61,7 +61,7 @@ When the tool assesses for Cloud Readiness and related Azure services, it can al
6161

6262
## Download
6363

64-
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).
64+
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).
6565

6666
> [!div class="nextstepaction"]
6767
> [Download Azure Migrate application and code assessment for Java 6.3.9.0](https://aka.ms/appcat/azure-migrate-appcat-for-java-cli-6.3.9.0-preview.zip). Updated on 2024-12-09.
@@ -145,7 +145,7 @@ Use the following command to initiate discovery and cloud readiness:
145145
--target discovery cloud-readiness
146146
```
147147

148-
This type of report is useful when you don't have a specific Azure service in mind to deploy your application to.
148+
This type of report is useful when you don't have a specific Azure service in mind to deploy your application to.
149149

150150
The tool always performs the `discovery` whether or not you include that value in the `--target` parameter.
151151

0 commit comments

Comments
 (0)