-
Notifications
You must be signed in to change notification settings - Fork 72
488 lines (431 loc) · 16.4 KB
/
rosa-scaling-benchmark.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
name: ROSA Cluster - Scaling Benchmark
on:
workflow_call:
inputs:
clusterName:
description: 'Name of the cluster'
type: string
default: 'gh-keycloak-a'
clusterPrefix:
description: 'Cluster prefix'
type: string
default: 'gh-keycloak'
region:
description: 'Name of the region where EC2 instances should be installed'
type: string
default: 'eu-west-1'
usersPerRealm:
description: 'Number of users for the scenario in DB'
type: number
default: 100000
maxWaitEntityCreation:
description: 'Maximum number of seconds to wait for creation of entities'
type: number
default: 10800
numberOfUsersPerSecond:
description: 'User logins per second'
type: number
default: 150
numberOfClientsPerSecond:
description: 'Client credential grants per second'
type: number
default: 750
measurement:
description: 'Measurement period (seconds)'
type: number
default: 600
skipCreateDataset:
description: 'Skip creating dataset'
type: boolean
default: false
outputArchiveSuffix:
description: 'Suffix for the output archive'
type: string
default: ''
workflow_dispatch:
inputs:
clusterName:
description: 'Name of the cluster'
type: string
default: 'gh-keycloak-a'
clusterPrefix:
description: 'Cluster prefix'
type: string
default: 'gh-keycloak'
region:
description: 'Name of the region where EC2 instances should be installed'
type: string
default: 'eu-west-1'
usersPerRealm:
description: 'Number of users for the scenario in DB'
type: number
default: 100000
maxWaitEntityCreation:
description: 'Maximum number of seconds to wait for creation of entities'
type: number
default: 10800
numberOfUsersPerSecond:
description: 'User logins per second'
type: number
default: 150
numberOfClientsPerSecond:
description: 'Client credential grants per second'
type: number
default: 750
measurement:
description: 'Measurement period (seconds)'
type: number
default: 600
skipCreateDataset:
description: 'Skip creating dataset'
type: boolean
default: false
outputArchiveSuffix:
description: 'Suffix for the output archive'
type: string
default: '1'
concurrency: cluster_${{ github.event.inputs.clusterName || format('gh-{0}', github.repository_owner) }}
env:
PROJECT_PREFIX: runner- # same as default
PROJECT: runner-keycloak
ANSIBLE_CUSTOM_VARS_ARG: '-e @env_rosa_benchmark.yml'
CLIENTS_PER_REALM: 10000
jobs:
run:
name: Run Benchmark
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup ROSA CLI
uses: ./.github/actions/rosa-cli-setup
with:
aws-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-default-region: ${{ vars.AWS_DEFAULT_REGION }}
rosa-token: ${{ secrets.ROSA_TOKEN }}
- name: Login to OpenShift cluster
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-a
- name: Setup Go Task
uses: ./.github/actions/task-setup
- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '21'
cache: 'maven'
- name: Cache Maven Wrapper
uses: actions/cache@v4
with:
path: |
.mvn/wrapper/maven-wrapper.jar
key: ${{ runner.os }}-maven-wrapper-${{ hashFiles('**/maven-wrapper.properties') }}
restore-keys: |
${{ runner.os }}-maven-wrapper-
- name: Build with Maven
run: |
./mvnw -B clean package -DskipTests -pl benchmark
tar xfvz benchmark/target/keycloak-benchmark-*.tar.gz
mv keycloak-benchmark-* keycloak-benchmark
- name: Get URLs
uses: ./.github/actions/get-keycloak-url
with:
project: ${{ env.PROJECT }}
- name: Take Backup offline
working-directory: provision/infinispan
run: task crossdc-disconnect
env:
ROSA_CLUSTER_NAME: ${{ inputs.clusterName || format('gh-{0}', github.repository_owner) }}
NAMESPACE: ${{ env.PROJECT }}
- name: Create Keycloak dataset with "${{ inputs.usersPerRealm }}" users and "${{ env.CLIENTS_PER_REALM }}" clients
if: ${{ !inputs.skipCreateDataset }}
uses: ./.github/actions/keycloak-create-dataset
with:
project: ${{ env.PROJECT }}
users: ${{ inputs.usersPerRealm }}
clients: 100
clientsPerRealm: ${{ env.CLIENTS_PER_REALM }}
createClientForSpecificRealm: true
maxWaitEntityCreation: ${{ inputs.maxWaitEntityCreation }}
- name: Bring Backup online
if: ${{ always() }}
working-directory: provision/infinispan
run: task crossdc-connect
env:
ROSA_CLUSTER_NAME: ${{ inputs.clusterName || format('gh-{0}', github.repository_owner) }}
NAMESPACE: ${{ env.PROJECT }}
- name: Restart Keycloak Pods after dataset creation
uses: ./.github/actions/keycloak-restart-pods
with:
project: ${{ env.PROJECT }}
- name: Create AWS EC2 instances
id: create_aws_ec2_instances
uses: ./.github/actions/ec2-create-instances
with:
region: ${{ inputs.region }}
- name: Prepare horreum report
uses: ./.github/actions/prepare-horreum-report
with:
createReportFile: true
- name: Run Memory Usage Total Query Before Benchmark on Cluster 1
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runMemoryUsageTotal: true
output: memory_create_sessions
- name: Login to OpenShift cluster 2
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-b
- name: Run Memory Usage Total Query Before Benchmark on Cluster 2
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runMemoryUsageTotal: true
output: memory_create_sessions
- name: Testing memory for creating sessions
id: kcb-authorization-code-1
run: >
./benchmark.sh ${{ inputs.region }}
--scenario=keycloak.scenario.authentication.AuthorizationCode
--server-url=${{ env.KEYCLOAK_URL }}
--realm-name=realm-0
--users-per-sec=${{ inputs.numberOfUsersPerSecond }}
--ramp-up=20
--logout-percentage=0
--measurement=${{ inputs.measurement }}
--users-per-realm=${{ inputs.usersPerRealm }}
--clients-per-realm=${{ env.CLIENTS_PER_REALM }}
--log-http-on-failure
--sla-error-percentage=0.001
continue-on-error: true
working-directory: ansible
- name: Login to OpenShift cluster 1
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-a
- name: Run Memory Usage Total Query After Benchmark on Cluster 1
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runMemoryUsageTotal: true
output: memory_create_sessions
- name: Login to OpenShift cluster 2
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-b
- name: Run Memory Usage Total Query After Benchmark on Cluster 2
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runMemoryUsageTotal: true
output: memory_create_sessions
- name: Calculate number of active sessions
id: active_sessions_count
env:
USERS_PER_SEC: ${{ inputs.numberOfUsersPerSecond }}
TIME_IN_SEC: ${{ inputs.measurement }}
run: echo "active_sessions=$(awk "BEGIN {print $USERS_PER_SEC*$TIME_IN_SEC; exit}")" >> $GITHUB_OUTPUT
- name: Calculate and Store Memory Usage Total For Active User Sessions
uses: ./.github/actions/prometheus-metrics-calc
with:
input: memory_create_sessions
performedTestName: 'memoryUsageTest'
calculatedMetricName: 'activeSessionsPer500MbPerPod' #as a unit for memory calculation is chosen 500MB memory size to find out how much user sessions so much memory can handle.
criteriaValue: ${{ steps.active_sessions_count.outputs.active_sessions }}
isvCPU: false
isMemory: true
- name: Login to OpenShift cluster 1
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-a
- name: Run CPU sec Util Query Before Benchmark on Cluster 1
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runCpuSecsUtil: true
output: user_logins_vCpu
- name: Login to OpenShift cluster 2
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-b
- name: Run CPU sec Util Query Before Benchmark on Cluster 2
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runCpuSecsUtil: true
output: user_logins_vCpu
- name: Testing CPU usage for user logins
id: kcb-authorization-code-2
run: >
./benchmark.sh ${{ inputs.region }}
--scenario=keycloak.scenario.authentication.AuthorizationCode
--server-url=${{ env.KEYCLOAK_URL }}
--realm-name=realm-0
--users-per-sec=${{ inputs.numberOfUsersPerSecond }}
--ramp-up=20
--logout-percentage=100
--measurement=${{ inputs.measurement }}
--users-per-realm=${{ inputs.usersPerRealm }}
--clients-per-realm=${{ env.CLIENTS_PER_REALM }}
--log-http-on-failure
--sla-error-percentage=0.001
continue-on-error: true
working-directory: ansible
- name: Login to OpenShift cluster 1
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-a
- name: Run CPU sec Util Query After Benchmark on Cluster 1
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runCpuSecsUtil: true
output: user_logins_vCpu
- name: Login to OpenShift cluster 2
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-b
- name: Run CPU sec Util Query After Benchmark on Cluster 2
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runCpuSecsUtil: true
output: user_logins_vCpu
- name: Calculate and Store CPU sec Util For Ran Benchmark
uses: ./.github/actions/prometheus-metrics-calc
with:
input: user_logins_vCpu
performedTestName: 'cpuUsageForLoginsTest'
calculatedMetricName: 'userLoginsPerSecPer1vCpuPerPod'
criteriaValue: ${{ inputs.numberOfUsersPerSecond }}
measurementInterval: ${{ inputs.measurement }}
isvCPU: true
isMemory: false
- name: Login to OpenShift cluster 1
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-a
- name: Run CPU sec Util Query Before Benchmark on Cluster 1
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runCpuSecsUtil: true
output: client_credential_grants_vCpu
- name: Login to OpenShift cluster 2
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-b
- name: Run CPU sec Util Query Before Benchmark on cluster 2
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runCpuSecsUtil: true
output: client_credential_grants_vCpu
- name: Testing CPU usage for client credential grants
id: kcb-client-secret
run: >
./benchmark.sh ${{ inputs.region }}
--scenario=keycloak.scenario.authentication.ClientSecret
--server-url=${{ env.KEYCLOAK_URL }}
--realm-name=realm-0
--users-per-sec=${{ inputs.numberOfClientsPerSecond }}
--ramp-up=20
--measurement=${{ inputs.measurement }}
--users-per-realm=${{ inputs.usersPerRealm }}
--clients-per-realm=${{ env.CLIENTS_PER_REALM }}
--log-http-on-failure
--sla-error-percentage=0.001
continue-on-error: true
working-directory: ansible
- name: Login to OpenShift cluster 1
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-a
- name: Run CPU sec Util Query After Benchmark on Cluster 1
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runCpuSecsUtil: true
output: client_credential_grants_vCpu
- name: Login to OpenShift cluster 2
uses: ./.github/actions/oc-keycloak-login
with:
clusterName: ${{ inputs.clusterPrefix }}-b
- name: Run CPU sec Util Query After Benchmark on cluster 2
uses: ./.github/actions/prometheus-run-queries
with:
project: ${{ env.PROJECT }}
runCpuSecsUtil: true
output: client_credential_grants_vCpu
- name: Calculate and Store CPU usage For Ran Benchmark
uses: ./.github/actions/prometheus-metrics-calc
with:
input: client_credential_grants_vCpu
performedTestName: 'cpuUsageForCredentialGrantsTest'
calculatedMetricName: 'credentialGrantsPerSecPer1vCpu'
criteriaValue: ${{ inputs.numberOfClientsPerSecond }}
measurementInterval: ${{ inputs.measurement }}
isvCPU: true
isMemory: false
- name: Finalize horreum report
uses: ./.github/actions/prepare-horreum-report
with:
createReportFile: false
- name: Archive Gatling reports
if: ${{ always() }}
uses: actions/upload-artifact@v4
with:
name: gatling-results-${{ inputs.outputArchiveSuffix }}
path: ansible/files/benchmark/*/results
retention-days: 5
- name: Archive Summary
uses: actions/upload-artifact@v4
with:
name: summary-${{ inputs.outputArchiveSuffix }}
path: ansible/files/benchmark/*/results/*/js/stats.json
retention-days: 5
- name: Archive Calculated Metrics summary
uses: actions/upload-artifact@v4
with:
name: final-report-json-${{ inputs.outputArchiveSuffix }}
path: |
result-*.json
retention-days: 5
- name: Delete EC2 instances
if: ${{ always() && steps.create_aws_ec2_instances.conclusion != 'skipped' }}
uses: ./.github/actions/ec2-delete-instances
with:
region: ${{ inputs.region }}
archive:
name: Commit results to Git repository
runs-on: ubuntu-latest
permissions:
contents: write
actions: write
needs:
- run
steps:
- name: Checkout repository for results
uses: actions/checkout@v4
with:
ref: 'result-data'
- uses: actions/download-artifact@v4
with:
name: final-report-json-${{ inputs.outputArchiveSuffix }}
- name: Commit result-summary
shell: bash
env:
GITHUB_OAUTH: ${{ secrets.GITHUB_TOKEN }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --global user.name "github-actions[bot]"
DATE_FOLDER=rosa_scalability/$(date +"%Y/%m/%d")
mkdir -p ${DATE_FOLDER}
mv *.json ${DATE_FOLDER}
git add .
git commit -m "generated"
git push