2.6 KiB
2.6 KiB
Keycloak Performance Testsuite - Docker Compose
Requirements:
- Maven 3.1.1+
- Unpacked Keycloak server distribution in
keycloak/targetfolder. - Docker 1.13+
- Docker Compose 1.14+
Keycloak Server Distribution
To unpack the current Keycloak server distribution into keycloak/target folder:
- Build and install the distribution by running
mvn install -Pdistributionfrom the root of the Keycloak project. - Unpack the installed artifact by running
mvn process-resourcesfrom the Performance Testsuite module.
Deployments
Singlenode Deployment
- Build / rebuild:
docker-compose build - Start services:
docker-compose up -d --buildNote: The--buildparameter triggers a rebuild/restart of changed services if they are already running. - Stop services:
docker-compose down -v. If you wish to keep the container volumes skip the-voption.
Keycloak Cluster Deployment
- Build / rebuild:
docker-compose -f docker-compose-cluster.yml build - Start services:
docker-compose -f docker-compose-cluster.yml up -d --build - Scaling KC nodes:
docker-compose -f docker-compose-cluster.yml up -d --build --scale keycloak=2 - Stop services:
docker-compose -f docker-compose-cluster.yml down -v. If you wish to keep the container volumes skip the-voption.
Cross-DC Deployment
- Build / rebuild:
docker-compose -f docker-compose-crossdc.yml build - Start services:
docker-compose -f docker-compose-crossdc.yml up -d --build - Scaling KC nodes:
docker-compose -f docker-compose-crossdc.yml up -d --build --scale keycloak_dc1=2 --scale keycloak_dc2=3 - Stop services:
docker-compose -f docker-compose-crossdc.yml down -v. If you wish to keep the container volumes skip the-voption.
Debugging docker containers:
- List started containers:
docker ps. It's useful to watch continuously:watch docker ps. To list compose-only containers use:docker-compose ps, but this doesn't show container health status. - Watch logs of a specific container:
docker logs -f crossdc_mariadb_dc1_1. - Watch logs of all containers managed by docker-compose:
docker-compose logs -f. - List networks:
docker network ls - Inspect network:
docker network inspect NETWORK_NAME. Shows network configuration and currently connected containers.
Network Addresses
KC
10.i.1.0/24 One network per DC. For single-DC deployments i = 0, for cross-DC deployment i ∈ ℕ is an index of particular DC.
Load Balancing
10.0.2.0/24 Network spans all DCs.
DB Replication
10.0.3.0/24 Network spans all DCs.
ISPN Replication
10.0.4.0/24 Network spans all DCs.