From 6eb3047f453ec1e2d223d497e5a3db6c61be6709 Mon Sep 17 00:00:00 2001 From: Nithin Shekar Kuruba Date: Mon, 27 Jan 2025 09:59:22 -0800 Subject: [PATCH] fix: updated docs about the building images --- .../publish-image-keycloak-benchmark.yml | 4 +--- benchmark/benchmark-guide.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/.github/workflows/publish-image-keycloak-benchmark.yml b/.github/workflows/publish-image-keycloak-benchmark.yml index a7e6010a..b4f57230 100644 --- a/.github/workflows/publish-image-keycloak-benchmark.yml +++ b/.github/workflows/publish-image-keycloak-benchmark.yml @@ -1,9 +1,7 @@ name: Create and publish Benchmark Keycloak Docker image on: - push: - branches: - - 'feature/quarkus' + workflow_dispatch: env: GITHUB_REGISTRY: ghcr.io diff --git a/benchmark/benchmark-guide.md b/benchmark/benchmark-guide.md index c51a9aca..08dcbcc3 100644 --- a/benchmark/benchmark-guide.md +++ b/benchmark/benchmark-guide.md @@ -1,5 +1,21 @@ # Benchmark Guide +## Building Images + +### Server Image + +- You need a keycloak server with dataset provider added to be able to use it for generating test data +- To build such server image, run `.github/workflows/publish-image-keycloak-benchmark.yml` that builds an image using `docker/keycloak/Dockerfile-26-perf` that explicitly copies `docker/keycloak/dataset-providers/keycloak-benchmark-dataset-0.15-SNAPSHOT.jar` provider +- Deploy keycloak server run from this image **ONLY** in a test namespace +- After the testing is complete, uninstall the server from the namespace + +### Runner Image + +- The runner image is required if you need to run benchmark tests against test keycloak server in an openshift pod +- The image can be built using `.github/workflows/publish-image-benchmark-runner.yml` that uses `benchmark/Dockerfile` +- Existing image `sso-benchmark-runner:dev` can be used and if not found, re-build the image +- The instructions for running the benchmark runner are provided [here](#running-the-tests) + ## Dataset - The dataset is required to pre-populate realms, clients, and users in Keycloak under test