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.

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

MTA-4662: Update containerless CLI docs #94

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

Conversation

anarnold97
Copy link
Collaborator

@anarnold97 anarnold97 commented Feb 18, 2025

@anarnold97 anarnold97 force-pushed the MTA-4662-Update-containerless-CLI-docs branch from e45c496 to 0f62ccb Compare February 19, 2025 13:47
----

. Move the requirements to the `.kantra` directory:
+
[source,terminal,subs="attributes+"]
----
$ mv $HOME/kantra.<os>.<arch> $HOME/.kantra
$ mv $HOME/mta-cli.<os>.<arch> $HOME/.kantra
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a move command, while there is a zip file that should be unzipped into $HOME/.kanra. Am I missing something?

Choose a reason for hiding this comment

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

Might be better to instead say something along the lines of "move the contents of the cli zip into $HOME/.kantra. Like above, can use this command as an example only.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated, thanks

Copy link
Collaborator

Choose a reason for hiding this comment

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

as I wrote, if it is zip - you can't MOVE its content. You should run unzip command, so this is not a valid example. Regarding the statement before the command - LGTM.
@anarnold97 please update command with something like
unzip $HOME/mta-cli.<os>.<arch>.zip -d $HOME/.kantra

Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM as far as I can tell.
I'll defer to @ibragins for a final review and validate all the commands.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

thanks @ilanit

just wondering if we should cover the Windows procedure and macOS procedure

Thanks

@anarnold97
Copy link
Collaborator Author

@eemcmullan && @ibragins - updated, please can you re-review

Thanks

----

. Move the requirements to the `.kantra` directory:
+
[source,terminal,subs="attributes+"]
----
$ mv $HOME/kantra.<os>.<arch> $HOME/.kantra
$ mv $HOME/mta-cli.<os>.<arch> $HOME/.kantra
Copy link
Collaborator

Choose a reason for hiding this comment

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

as I wrote, if it is zip - you can't MOVE its content. You should run unzip command, so this is not a valid example. Regarding the statement before the command - LGTM.
@anarnold97 please update command with something like
unzip $HOME/mta-cli.<os>.<arch>.zip -d $HOME/.kantra

@anarnold97
Copy link
Collaborator Author

@ibragins - updated, please review

@@ -31,17 +31,23 @@ NOTE: If you do not set `JVM_MAX_MEM`, the analysis might hang.
.Procedure

. Move the installed {ProductShortName} CLI `.zip` file to your `$PATH`:
.. For example, using `sudo`:
Copy link
Collaborator

@istein1 istein1 Feb 27, 2025

Choose a reason for hiding this comment

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

I suggest instead writing
.. For example, to /usr/bin, using sudo

Copy link
Collaborator

Choose a reason for hiding this comment

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

No need to move zip file to /usr/bin @anarnold97
After unpacking the whole zip file to ~/.kantra, user can either add that path to $PATH variable or move mta-cli binary to /usr/bin, both will work. Important: adding path doesn't require root privileges.
Also, this will work on Linux ONLY. Place to copy binary on Windows is different.

Copy link
Collaborator

@ibragins ibragins Feb 27, 2025

Choose a reason for hiding this comment

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

so, for Linux:

  1. Unzip dependency zip to home folder / .kantra
    unzip $HOME/mta-cli.<os>.<arch>.zip -d $HOME/.kantra

  2. Take one of 2 steps:

  • Put product binary to /usr/bin
    sudo mv ~/.kantra/mta-cli /usr/bin/

OR

  • Add ~/.kantra path to $PATH variable
    export PATH=$HOME/.kantra:$PATH
    Advantage of second option is that it doesn't require root permissions

+
[source,terminal,subs="attributes+"]
----
$ mv $HOME/kantra.<os>.<arch> $HOME/.kantra
$HOME/mta-cli.<os>.<arch>.zip -d $HOME/.kantra
Copy link
Collaborator

Choose a reason for hiding this comment

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

unzip $HOME/mta-cli.<os>.<arch>.zip -d $HOME/.kantra

Signed-off-by: A.Arnold <[email protected]>
@anarnold97
Copy link
Collaborator Author

@istein1 & @ibragins - updated - think this is correct

@anarnold97
Copy link
Collaborator Author

@istein1 & @ibragins - please can i give you another nudge to review


. Move the installed {ProductShortName} CLI `.zip` file to your `$PATH`:
After unpacking the whole zip file to `~/.kantra`, either add that path to the `$PATH` variable or move the `mta-cli` binary to `/usr/bin`.

Choose a reason for hiding this comment

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

I think we should only mention moving the binary to the PATH, and remove the part about moving it to /usr/bin. That path was only used as an example, and does not hold any significance.

+
[source,terminal,subs="attributes+"]
----
$ mv <mta_cli_zip>/<os>-kantra /usr/bin
unzip $HOME/mta-cli.<os>.<arch>.zip -d $HOME/.kantra

Choose a reason for hiding this comment

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

I will need to check whether or not this command works on windows.


. Move the installed {ProductShortName} CLI `.zip` file to your `$PATH`:
After unpacking the whole zip file to `~/.kantra`, either add that path to the `$PATH` variable or move the `mta-cli` binary to `/usr/bin`.
Copy link
Collaborator Author

@anarnold97 anarnold97 Mar 5, 2025

Choose a reason for hiding this comment

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

Suggested change
After unpacking the whole zip file to `~/.kantra`, either add that path to the `$PATH` variable or move the `mta-cli` binary to `/usr/bin`.
After unpacking the whole zip file to `~/.kantra`, add that path to the `$PATH` variable.

To implement Emily's comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants