firegloves / wrk-entando

WRK-ENTANDO

wrk-entando is an utility to automate some HTTP benchmarking. It's based on wrk2

Local

You can execute it locally by run wrk-start-local.sh. Optionally you can update the exported env vars at the beninning of the file.

Dockerized

You can use the dockerized version. It's based on bootjp/wrk2 When the container starts, it executes /wrk-script/wrk-start.sh The default behaviour of the script is to authenticate against Keycloak instance and then to execute a wrk script querying 10 endpoints in order to stress Entando app. If you want to inspect the script you can find it at /wrk-script/wrk-composite-app-stress-script.lua.

Environment variables

Some environment variables are available and can be overridden:

NAME	DESCRIPTION	DEFAULT
ENTANDO_BASE_URL	Base url of the Entando instance to run benchmarking against	http://quickstart-fireg.apps.rd.entando.org
KC_AUTH_URL	Keycloak instance url responsible for the authentication	http://quickstart-kc-fireg.apps.rd.entando.org/auth/realms/entando/protocol/openid-connect/token
KC_CLIENT_ID	Keycloak client ID	dummy
KC_SECRET	Keycloak secret	dummy
WRK_THREADS	wrk number of concurrent threads	10
WRK_CONNECTIONS	wrk number of concurrent connections	500
WRK_DURATION	wkr benchmarking duration time	5m
WRK_RATE	wkr total requests per second	10

Here an example changing wrk duration in the containerized version:

docker run -e WRK_DURATION=10s entando-wrk

To change the env vars in the local version you can simply update variables at the beginning of the file wrk-start-local.sh

Here a brief explanation about how find current Entando env vars values using Openshift:

NAME	DESCRIPTION
ENTANDO_BASE_URL	Application > Routes --- You can copy the base url of any hostname
KC_AUTH_URL	Application > Routes --- Take quickstart-kc-ingress-*** hostname and append /realms/entando/protocol/openid-connect/token
KC_CLIENT_ID	Resources -> Secret -> quickstart-de-secret
KC_SECRET	Resources -> Secret -> quickstart-de-secret

Volume

wrk-entando creates a volume at the path /wrk-script. You can override it supplying your desired wrk-start.sh to execute. For example if you put your custom wrk-start.sh into /Users/entando/myVolume you can start entando-wrk as follows:

docker run --volume=/Users/entando/myVolume:/wrk-script entando-wrk