Skip to content

Commit 5e825a7

Browse files
authored
Merge branch 'main' into MTA-3259-Accessing-unmatched-rules
2 parents e7d4763 + 95d8562 commit 5e825a7

38 files changed

+898
-110
lines changed

docs/cli-guide/master.adoc

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:mta:
22
include::topics/templates/document-attributes.adoc[]
3-
:_content-type: ASSEMBLY
3+
:_mod-docs-content-type: ASSEMBLY
44
[id="cli-guide"]
55
= CLI Guide
66

@@ -19,6 +19,12 @@ include::topics/making-open-source-more-inclusive.adoc[]
1919
// About the {UserCLIBookName}
2020
include::topics/about-cli-guide.adoc[leveloffset=+2]
2121

22+
:FeatureName: .NET migration
23+
include::topics/developer-preview-feature.adoc[]
24+
25+
:FeatureName: Analyzing applications written in a language other than Java
26+
include::topics/developer-preview-feature.adoc[]
27+
2228
// About {ProductName}
2329
include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+2]
2430

@@ -34,11 +40,30 @@ include::topics/about-cli.adoc[leveloffset=+2]
3440
// Install the CLI
3541
include::topics/installing-cli-tool.adoc[leveloffset=+2]
3642

43+
// Install in disconnected environment
44+
include::topics/installing-mta-disconnected-environment.adoc[leveloffset=+2]
45+
3746
// CLI known issues
3847
include::topics/cli-tool-known-issues.adoc[leveloffset=+3]
3948

49+
[id="running-cli"]
50+
=== Running the CLI
51+
52+
You can run the {ProductFullName} {CLINameTitle} against one or more applications.
53+
54+
Before {ProductShortName} 7.1.0, if you wanted to run the {CLINameTitle} against multiple applications, you ran a series of `--analyze` commands, each against an application, and each generating a separate report. This option, which is still fully supported, is described in xref:mta-cli-run-single-app_cli-guide[Running the {ProductShortName} {CLINameTitle} against an application].
55+
56+
In {ProductShortName} 7.1.0 and later, you can run the {CLINameTitle} against multiple applications by using the `--bulk` option, to generate a single report. This option, which is presented as a Developer Preview, is described in xref:mta-cli-run-multiple-apps_cli-guide[Running the {ProductShortName} {CLINameTitle} against multiple applications and generating a single report (Developer Preview)].
57+
58+
[IMPORTANT]
59+
====
60+
include::snippets/developer-preview.adoc[]
61+
====
62+
4063
// Run the CLI
41-
include::topics/mta-cli-run.adoc[leveloffset=+2]
64+
include::topics/mta-cli-run-single-app.adoc[leveloffset=+3]
65+
66+
include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3]
4267

4368
// Analyze application source code
4469
include::topics/mta-cli-analyze.adoc[leveloffset=+3]
@@ -55,6 +80,15 @@ include::topics/available-openrewrite-recipes.adoc[leveloffset=+4]
5580
// Access the Report
5681
include::topics/access-report.adoc[leveloffset=+2]
5782

83+
// Multi-language application analysis
84+
include::topics/mta-cli-analyze-multi-lang-apps.adoc[leveloffset=+2]
85+
86+
// Multi-language application analysis for the supported provider
87+
include::topics/mta-cli-analyze-selected-provider.adoc[leveloffset=+3]
88+
89+
// Multi-language application analysis for the unsupported provider
90+
include::topics/mta-cli-analyze-unsupported-provider.adoc[leveloffset=+3]
91+
5892
// Review the Reports
5993
include::topics/mta-review-reports.adoc[leveloffset=+1]
6094

@@ -102,3 +136,6 @@ include::topics/important-links.adoc[leveloffset=+3]
102136
// * Appendix: Revision Information *
103137
// **********************************
104138
include::topics/templates/revision-info.adoc[]
139+
140+
141+

docs/topics/about-cli-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
[id="about-cli-guide_{context}"]
77
= About the {UserCLIBookName}
88

9-
This guide is for engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java applications or other components. It describes how to install and run the {CLIName}, review the generated reports, and take advantage of additional features.
9+
This guide is for engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java applications, .NET applications, or other components. In {ProductShortName} 7.1 and later, you can use {ProductShortName} to analyze applications written in languages other than Java. To run analysis on applications written in languages other than Java, add a custom rule set and do not specify a target language. This guide describes how to install and run the {CLIName}, review the generated reports, and take advantage of additional features.

docs/topics/con_automatic-tagging-of-an-application.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
[role="_abstract"]
1010

11-
{ProductShortName} can automatically add tags to the application based on the application analysis. Automatic tagging is especially useful when dealing with large portfolios of applications.
11+
{ProductShortName} automatically spawns language discovery and technology discovery tasks when adding an application to the *Application Inventory*. When the language discovery task is running, the technology discovery and analysis tasks wait until the language discovery task is finished. These tasks automatically add tags to the application. {ProductShortName} can automatically add tags to the application based on the application analysis. Automatic tagging is especially useful when dealing with large portfolios of applications.
1212

13-
Automatic tagging of applications is enabled by default. You can disable automatic tagging by deselecting the *Enable automated tagging* checkbox in the *Advanced* section of the *Analysis configuration* wizard.
13+
Automatic tagging of applications based on application analysis is enabled by default. You can disable automatic tagging during application analysis by deselecting the *Enable automated tagging* checkbox in the *Advanced* section of the *Analysis configuration* wizard.
1414

1515
NOTE: To tag an application automatically, make sure that the *Enable automated tagging* checkbox is selected _before_ you run an application analysis.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// DO NOT USE THIS SNIPPET. DEVELOPER PREVIEW FEATURES ARE NOT DOCUMENTED IN CORE OPENSHIFT DOCS.
2+
3+
// When including this file, ensure that {FeatureName} is set immediately before the include. Otherwise it will result in an incorrect replacement.
4+
5+
[IMPORTANT]
6+
====
7+
[subs="attributes+"]
8+
{FeatureName} is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
9+
====
10+
// Undefine {FeatureName} attribute, so that any mistakes are easily spotted
11+
:!FeatureName:
65.6 KB
Loading

docs/topics/installing-cli-tool.adoc

Lines changed: 140 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,17 @@
77
[id="installing-cli-tool_{context}"]
88
= Installing the {CLINameTitle}
99

10-
You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems.
11-
10+
You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems using the downloadable `.zip` file.
1211

1312
.Prerequisites
1413

15-
* Red Hat Container Registry Authentication for `registry.redhat.io`. Red Hat distributes container images from registry.redhat.io, which requires authentication. For more details, see link:https://access.redhat.com/RegistryAuthentication[Red Hat Container Registry Authentication].
16-
* Podman must be installed
17-
18-
+
19-
[NOTE]
20-
.Podman
21-
====
22-
Podman is a daemonless, open source, Linux-native tool designed to make it easy to find, run, build, share, and deploy applications using Open Containers Initiative (OCI) Containers and Container Images.
23-
Podman provides a command-line interface (CLI) familiar to anyone who has used the Docker Container Engine.
24-
For more information on installing and using Podman, see link:https://podman.io/docs/installation[Podman installation instructions].
25-
====
14+
* Red Hat Container Registry Authentication for `registry.redhat.io`. Red Hat distributes container images from `registry.redhat.io`, which requires authentication. For more details, see link:https://access.redhat.com/RegistryAuthentication[Red Hat Container Registry Authentication].
2615

2716
[id="installing-downloadable-cli-zip_{context}"]
2817
== Installing the {CLINameTitle} `.zip` file
2918

3019
.Procedure
3120

32-
To install using the downloadable `.zip` file:
33-
3421
. Navigate to the link:{DevDownloadPageURL}[{ProductShortName} Download page] and download the OS-specific CLI file or the `src` file:
3522
+
3623
* {ProductShortNameLower}-{ProductVersion}-cli-linux.zip
@@ -46,35 +33,164 @@ When you encounter `<{ProductShortName}_HOME>` in this guide, replace it with th
4633
[id="installing-using-podman_{context}"]
4734
== Installing the {CLINameTitle} using Podman
4835

36+
You can install the {CLINameTitle} using `podman pull`.
37+
4938
.Prerequisites
5039

51-
* Red Hat Container Registry Authentication for `registry.redhat.io`. Red Hat distributes container images from registry.redhat.io, which requires authentication. For more details, see link:https://access.redhat.com/RegistryAuthentication[Red Hat Container Registry Authentication].
40+
* Red Hat Container Registry Authentication for `registry.redhat.io`. Red Hat distributes container images from `registry.redhat.io`, which requires authentication. See link:https://access.redhat.com/RegistryAuthentication[Red Hat Container Registry Authentication] for additional details.
5241

42+
* Podman must be installed.
5343

54-
.Procedure
44+
[NOTE]
45+
.Podman
46+
====
47+
Podman is a daemonless, open source, Linux-native tool designed to make it easy to find, run, build, share, and deploy applications using Open Containers Initiative (OCI) Containers and Container Images.
48+
Podman provides a command-line interface (CLI) familiar to anyone who has used the Docker Container Engine.
49+
For more information on installing and using Podman, see link:https://podman.io/docs/installation[Podman installation instructions].
50+
====
5551

56-
To install using `podman pull`:
52+
.Procedure
5753

58-
. To use Podman to authenticate to registry.redhat.io:
54+
. Use Podman to authenticate to `registry.redhat.io` by running the following command:
55+
+
56+
[source,terminal]
57+
----
58+
$ podman login registry.redhat.io
59+
----
60+
+
61+
Enter the user name and password:
5962
+
6063
[source,terminal]
6164
----
62-
podman login registry.redhat.io
6365
Username: <username>
6466
Password: <***********>
6567
----
66-
. Issue:
68+
69+
. Copy the binary `PATH` to enable system-wide use by running the following command:
6770
+
6871
[source,terminal]
6972
----
70-
podman cp $(podman create registry.redhat.com/mta-toolkit/mta-mta-cli-rhel9:{ProductVersion}):/usr/local/bin/mta-cli ./
73+
$ podman cp $(podman create registry.redhat.com/mta-toolkit/mta-mta-cli-rhel9:{ProductVersion}):/usr/local/bin/mta-cli ./
7174
----
7275
+
73-
This command will copy the binary `PATH` for system-wide use.
74-
+
7576
[WARNING]
7677
====
7778
Although installation using Podman is possible, downloading and installing the `.zip` file is the preferred installation.
7879
====
7980

81+
[id="installing-using-docker_{context}"]
82+
== Installing the {CLINameTitle} for use with Docker on Windows (Developer Preview)
83+
84+
You can install the {CLINameTitle} for use with Docker on Windows. This is the required approach when migrating applications built with .NET framework 4.5 or later on Windows to cross-platform .NET 8.0.
85+
86+
.Prerequisites
87+
88+
* A host with Windows 11+ 64-bit version 21H2 or higher.
89+
90+
* You have download the Docker Desktop for Windows installer. See link:https://docs.docker.com/desktop/install/windows-install/[Install Docker Desktop on Windows] for additional details.
91+
92+
.Procedure
93+
94+
. Open a PowerShell with Administrator privileges.
95+
96+
. Ensure Hyper-V is installed and enabled:
97+
+
98+
[source,powershell]
99+
----
100+
PS C:\Users\<your_user_name>> Enable-WindowsOptionalFeature -Online `
101+
-FeatureName Microsoft-Hyper-V-All
102+
----
103+
+
104+
[source,powershell]
105+
----
106+
PS C:\Users\<your_user_name>> Enable-WindowsOptionalFeature -Online `
107+
-FeatureName Containers
108+
----
109+
+
110+
[NOTE]
111+
====
112+
You may need to reboot Windows.
113+
====
114+
115+
. Install Docker Desktop on Windows.
116+
117+
.. Double-click `Docker_Desktop_Installer.exe` to run the installer. By default, Docker Desktop is installed at `C:\Program Files\Docker\Docker`.
118+
119+
.. Deselect the *Use WSL 2 instead of Hyper-V* option on the Configuration page to ensure that Docker will run Windows containers as the backend instead of Linux containers.
80120

121+
. In PowerShell, create a folder for {ProductShortName}:
122+
+
123+
[source,powershell]
124+
----
125+
PS C:\Users\<your_user_name>> mkdir C:\Users\<your_user_name>\MTA
126+
----
127+
+
128+
Replace `<your_user_name>` with the username for your home directory.
129+
130+
. Extract the `{ProductShortNameLower}-{ProductVersion}-cli-windows.zip` file to the `MTA` folder:
131+
+
132+
[source,powershell]
133+
----
134+
PS C:\Users\<your_user_name>> cd C:\Users\<your_user_name>\Downloads
135+
----
136+
+
137+
Replace `<your_user_name>` with the username for your home directory.
138+
+
139+
[source,powershell]
140+
----
141+
PS C:\Users\<your_user_name>> Expand-Archive `
142+
-Path "{ProductShortNameLower}-{ProductVersion}-cli-windows.zip" `
143+
-DestinationPath "C:\Users\<your_user_name>\MTA"
144+
----
145+
+
146+
Replace `<your_user_name>` with the username for your home directory.
147+
148+
. Ensure Docker is running Windows containers:
149+
+
150+
[source,powershell]
151+
----
152+
PS C:\Users\<your_user_name>> docker version
153+
----
154+
+
155+
[source,powershell]
156+
----
157+
Client:
158+
Version: 27.0.3
159+
API version: 1.46
160+
Go version: go1.21.11
161+
Git commit: 7d4bcd8
162+
Built: Sat Jun 29 00:03:32 2024
163+
OS/Arch: windows/amd64 <1>
164+
Context: desktop-windows
165+
Server: Docker Desktop 4.32.0 (157355)
166+
Engine:
167+
Version: 27.0.3
168+
API version: 1.46 (minimum version 1.24)
169+
Go version: go1.21.11
170+
Git commit: 662f78c
171+
Built: Sat Jun 29 00:02:13 2024
172+
OS/Arch: windows/amd64 <1>
173+
Experimental: false
174+
----
175+
<1> Ensure the `OS/Arch` setting is `windows/amd64`.
176+
177+
. Set the `PODMAN_BIN` environment variable to use Docker:
178+
+
179+
[source,powershell]
180+
----
181+
PS C:\Users\<your_user_name>> $env:PODMAN_BIN="C:\Windows\system32\docker.exe"
182+
----
183+
184+
. Set the `DOTNET_PROVIDER_IMG` environment variable to use the upstream `dotnet-external-provider`:
185+
+
186+
[source,powershell]
187+
----
188+
PS C:\Users\<your_user_name>> $env:DOTNET_PROVIDER_IMG="quay.io/konveyor/dotnet-external-provider:v0.5.0"
189+
----
190+
191+
. Set the `RUNNER_IMG` environment variable to use the upstream image:
192+
+
193+
[source,powershell]
194+
----
195+
PS C:\Users\<your_user_name>> $env:RUNNER_IMG="quay.io/konveyor/kantra:v0.5.0"
196+
----

0 commit comments

Comments
 (0)