-
Notifications
You must be signed in to change notification settings - Fork 31
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-2744 - Rework MTA CLI section #880
base: main
Are you sure you want to change the base?
Changes from 23 commits
016bdd6
7a5011b
94897b6
54a0ec2
3815164
8722f49
4106033
ad4158d
a9adfb0
1b2901f
37f5272
5dae139
74433e1
555a837
b27fa85
9d67697
aed8816
0e6ef1e
ed6cf04
56a8f60
da19c36
896b888
e90fd7d
35307af
30ba650
ad8a8d9
e57201e
a28e029
1474e60
bb03d4e
1504f44
1011b1f
5e6d4b9
c2d899e
b86383b
78c393b
728e9b8
222c1f3
47a99ce
85a35bf
b84f8d0
0765fe5
bfe9536
b825cac
176ec50
7e09487
142dbdf
e6dbf74
a212ed2
5d740d7
97ad2ea
8af6fd0
a850e14
760771b
7bbe1a8
5910a92
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -4,4 +4,9 @@ html/ | |||||
*/build/* | ||||||
Gemfile.lock | ||||||
*/master.html | ||||||
.idea/ | ||||||
.idea/ | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
.gitignore | ||||||
.DS_Store | ||||||
assets/.DS_Store | ||||||
docs/.DS_Store | ||||||
docs/topics/.DS_Store |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,29 +16,26 @@ include::topics/making-open-source-more-inclusive.adoc[] | |
|
||
== Introduction | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Reorganized sections in guide:
|
||
// About the {UserCLIBookName} | ||
include::topics/about-cli-guide.adoc[leveloffset=+2] | ||
|
||
// About {ProductName} | ||
include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+2] | ||
|
||
// About the {CLINameTitle} | ||
include::topics/about-cli.adoc[leveloffset=+2] | ||
|
||
// About the {UserCLIBookName} | ||
include::topics/about-cli-guide.adoc[leveloffset=+2] | ||
|
||
// Supported migration paths | ||
include::topics/migration-paths.adoc[leveloffset=+3] | ||
|
||
For more information about use cases and migration paths, see the link:https://developers.redhat.com/products/mta/use-cases[{ProductShortName} for developers] web page. | ||
|
||
// About the {CLINameTitle} | ||
include::topics/about-cli.adoc[leveloffset=+2] | ||
|
||
== Installing and Running the CLI | ||
|
||
// Install the CLI | ||
include::topics/installing-cli-tool.adoc[leveloffset=+2] | ||
|
||
// CLI known issues | ||
include::topics/cli-tool-known-issues.adoc[leveloffset=+3] | ||
include::topics/installing-cli-tool.adoc[leveloffset=+1] | ||
|
||
// Run the CLI | ||
include::topics/mta-cli-run.adoc[leveloffset=+2] | ||
include::topics/mta-cli-run.adoc[leveloffset=+1] | ||
|
||
// Analyze application source code | ||
include::topics/mta-cli-analyze.adoc[leveloffset=+3] | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,8 +7,7 @@ | |
[id="installing-cli-tool_{context}"] | ||
= Installing the {CLINameTitle} | ||
|
||
You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems. | ||
|
||
You can install the {ProductShortName} {CLINameTitle} on Linux, Windows, or macOS operating systems. | ||
|
||
.Prerequisites | ||
|
||
|
@@ -24,24 +23,51 @@ Podman provides a command line interface (CLI) familiar to anyone who has used t | |
For more information on installing and using Podman, see link:https://podman.io/docs/installation[Podman installation instructions]. | ||
==== | ||
|
||
Installation options | ||
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. New step on Installation options |
||
This section offers two options to install {ProductShortName} {CLINameTitle}: | ||
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* Downloading a `.zip` file and installing it using a command line | ||
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* Running PodMan on your computer and installing using PodMan commands | ||
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
+ | ||
[WARNING] | ||
==== | ||
Although installation using Podman is possible, downloading and installing the `.zip` file is the preferred installation. | ||
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
==== | ||
|
||
|
||
[id="installing-downloadable-cli-zip_{context}"] | ||
== Installing the {CLINameTitle} `.zip` file | ||
|
||
.Procedure | ||
|
||
To install using the downloadable `.zip` file: | ||
|
||
. Navigate to the link:{DevDownloadPageURL}[{ProductShortName} Download page] and download the OS specific CLI file or the `src` file: | ||
. Navigate to the link:https://developers.redhat.com/products/mta/download[{ProductShortName} Download page] and download the OS specific CLI file or the `mta-{ProductVersion}-cli-src` file: | ||
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
+ | ||
* {ProductShortNameLower}-{ProductVersion}-cli-linux.zip | ||
* {ProductShortNameLower}-{ProductVersion}-cli-macos.zip | ||
* {ProductShortNameLower}-{ProductVersion}-cli-windows.zip | ||
* {ProductShortNameLower}-{ProductVersion}-cli-src.zip | ||
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for Linux x86_64 | ||
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for Linux aarch64 | ||
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for macOS x86_64 | ||
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for macOS aarch64 | ||
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for Windows x86_64 | ||
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for Windows aarch64 | ||
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for {ProductShortName} source Code | ||
|
||
+ | ||
[NOTE] | ||
==== | ||
Do not download and install the {ProductShortName} source Code file if your computer runs one of the above operating systems. | ||
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
==== | ||
|
||
. Extract the `.zip` file to a directory of your choice. The `.zip` file extracts a single binary, called *mta-cli*. | ||
+ | ||
When you encounter `<{ProductShortName}_HOME>` in this guide, replace it with the actual path to your {ProductShortName} installation. | ||
|
||
. Copy or save the `mta-cli` binary, or `mta-cli.exe` in Windows, to a known directory. | ||
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
+ | ||
Continue to xref:cli-run_cli-guide[Running the CLI] to run the CLI command. | ||
|
||
|
||
[id="installing-using-podman_{context}"] | ||
== Installing the {CLINameTitle} using Podman | ||
|
@@ -60,21 +86,25 @@ To install using `podman pull`: | |
[source,terminal] | ||
---- | ||
podman login registry.redhat.io | ||
---- | ||
|
||
. Enter your `Username` and `Password`. | ||
+ | ||
[source,terminal] | ||
---- | ||
Username: <username> | ||
Password: <***********> | ||
---- | ||
. Issue: | ||
+ | ||
If your `Usernam` and `Password` are correct, the terminal line should show `Login Succeeded!`. | ||
HagayVider1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
. Copy the binary `PATH` for system-wide use. | ||
+ | ||
[source,terminal] | ||
---- | ||
podman cp $(podman create registry.redhat.com/mta-toolkit/mta-mta-cli-rhel9:{ProductVersion}):/usr/local/bin/mta-cli ./ | ||
---- | ||
+ | ||
This command will copy the binary `PATH` for system-wide use. | ||
+ | ||
[WARNING] | ||
==== | ||
Although installation using Podman is possible, downloading installing the `.zip` file is the preferred installation. | ||
==== | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why have you changed the .gitignore file?
You should be using your global .gitignore file which we set up in our last git training session.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You have closed this comment and failed to correct your mistake