Skip to content

Commit

Permalink
fix: updated docs about the building images
Browse files Browse the repository at this point in the history
  • Loading branch information
NithinKuruba committed Jan 27, 2025
1 parent 82f3811 commit 6eb3047
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/publish-image-keycloak-benchmark.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
name: Create and publish Benchmark Keycloak Docker image

on:
push:
branches:
- 'feature/quarkus'
workflow_dispatch:

env:
GITHUB_REGISTRY: ghcr.io
Expand Down
16 changes: 16 additions & 0 deletions benchmark/benchmark-guide.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 6eb3047

Please sign in to comment.