From ec0d75c77bb810ff524e13649a239ccdbcaf1a29 Mon Sep 17 00:00:00 2001 From: Mariya Pershina Date: Fri, 15 Nov 2024 15:58:59 +0100 Subject: [PATCH 1/2] Containerless CLI procedure draft --- docs/cli-guide/master.adoc | 2 + ...roc_running-the-containerless-mta-cli.adoc | 62 +++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 docs/topics/proc_running-the-containerless-mta-cli.adoc diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 65d19b83..4767d14f 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -63,6 +63,8 @@ include::topics/mta-cli-run-single-app.adoc[leveloffset=+3] include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3] +include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3] + // Analyze application source code include::topics/mta-cli-analyze.adoc[leveloffset=+3] diff --git a/docs/topics/proc_running-the-containerless-mta-cli.adoc b/docs/topics/proc_running-the-containerless-mta-cli.adoc new file mode 100644 index 00000000..a2edfca8 --- /dev/null +++ b/docs/topics/proc_running-the-containerless-mta-cli.adoc @@ -0,0 +1,62 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-11-15 +:_mod-docs-content-type: PROCEDURE + +[id="running-the-containerless-mta-cli_{context}"] += Running the containerless CLI + +You can perform an application analysis for Java applications by using the {ProductShortName} CLI that does not require installation of a container runtime. + +.Prerequisites + +* You have OpenJDK version 17 or later installed on your system. +* You have Maven installed on your system. +* You have Gradle installed on your system. +* The `RUN_LOCAL` environmental variable is set to `true`: ++ +---- +RUN_LOCAL=true +---- ++ +Note that if you do not set this variable to `true`, the analysis will run inside a container. ++ +IMPORTANT: The analysis for languages other than Java is not affected by the RUN_LOCAL variable. + +.Procedure + +. Move the installed {ProductShortName} CLI `.zip` file to your `$PATH`: ++ +[source,terminal,subs="attributes+"] +---- +$ mv /-kantra /usr/bin +---- + +. Move the requirements to the `.kantra` directory: ++ +[source,terminal,subs="attributes+"] +---- +$ mv $HOME/kantra.. $HOME/.kantra +---- + +. Open a terminal and navigate to the directory where you installed the {ProductShortName} CLI. + +. Run the application analysis: ++ +[source,terminal,subs="attributes+"] +---- +$ mta-cli analyze-bin --overwrite --input --output --target +---- ++ +The command arguments represent the following: + +** `--overwrite`: Overwrites the output folder if it exists. +** `--input`: The application to be analyzed. +** `--output`: The output directory for the generated reports. +** `--target`: The target technology for the application migration, for example, `eap8`. + + +[role="_additional-resources"] +.Additional resources + +* xref:installing-downloadable-cli-zip_cli-guide[Installing the CLI .zip file] + From 35923ebc749f6c8c2f9934d686ac7e193c97c288 Mon Sep 17 00:00:00 2001 From: Mariya Pershina <53339200+mpershina@users.noreply.github.com> Date: Wed, 20 Nov 2024 15:24:39 +0100 Subject: [PATCH 2/2] Apply suggestions from code review Applied feedback --- .../proc_running-the-containerless-mta-cli.adoc | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/docs/topics/proc_running-the-containerless-mta-cli.adoc b/docs/topics/proc_running-the-containerless-mta-cli.adoc index a2edfca8..220ead39 100644 --- a/docs/topics/proc_running-the-containerless-mta-cli.adoc +++ b/docs/topics/proc_running-the-containerless-mta-cli.adoc @@ -11,16 +11,8 @@ You can perform an application analysis for Java applications by using the {Prod * You have OpenJDK version 17 or later installed on your system. * You have Maven installed on your system. -* You have Gradle installed on your system. -* The `RUN_LOCAL` environmental variable is set to `true`: -+ ----- -RUN_LOCAL=true ----- -+ -Note that if you do not set this variable to `true`, the analysis will run inside a container. -+ -IMPORTANT: The analysis for languages other than Java is not affected by the RUN_LOCAL variable. +* You have the `python3` package installed on your system. +* You have the `JAVA_HOME` environmental variable set. .Procedure @@ -44,7 +36,7 @@ $ mv $HOME/kantra.. $HOME/.kantra + [source,terminal,subs="attributes+"] ---- -$ mta-cli analyze-bin --overwrite --input --output --target +$ mta-cli analyze --overwrite --input --output --target ---- + The command arguments represent the following: