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

MTA-4628: Adding a link to podman configuration and setting #89

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

MTA-4628: Adding a link to podman configuration and setting #89

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b909bad
MTA-4628: Adding a link to podman configuration and setting
anarnold97 Feb 10, 2025
acffbb5
Update docs/topics/installing-cli-tool.adoc
anarnold97 Feb 10, 2025
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
12 changes: 10 additions & 2 deletions docs/topics/installing-cli-tool.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems

[IMPORTANT]
====
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.

The containerless mode is set by default and is used automatically if all requirements are met. For more information, see xref:running-the-containerless-mta-cli_cli-guide[Running the containerless CLI].

Expand Down Expand Up @@ -87,6 +87,14 @@ $ podman cp $(podman create registry.redhat.com/mta-toolkit/mta-mta-cli-rhel9:{P
Although installation using Podman is possible, downloading and installing the `.zip` file is the preferred installation.
====

[NOTE]
.Podman configuration
====
Podman setup and configuration consists of numerous variables that are not within the scope of this documentation. For further details on Podman, see link:https://podman.io/docs#familiarizing-yourself-with-podman[Familiarizing yourself with Podman].
anarnold97 marked this conversation as resolved.
Show resolved Hide resolved

For details on troubelshooting Podman, see link:https://github.com/containers/podman/blob/main/troubleshooting.md[A list of common issues and solutions for Podman].
Comment on lines +91 to +95
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 && @istein1 && @dymurray

I do not think we should document the steps to resolve this issue. I have added a link to the Podman docs and the troublehsooting.md that the referenced solution doc links to :

image

However, I could also add a Known Issue - and add a direct link to the solution i.e. Can't use volume mount, get permission denied

WDYT?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

For the second part of a Known Issue, please see - #90

====

[id="installing-using-docker_{context}"]
== Installing the {CLINameTitle} for use with Docker on Windows (Developer Preview)

Expand Down Expand Up @@ -121,7 +129,7 @@ PS C:\Users\<your_user_name>> Enable-WindowsOptionalFeature -Online `
You may need to reboot Windows.
====

. Install Docker Desktop on Windows.
. Install Docker Desktop on Windows.

.. Double-click `Docker_Desktop_Installer.exe` to run the installer. By default, Docker Desktop is installed at `C:\Program Files\Docker\Docker`.

Expand Down