From ef56faca1aaa4499c0e7edf434b8f4982bf09bee Mon Sep 17 00:00:00 2001 From: John Matthews Date: Fri, 9 Aug 2024 09:45:19 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20README=20updates=20so=20folks=20?= =?UTF-8?q?may=20run=20stable=20as=20of=20today=20(#285)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * README updates so folks may run stable as of today Signed-off-by: John Matthews * trunk fmt updates Signed-off-by: John Matthews --------- Signed-off-by: John Matthews --- README.md | 33 +++++++++++++++++++++++++++------ compose.yaml | 2 +- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0ed1ce6e..59805a75 100644 --- a/README.md +++ b/README.md @@ -35,12 +35,33 @@ The approach begins with using static code analysis via the [Kantra](https://git The quickest way to get running is to leverage sample data committed into the Kai repo along with the `podman compose up` workflow -1. `git clone https://github.com/konveyor/kai.git` -1. `cd kai` -1. Run `podman compose up`. The first time this is run it will take several minutes to download images and to populate sample data. - - After the first run the DB will be populated and subsequent starts will be much faster, as long as the kai_kai_db_data volume is not deleted. - - To clean up all resources run `podman compose down && podman volume rm kai_kai_db_data`. -1. Kai backend is now running and ready to serve requests +1. `git clone https://github.com/konveyor/kai.git` +1. `cd kai` +1. `git checkout stable` + - **_NOTE:_** Until we fix [Issue #264](https://github.com/konveyor/kai/issues/264) there is a need to be on `stable` branch of code +1. Edit `compose.yaml` + + diff --git a/compose.yaml b/compose.yaml + index c0f2a9e..69a3be8 100644 + --- a/compose.yaml + +++ b/compose.yaml + @@ -1,7 +1,7 @@ + version: "3" + + x-kai-variables: &kai-variables + - DEMO_MODE: "False" + + DEMO_MODE: "True" + HUB_URL: ${HUB_URL:-https://tackle-konveyor-tackle.apps.example.com/hub} + IMPORTER_ARGS: + LOG_LEVEL: info + + - **_NOTE:_** The above edit of `compose.yaml` will not be needed once [Issue #257](https://github.com/konveyor/kai/issues/257) is fixed + +1. Run `podman compose up`. The first time this is run it will take several minutes to download images and to populate sample data. + - You will need to install [podman](https://podman.io/docs/installation) and [podman-compose](https://github.com/containers/podman-compose?tab=readme-ov-file#installation) if you do not already have it installed. This allows your system to run containers. + - After the first run the DB will be populated and subsequent starts will be much faster, as long as the kai_kai_db_data volume is not deleted. + - To clean up all resources run `podman compose down && podman volume rm kai_kai_db_data`. +1. Kai backend is now running and ready to serve requests ### Guided walk-through diff --git a/compose.yaml b/compose.yaml index 2481b758..c466df7d 100644 --- a/compose.yaml +++ b/compose.yaml @@ -1,7 +1,7 @@ version: "3" x-kai-variables: &kai-variables - DEMO_MODE: "False" + DEMO_MODE: "True" HUB_URL: ${HUB_URL:-https://tackle-konveyor-tackle.apps.example.com/hub} IMPORTER_ARGS: LOG_LEVEL: info