[WIP] Containerless CLI procedure for 7.2.0 #71
Conversation
mpershina
requested review from
rromannissen,
dymurray,
istein1,
eemcmullan and
ibragins
Applied feedback
| $ mv <mta_cli_zip>/<os>-kantra /usr/bin | ||
| ---- | ||
|
|
||
| . Move the requirements to the `.kantra` directory: |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@eemcmullan Just to clarify if I get it right: What do you mean by the "current directory", please?
| $ mv $HOME/kantra.<os>.<arch> $HOME/.kantra | ||
| ---- | ||
|
|
||
| . Open a terminal and navigate to the directory where you installed the {ProductShortName} CLI. |
There was a problem hiding this comment.
If the reqs are at $HOME/.kantra, the user will not need to navigate elsewhere.
There was a problem hiding this comment.
Ack, will attempt to rewrite it to include this info.
| + | ||
| [source,terminal,subs="attributes+"] | ||
| ---- | ||
| $ mta-cli analyze --overwrite --input <path_to_input> --output <path_to_output> --target <target_source> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
| * 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. |
There was a problem hiding this comment.
| * 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!
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
@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
@ibragins It's just because I want to first work on the text draft in the google doc I shared and then move everything here, if you mean having some "default containerless cli" info in parts of the doc other than this exact procedure. The procedure in this PR already has putting requirements into $HOME/.kanta as a procedure step, not even a prereq, to make the user perform this action anyway. |
Tracked under MTA-3708 and also worked on in the gdoc draft.
Current preview