Skip to content

Commit 880e48e

Browse files
authored
Merge pull request #94 from anarnold97/MTA-4662-Update-containerless-CLI-docs
MTA-4662: Update containerless CLI docs
2 parents 00b6b5b + 68b2f19 commit 880e48e

File tree

2 files changed

+32
-13
lines changed

2 files changed

+32
-13
lines changed

docs/topics/installing-cli-tool.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems
1111

1212
[IMPORTANT]
1313
====
14+
1415
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.
1516
1617
The containerless mode is set by default and is used automatically if all requirements are met. For more information, see xref:running-the-containerless-mta-cli_cli-guide[Running the containerless CLI].
@@ -231,17 +232,16 @@ Server: Docker Desktop 4.32.0 (157355)
231232
----
232233
PS C:\Users\<your_user_name>> $env:PODMAN_BIN="C:\Windows\system32\docker.exe"
233234
----
234-
235235
. Set the `DOTNET_PROVIDER_IMG` environment variable to use the upstream `dotnet-external-provider`:
236236
+
237237
[source,powershell]
238238
----
239-
PS C:\Users\<your_user_name>> $env:DOTNET_PROVIDER_IMG="quay.io/konveyor/dotnet-external-provider:v0.5.0"
239+
PS C:\Users\<your_user_name>> $env:DOTNET_PROVIDER_IMG="registry.redhat.io/mta/mta-dotnet-external-provider-rhel9:7.1.0"
240240
----
241-
242241
. Set the `RUNNER_IMG` environment variable to use the upstream image:
243242
+
244243
[source,powershell]
245244
----
246-
PS C:\Users\<your_user_name>> $env:RUNNER_IMG="quay.io/konveyor/kantra:v0.5.0"
245+
# double-check reference
246+
PS C:\Users\<your_user_name>> $env:RUNNER_IMG="registry.redhat.io/mta/mta-cli-rhel9:7.1.0"
247247
----

docs/topics/proc_running-the-containerless-mta-cli.adoc

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,46 @@ In {ProductShortName} 7.2.0 and later, containerless CLI is a default mode. To e
2626
* You have the `JAVA_HOME` environmental variable set.
2727
* You have the `JVM_MAX_MEM` system variable set.
2828
+
29-
NOTE: If you do not set `JVM_MAX_MEM`, the analysis might hang.
29+
[NOTE]
30+
====
31+
If you do not set `JVM_MAX_MEM`, the analysis might hang.
32+
====
33+
34+
.Procedure for Linux
35+
36+
After unpacking the whole zip file to `~/.kantra`, add that path to the `$PATH` variable.
3037

31-
.Procedure
38+
[NOTE]
39+
====
40+
Moving the `mta-cli` binary to `/usr/bin` requires root privileges, whereas adding that path to `$PATH` variable does not require root privileges.
41+
====
3242

33-
. Move the installed {ProductShortName} CLI `.zip` file to your `$PATH`:
43+
. To extract the dependency zip file to `~/.kantra`, run:
3444
+
3545
[source,terminal,subs="attributes+"]
3646
----
37-
$ mv <mta_cli_zip>/<os>-kantra /usr/bin
47+
unzip $HOME/mta-cli.<os>.<arch>.zip -d $HOME/.kantra
3848
----
39-
40-
. Move the requirements to the `.kantra` directory:
49+
. Add as a system-wide binary or add to the global `$PATH` variable:
50+
.. For example, to add the `mta-cli` binary to `/usr/bin` as a system-wide binary, using `sudo`, run:
4151
+
4252
[source,terminal,subs="attributes+"]
4353
----
44-
$ mv $HOME/kantra.<os>.<arch> $HOME/.kantra
54+
sudo mv ~/.kantra/mta-cli /usr/bin/
4555
----
56+
57+
.. For example, to add to the global `$PATH` variable, run:
4658
+
47-
NOTE: The CLI can run with the requirements moved to the directory from which you run an analysis. During the analysis, the CLI checks for the requirements in this directory first, and if it does not find the requirements, it searches for them in the `$HOME/.kantra` directory.
59+
[source,terminal,subs="attributes+"]
60+
----
61+
export PATH=$HOME/.kantra:$PATH
62+
----
4863

64+
+
65+
[NOTE]
66+
====
67+
The CLI can run with the requirements moved to the directory from which you run an analysis. During the analysis, the CLI checks for the requirements in this directory first, and if it does not find the requirements, it searches for them in the `$HOME/.kantra` directory.
68+
====
4969

5070
. Optional: Display all `mta-cli analyze` command options:
5171
+
@@ -73,4 +93,3 @@ The command arguments represent the following:
7393
.Additional resources
7494

7595
* xref:installing-downloadable-cli-zip_cli-guide[Installing the CLI .zip file]
76-

0 commit comments

Comments
 (0)