-
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
Open
HagayVider1
wants to merge
56
commits into
windup:main
Choose a base branch
from
HagayVider1:mta-2744_rework-mta-cli-section
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 21 commits
Commits
Show all changes
56 commits
Select commit
Hold shift + click to select a range
016bdd6
Updated .gitignore file
HagayVider1 7a5011b
Text edits in MTA CLI guide
HagayVider1 94897b6
Updated install CLI section
HagayVider1 54a0ec2
Updated install CLI procedure and link to Run CLI procedure
HagayVider1 3815164
Fixed spelling
HagayVider1 8722f49
Update according to comment
HagayVider1 4106033
Update according to Adndy's comments
HagayVider1 ad4158d
Update updated according to comment
HagayVider1 a9adfb0
Replaced link with xref
HagayVider1 1b2901f
Merge branch 'main' into mta-2744_rework-mta-cli-section
HagayVider1 37f5272
Changed xref
HagayVider1 5dae139
Changed xref
HagayVider1 74433e1
Updated xref command
HagayVider1 555a837
Added Windows EXE option
HagayVider1 b27fa85
Updated migration paths table - to revert
HagayVider1 9d67697
Updated About CLI
HagayVider1 aed8816
Updated CLI installation procedure
HagayVider1 0e6ef1e
Updated What is MTA
HagayVider1 ed6cf04
Updated Username and Password step
HagayVider1 56a8f60
Update docs/topics/installing-cli-tool.adoc
HagayVider1 da19c36
Update docs/topics/installing-cli-tool.adoc
HagayVider1 896b888
Moved sections within CLI guide
HagayVider1 e90fd7d
Updated about MTA according to Andy's comments
HagayVider1 35307af
Updated about CLI section
HagayVider1 30ba650
Corrected Podman name
HagayVider1 ad8a8d9
Updated About CLI section
HagayVider1 e57201e
Updated file download section
HagayVider1 a28e029
Corrected capitalization
HagayVider1 1474e60
Added darwin-mta-cli filename for macOS
HagayVider1 bb03d4e
Rewriting Running MTA CLI section
HagayVider1 1504f44
Updated file names in installation
HagayVider1 1011b1f
Corrected typos
HagayVider1 5e6d4b9
Updated installation procedure
HagayVider1 c2d899e
Merge branch 'main' into mta-2744_rework-mta-cli-section
HagayVider1 b86383b
Corrected after linting
HagayVider1 78c393b
Updated Running the CLI section
HagayVider1 728e9b8
Renamed Accessing reports to Reports and moved to head or Reports cha…
HagayVider1 222c1f3
Updated the Reports chapter start
HagayVider1 47a99ce
Corrected spacing
HagayVider1 85a35bf
Updated open report procedure
HagayVider1 b84f8d0
Updated outline for Reports chapter
HagayVider1 0765fe5
Updated What is the MTA
HagayVider1 bfe9536
Updated after linting
HagayVider1 b825cac
Corrected What is MTA section
HagayVider1 176ec50
Updated bulleted list
HagayVider1 7e09487
Added backticks where necessary
HagayVider1 142dbdf
Corrected table
HagayVider1 e6dbf74
Corrected table
HagayVider1 a212ed2
Corrected Running the CLI header
HagayVider1 5d740d7
Corrected document hierarchy
HagayVider1 97ad2ea
Corrected back-tick
HagayVider1 8af6fd0
Corrected third-party
HagayVider1 a850e14
Replaced image with MTA 7
HagayVider1 760771b
Removed Shared archives - added Dependencies
HagayVider1 7bbe1a8
Replaced Dashboard image
HagayVider1 5910a92
// Add query for Dashboard image
HagayVider1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
==== | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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