From df5c5c8c98128267115186fca056f134163c2a13 Mon Sep 17 00:00:00 2001 From: alexwolfmsft <93200798+alexwolfmsft@users.noreply.github.com> Date: Thu, 5 Sep 2024 14:03:33 -0400 Subject: [PATCH] Update appcat config (#42478) Add configuration and FAQ docs for migrate tool --- docs/azure/TOC.yml | 2 + .../migration/appcat/custom-configuration.md | 38 +++++++++---------- docs/azure/migration/appcat/faq.md | 34 +++++++++++++++++ 3 files changed, 53 insertions(+), 21 deletions(-) create mode 100644 docs/azure/migration/appcat/faq.md diff --git a/docs/azure/TOC.yml b/docs/azure/TOC.yml index f413e030c06d4..6e0d1970a5339 100644 --- a/docs/azure/TOC.yml +++ b/docs/azure/TOC.yml @@ -37,6 +37,8 @@ href: ./migration/appcat/interpret-results.md - name: Custom configuration href: ./migration/appcat/custom-configuration.md + - name: FAQ + href: ./migration/appcat/faq.md - name: Choose the right Azure hosting option href: ./migration/choose.md - name: Migrate a .NET web app or service to Azure App Service diff --git a/docs/azure/migration/appcat/custom-configuration.md b/docs/azure/migration/appcat/custom-configuration.md index 36cb5e967f9bd..f7d6ca080fa88 100644 --- a/docs/azure/migration/appcat/custom-configuration.md +++ b/docs/azure/migration/appcat/custom-configuration.md @@ -6,11 +6,9 @@ ms.date: 08/02/2024 author: mckennabarlow ms.author: mcbarlow --- -# How to customize analysis with run config +# How to customize analysis using run configs -## Overview - -Before running an analysis, AppCAT discovers all rules and analyzers provided to it and then uses that information to match the project's `traits`. However, the analysis results can be overly verbose when using the default configuration. +The Azure Migrate application and code assessment tool supports custom analysis using run configs. Before the tool runs an analysis, it discovers all available rules and analyzers and then uses the ones that match current project's traits. However, some results might be too noisy for some applications. To control/scope rules and/or analyzers used, you can provide a JSON run configuration file. This allows you to: @@ -22,22 +20,24 @@ To control/scope rules and/or analyzers used, you can provide a JSON run configu ## How to provide a JSON run configuration -### Using the CLI +## [.NET CLI](#tab/cli) + +The Azure Migrate application and code assessment tool enables you to [Analyze applications with the .NET CLI](dotnet-cli.md). When using the CLI, there are two options to provide a run config: -- **Interactive mode**: The CLI will ask if you want to provide run configuration. Upon selecting *yes*, it prompts the user to type/paste the path to the run configuration file. -- **Non-interactive mode**: Use the `-c|--config` argument. This allows you to provide the path to the JSON run configuration. +- **Interactive mode**: The CLI asks if you want to provide run config. Select `Yes` and then provide the path to the run config file. +- **Non-interactive mode**: Provide the `-c` or `--config` argument, which allows you to provide the path to the run config JSON. -### Using Visual Studio +## [Visual Studio](#tab/visual-studio) -- When editing analysis settings, use the UI to specify JSON run configuration. +The Azure Migrate application and code assessment tool enables you to [Analyze applications with Visual Studio](visual-studio.md). During the step that allows you to edit analysis settings, select the **Browse** button to locate and select a run config JSON file. After analysis is done, run configuration is stored in the report. The configuration is re-used if the user reopens the report and refreshes. -After analysis is done, run configuration is stored in the report. The configuration is re-used if the user reopens the report and refreshes. +--- ## Run config schema -Here is a sample run config: +Consider the following sample run config: -``` +```json { "analysis": { "settings": { @@ -84,11 +84,8 @@ Here is a sample run config: ] } } - ``` -Looking at the JSON objects contained in the preceding example: - - `analysis.settings` contains global includes or excludes. These include and exclude binaries to be analyzed. It's recommended to run binary analysis once to see any red flags, but results for binaries tend to be verbose. Some of the results could flag problems inside dependencies your application is consuming. Other results could be valid problems in your app, but located in unused code paths. These can be ignored to reduce the verbosity of the results. - `analysis.rules` contains rules definitions. These definitions override or disable existing rules, as well as define new rules. - `analysis.analyzers` contains analyzers. Similarly to the rules definitions, these can be disabled, overridden, or added on to. @@ -97,14 +94,13 @@ Looking at the JSON objects contained in the preceding example: ### Add new rule -``` +```json { "rules": [ { "id": "Category.NumericId", "severity": "potential", "effort": 5 - ... } ] } @@ -112,7 +108,7 @@ Looking at the JSON objects contained in the preceding example: ### Modify existing rule -``` +```json { "rules": [ { @@ -125,7 +121,7 @@ Looking at the JSON objects contained in the preceding example: ### Disable existing rule -``` +```json { "rules": [ { @@ -138,7 +134,7 @@ Looking at the JSON objects contained in the preceding example: ### Disable existing analyzer -``` +```json { "analyzers": [ { @@ -151,7 +147,7 @@ Looking at the JSON objects contained in the preceding example: ### Add new analyzer for some existing or new rule -``` +```json { "analyzers": [ { diff --git a/docs/azure/migration/appcat/faq.md b/docs/azure/migration/appcat/faq.md new file mode 100644 index 0000000000000..992aede27458c --- /dev/null +++ b/docs/azure/migration/appcat/faq.md @@ -0,0 +1,34 @@ +--- +title: Azure Migrate application and code assessment for .NET FAQ +description: Frequently asked questions for the Azure Migrate application and code assessment for .NET +ms.topic: conceptual +ms.date: 08/16/2024 +--- + +# Frequently asked questions + +This page answers some of the most common questions about the Azure Migrate application and code assessment tool. + +### What is Azure Migrate application and code assessment? + +Azure Migrate application and code assessment for .NET is a free tool by Microsoft that focuses on code and application analysis and recommendations for planning cloud deployments. The tool improves confidence in running business-critical solutions in the cloud through a developer-oriented assessment experience of source code. It also provides recommendations and examples to optimize code and configurations for the cloud. The recommendations align with industry-proven practices to build reliable, modern, and innovative applications on Azure. + +### What scenarios should I use Azure Migrate application and code assessment for? + +For scenarios that require deeper analysis of the application and migration guidance, several other dimensions such as source code, application configuration and dependency analysis become necessary. Azure Migrate application and code assessment for .NET assists with full source code level scanning and application scanning to produce a comprehensive report for your migration needs. + +### When should I use Azure Migrate application and code assessment? + +Use this tool if you manage application development projects and have access to source code written in .NET and you want to move to Azure. The tool can help you learn about how to replatform your applications to be cloud ready. Azure Migrate application and code assessment for.NET can help you generate deep analysis with dependencies clearly laid out with a dashboard. It tells you what the mandatory changes are that you need to apply for it to run on Azure. + +### Do I need to pay to use Azure Migrate application and code assessment? + +No, it's a free tool. + +### Do I need Visual Studio to use the Azure Migrate application and code assessment CLI tool? + +No, the only prerequisite for using the CLI tool is that you have the .NET SDK (6.0 or greater) installed. + +### Which target destinations does it cover today? + +The tool covers various Azure services including Azure App Service, Azure Spring Apps, Azure Container Apps, and Azure Kubernetes Service.