From fb09fceb2151efddda9cc6c3cd1f84bcd00932cc Mon Sep 17 00:00:00 2001 From: Dylan Murray Date: Mon, 10 Jun 2024 10:25:22 -0400 Subject: [PATCH 1/2] :sparkles: Remove docs to download kantra from container image Signed-off-by: Dylan Murray --- README.md | 49 +++++-------------------------------------------- 1 file changed, 5 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index e7898e68..6fbac2b4 100644 --- a/README.md +++ b/README.md @@ -30,54 +30,15 @@ export PODMAN_BIN=/usr/bin/docker To install kantra, download the executable for your platform and add it to the path. -### Downloading stable release +### Downloading a stable release -Go to the [release page](https://github.com/konveyor/kantra/releases) and download the zip file containing a binary for your platform and architecture. Unzip the archive and add the executable in it to the path. - -### Downloading the latest / particular version - -The easiest way to get the latest (or a particular/older) executable is to get it from the respective container image. - -Set the shell variable `kantra_version` to a particular version if you want to grab that version, -e.g., `kantra_version=v0.4.0`. - -#### Linux - -Run: - -```sh -${PODMAN_BIN:-podman} cp $(${PODMAN_BIN:-podman} create --name kantra-download quay.io/konveyor/kantra:${kantra_version:-latest}):/usr/local/bin/kantra . && ${PODMAN_BIN:-podman} rm kantra-download -``` - -#### Mac - -When you ar not using Docker for Desktop on your Mac (see above), -you need to start a podman machine prior to running any podman commands (see [Setup for Mac](#mac-1)) - -Once a machine is started, run: - -```sh -${PODMAN_BIN:-podman} cp $(${PODMAN_BIN:-podman} create --name kantra-download quay.io/konveyor/kantra:${kantra_version:-latest}):/usr/local/bin/darwin-kantra . && ${PODMAN_BIN:-podman} rm kantra-download -``` - -#### Windows - -When you ar not using Docker for Desktop on your Windows (see above), -you need to start a podman machine prior to running any podman commands (see [Setup for Windows](#windows-1)) - -Once a machine is started, run: - -```sh -${PODMAN_BIN:-podman} cp $(${PODMAN_BIN:-podman} create --name kantra-download quay.io/konveyor/kantra:${kantra_version:-latest}):/usr/local/bin/windows-kantra . && ${PODMAN_BIN:-podman} rm kantra-download -``` - -> Ensure that you add the executable to the `PATH`. +Go to the [release page](https://github.com/konveyor/kantra/releases) and download the zip file containing a binary for your platform and architecture. Unzip the archive and add the executable in it to your path. ## Setup (For Mac and Windows Only) -On Mac and Windows, a podman machine needs to be started prior to running any commands, unless you are using Docker (for Desktop): +On Mac and Windows, a podman machine needs to be started prior to running any commands: -##### Mac +##### Mac (Podman) Prior to starting your podman machine, run: @@ -111,7 +72,7 @@ Increase podman resources (minimum 4G memory is required): podman machine set --cpus 4 --memory 4096 ``` -##### Windows +##### Windows (Podman) Init the machine: From ead6206563cc42834eefb0d03cf1ff9327485359 Mon Sep 17 00:00:00 2001 From: Dylan Murray Date: Mon, 10 Jun 2024 12:25:19 -0400 Subject: [PATCH 2/2] Update language for container runtime specification Signed-off-by: Dylan Murray --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6fbac2b4..3a7f59fa 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Go to the [release page](https://github.com/konveyor/kantra/releases) and downlo ## Setup (For Mac and Windows Only) -On Mac and Windows, a podman machine needs to be started prior to running any commands: +On Mac and Windows, a container runtime needs to be started prior to running any commands. See the following instructions for starting Podman: ##### Mac (Podman)