Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Containerless CLI procedure for 7.2.0 #71

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[WIP] Containerless CLI procedure for 7.2.0 #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec0d75c
Containerless CLI procedure draft
mpershina Nov 15, 2024
35923eb
Apply suggestions from code review
mpershina Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/cli-guide/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
54 changes: 54 additions & 0 deletions docs/topics/proc_running-the-containerless-mta-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
:_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 the `python3` package installed on your system.
* You have the `JAVA_HOME` environmental variable set.
Copy link
Collaborator Author

@mpershina mpershina Nov 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* You have the `JAVA_HOME` environmental variable set.
* You have the `JAVA_HOME` environmental variable set.
* Optional: You defined the `JVM_MAX_MEM` system variable.
+
NOTE: Defining ` JVM_MAX_MEM` is recommended. If you do not have this variable set, the analysis might hang.

Hi @ibragins, please check this suggestion ^ Based on what I can see in the ticket, this prereq is not mandatory. So shall we have it as optional and just add a not that it is recommended? Or shall I make it just a usuall mandatory prereq? Thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mpershina it depends on the way how Java was installed. If it was installed using installer or package manager - it will work without setting JAVA_HOME, but if user will just unpack a tarball - system should be informed somehow where is java binary. In this case this var should be defined manually.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ibragins, I'm just a little bit confused. Are we speaking about only setting the JAVA_HOME var? Or are you talking about both JAVA_HOME and JVM_MAX_MEM? Sorry, I just need to clarify this for myslef to produce some great text, haha :-D


.Procedure

. Move the installed {ProductShortName} CLI `.zip` file to your `$PATH`:
+
[source,terminal,subs="attributes+"]
----
$ mv <mta_cli_zip>/<os>-kantra /usr/bin
----

. Move the requirements to the `.kantra` directory:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be good to note here that the CLI will look in the current dir for these requirements. If not found there, it will fall back to the $HOME/.kantra location.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eemcmullan Just to clarify if I get it right: What do you mean by the "current directory", please?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eemcmullan ^

+
[source,terminal,subs="attributes+"]
----
$ mv $HOME/kantra.<os>.<arch> $HOME/.kantra
----

. Open a terminal and navigate to the directory where you installed the {ProductShortName} CLI.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the reqs are at $HOME/.kantra, the user will not need to navigate elsewhere.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack, will attempt to rewrite it to include this info.


. Run the application analysis:
+
[source,terminal,subs="attributes+"]
----
$ mta-cli analyze --overwrite --input <path_to_input> --output <path_to_output> --target <target_source>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should there be further options explained here? i.e. this will run the default rulesets previously installed, which can be disabled. Custom rules can also be specified. I'm not sure if there are details on this in another doc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no details about it in any other part of the doc, I think. But I also don't think we should actually add steps for custom rules here. I'd maybe suggest to have a separate small procedure for running CLI with custom rules, and mention in this exact step that this is for default rulesets. WDYT?

----
+
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]