feat: updated documentation

Author: NithinKuruba

helm/timescaledb/README.md

@@ -21,3 +21,28 @@ CREATE DATABASE k6loadtests;
 
 CREATE EXTENSION IF NOT EXISTS timescaledb;
 ```
+
+### Grafana
+
+- Existing [grafana](https://sso-grafana-sandbox.apps.gold.devops.gov.bc.ca/) instance is being used to host the dashboards.
+- Ensure a data source exists with below config.
+
+  ```yaml
+  name: 'K6 Load Tests TimeScaleDB'
+  type: postgres
+  url: k6-patroni.xxx.svc.cluster.local:5432
+  database: k6loadtests
+  user: xxx
+  isDefault: false
+  secureJsonData:
+    password: xxx
+  jsonData:
+    sslmode: 'disable' # disable/require/verify-ca/verify-full
+    maxOpenConns: 0 # Grafana v5.4+
+    maxIdleConns: 2 # Grafana v5.4+
+    connMaxLifetime: 14400 # Grafana v5.4+
+    postgresVersion: 15
+    timescaledb: true
+  ```
+
+- Pre-built dashboards can be found [here](https://github.com/grafana/xk6-output-timescaledb/tree/main/grafana/dashboards)](https://github.com/grafana/xk6-output-timescaledb/tree/main/grafana/dashboards)

k6/k6-runner/Makefile

@@ -8,9 +8,9 @@ config:
 
 .PHONY: run_job
 run_job:
-	oc -n $(NAMESPACE) process -f ./openshift/k6/dc.yaml | oc -n $(NAMESPACE) apply -f -
+	oc -n $(NAMESPACE) process -f ./openshift/k6/dc.yaml -p DB_PASSWORD=$(DB_PASSWORD) -p DB_USER=$(DB_USER) | oc -n $(NAMESPACE) apply -f -
 
-.PHONY: delete
-delete:
+.PHONY: cleanup
+cleanup:
 	oc -n $(NAMESPACE) delete job sso-k6
 	oc -n $(NAMESPACE) delete configmap k6-config

k6/k6-runner/README.md

@@ -0,0 +1,27 @@
+# K6 Runner for Load Tests
+
+## Requirements
+
+- `k6-patroni` timescaleDB built on top of postgreSQL managed by patroni
+- `grafana` is the open source analytics & monitoring solution
+
+## Setup
+
+- Ensure `k6-patroni` is running in `c6af30-dev` namespace as a statefulset
+- Copy `sso-keycloak/k6/k6-runner/src/config/config.example.json` to `sso-keycloak/k6/k6-runner/src/config/config.json` and update values accordingly
+
+  ```sh
+  # initialize env vars
+  export NAMESPACE=
+  export DB_USER=
+  export DB_PASSWORD=
+
+  # create configmap with all the configurations
+  make config
+
+  # create a job to run load tests
+  make run_job
+
+  # clean up job and config map
+  make cleanup
+  ```

k6/k6-runner/openshift/k6/dc.yaml

@@ -47,13 +47,12 @@ parameters:
     value: dev
   - name: IMAGE_REPOSITORY
     value: ghcr.io/bcgov/sso-k6-runner
-  - name: HTTP_DEBUG
-    description: enable http debug logging in the k6 pod
-    value: 'false'
   - name: DB_USER
     value: ''
+    required: true
   - name: DB_PASSWORD
     value: ''
+    required: true
   - name: DB_NAME
     value: 'k6loadtests'
   - name: DB_HOST