Skip to content

Commit

Permalink
📖 README updates so folks may run stable as of today (#285)
Browse files Browse the repository at this point in the history
* README updates so folks may run stable as of today

Signed-off-by: John Matthews <jwmatthews@gmail.com>

* trunk fmt updates

Signed-off-by: John Matthews <jwmatthews@gmail.com>

---------

Signed-off-by: John Matthews <jwmatthews@gmail.com>
  • Loading branch information
jwmatthews committed Aug 9, 2024
1 parent f645c2b commit ef56fac
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 7 deletions.
33 changes: 27 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion compose.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit ef56fac

Please sign in to comment.