Skip to content

Commit 45520fc

Browse files
github-actions[bot]github-actions[bot]
committed
chore: sync from governance-studio-infrastructure @ cc6d752
Updated: charts docs/auth0 docs/entra docs/keycloak Source: eqtylab/governance-studio-infrastructure@cc6d752
1 parent 635ef80 commit 45520fc

16 files changed

Lines changed: 153 additions & 64 deletions

‎charts/auth-service/README.md‎

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -357,26 +357,26 @@ When deployed via the umbrella chart, these global values are automatically used
357357

358358
### Health Checks
359359

360-
| Key | Type | Default | Description |
361-
| ---------------------------------- | ------ | ----------- | ----------------------------- |
362-
| startupProbe.httpGet.path | string | `"/health"` | Startup probe HTTP path |
363-
| startupProbe.httpGet.port | string | `"http"` | Startup probe port |
364-
| startupProbe.periodSeconds | int | `10` | Startup probe period |
365-
| startupProbe.failureThreshold | int | `30` | Startup failure threshold |
366-
| livenessProbe.httpGet.path | string | `"/health"` | Liveness probe HTTP path |
367-
| livenessProbe.httpGet.port | string | `"http"` | Liveness probe port |
368-
| livenessProbe.initialDelaySeconds | int | `30` | Liveness probe initial delay |
369-
| livenessProbe.periodSeconds | int | `10` | Liveness probe period |
370-
| livenessProbe.timeoutSeconds | int | `5` | Liveness probe timeout |
371-
| livenessProbe.failureThreshold | int | `3` | Liveness failure threshold |
372-
| livenessProbe.successThreshold | int | `1` | Liveness success threshold |
373-
| readinessProbe.httpGet.path | string | `"/health"` | Readiness probe HTTP path |
374-
| readinessProbe.httpGet.port | string | `"http"` | Readiness probe port |
375-
| readinessProbe.initialDelaySeconds | int | `10` | Readiness probe initial delay |
376-
| readinessProbe.periodSeconds | int | `5` | Readiness probe period |
377-
| readinessProbe.timeoutSeconds | int | `3` | Readiness probe timeout |
378-
| readinessProbe.failureThreshold | int | `3` | Readiness failure threshold |
379-
| readinessProbe.successThreshold | int | `1` | Readiness success threshold |
360+
| Key | Type | Default | Description |
361+
| ---------------------------------- | ------ | ----------------- | ----------------------------- |
362+
| startupProbe.httpGet.path | string | `"/health/ready"` | Startup probe HTTP path |
363+
| startupProbe.httpGet.port | string | `"http"` | Startup probe port |
364+
| startupProbe.periodSeconds | int | `10` | Startup probe period |
365+
| startupProbe.failureThreshold | int | `30` | Startup failure threshold |
366+
| livenessProbe.httpGet.path | string | `"/health"` | Liveness probe HTTP path |
367+
| livenessProbe.httpGet.port | string | `"http"` | Liveness probe port |
368+
| livenessProbe.initialDelaySeconds | int | `30` | Liveness probe initial delay |
369+
| livenessProbe.periodSeconds | int | `10` | Liveness probe period |
370+
| livenessProbe.timeoutSeconds | int | `5` | Liveness probe timeout |
371+
| livenessProbe.failureThreshold | int | `3` | Liveness failure threshold |
372+
| livenessProbe.successThreshold | int | `1` | Liveness success threshold |
373+
| readinessProbe.httpGet.path | string | `"/health/ready"` | Readiness probe HTTP path |
374+
| readinessProbe.httpGet.port | string | `"http"` | Readiness probe port |
375+
| readinessProbe.initialDelaySeconds | int | `10` | Readiness probe initial delay |
376+
| readinessProbe.periodSeconds | int | `5` | Readiness probe period |
377+
| readinessProbe.timeoutSeconds | int | `3` | Readiness probe timeout |
378+
| readinessProbe.failureThreshold | int | `3` | Readiness failure threshold |
379+
| readinessProbe.successThreshold | int | `1` | Readiness success threshold |
380380

381381
### Database Configuration
382382

@@ -458,11 +458,11 @@ All secret references support global fallbacks when deployed via umbrella chart.
458458

459459
#### Logging Configuration
460460

461-
| Key | Type | Default | Description |
462-
| ------------------------ | ------ | -------------------------------------- | --------------------------------- |
463-
| config.logging.level | string | `"info"` | Log level (debug/info/warn/error) |
464-
| config.logging.format | string | `"json"` | Log format (json/text) |
465-
| config.logging.skipPaths | string | `"/health,/health/live,/health/ready"` | Paths to skip in logs |
461+
| Key | Type | Default | Description |
462+
| ------------------------ | ------ | ----------- | ------------------------------------- |
463+
| config.logging.level | string | `"info"` | Log level (debug/info/warn/error) |
464+
| config.logging.format | string | `"json"` | Log format (json/text/console/pretty) |
465+
| config.logging.skipPaths | string | `"/health"` | Paths to skip in logs (prefix match) |
466466

467467
#### CORS Configuration
468468

@@ -849,12 +849,18 @@ View all environment variables:
849849
kubectl exec -it deployment/auth-service -n governance -- env | sort
850850
```
851851

852-
Test health endpoint:
852+
Test health endpoint (liveness):
853853

854854
```bash
855855
kubectl exec -it deployment/auth-service -n governance -- curl localhost:8080/health
856856
```
857857

858+
Test readiness endpoint:
859+
860+
```bash
861+
kubectl exec -it deployment/auth-service -n governance -- curl localhost:8080/health/ready
862+
```
863+
858864
### Common Issues
859865

860866
**Authentication failures**
@@ -907,9 +913,11 @@ kubectl exec -it deployment/auth-service -n governance -- curl localhost:8080/he
907913

908914
## Health Endpoints
909915

910-
| Endpoint | Description |
911-
| ------------- | -------------------- |
912-
| `GET /health` | Overall health check |
916+
| Endpoint | Description |
917+
| ------------------- | -------------------------------------------------- |
918+
| `GET /health` | Overall health check (used by livenessProbe) |
919+
| `GET /health/ready` | Readiness check (used by readiness/startup probes) |
920+
| `GET /health/auth` | Identity provider health check |
913921

914922
### API Documentation
915923

‎charts/auth-service/values.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ initContainers: []
226226
# @default -- See values below
227227
startupProbe:
228228
httpGet:
229-
path: /health
229+
path: /health/ready
230230
port: http
231231
failureThreshold: 30
232232
periodSeconds: 10
@@ -247,7 +247,7 @@ livenessProbe:
247247
# @default -- See values below
248248
readinessProbe:
249249
httpGet:
250-
path: /health
250+
path: /health/ready
251251
port: http
252252
initialDelaySeconds: 10
253253
periodSeconds: 5
@@ -456,12 +456,12 @@ config:
456456
level: "info"
457457
# -- Log Format
458458
# @default -- `json`
459-
# Options: json, text
459+
# Options: json, text, console, pretty
460460
format: "json"
461461
# -- Skip Paths
462-
# @default -- `/health,/health/live,/health/ready`
463-
# Paths to skip in access logs
464-
skipPaths: "/health,/health/live,/health/ready"
462+
# @default -- `/health`
463+
# Paths to skip in logs (prefix match)
464+
skipPaths: "/health"
465465

466466
# ---------------------------------------------------------------------------
467467
# CORS Configuration

‎charts/governance-platform/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1158,6 +1158,13 @@ integrity-service:
11581158

11591159
## Health Endpoints
11601160

1161+
| Service | Health (Liveness) | Readiness | Identity Provider |
1162+
| ------------------ | ------------------------------------------- | -------------------------------------- | ------------------------------------ |
1163+
| Auth Service | `GET /authService/health` | `GET /authService/health/ready` | `GET /authService/health/auth` |
1164+
| EQTY PDFGen | `GET /health/ready` (internal service) | `GET /health/ready` (internal service) | - |
1165+
| Governance Service | `GET /governanceService/health` | `GET /governanceService/health/ready` | `GET /governanceService/health/auth` |
1166+
| Governance Studio | `GET /` | `GET /` | — |
1167+
| Integrity Service | `GET /integrityService/health/v1` | `GET /integrityService/health/v1` | — |
11611168
| Service | Endpoint |
11621169
| ------------------ | ------------------------------------------- |
11631170
| Auth Service | `GET /authService/health` |

‎charts/governance-platform/values.yaml‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,7 @@ auth-service:
603603
# @default -- See values below
604604
startupProbe:
605605
httpGet:
606-
path: /health
606+
path: /health/ready
607607
port: http
608608
failureThreshold: 30
609609
periodSeconds: 10
@@ -624,7 +624,7 @@ auth-service:
624624
# @default -- See values below
625625
readinessProbe:
626626
httpGet:
627-
path: /health
627+
path: /health/ready
628628
port: http
629629
initialDelaySeconds: 10
630630
periodSeconds: 5
@@ -832,9 +832,9 @@ auth-service:
832832
# Options: json, text
833833
format: "json"
834834
# -- Skip Paths
835-
# @default -- `/health,/health/live,/health/ready`
836-
# Paths to skip in access logs
837-
skipPaths: "/health,/health/live,/health/ready"
835+
# @default -- `/health`
836+
# Paths to skip in logs (prefix match)
837+
skipPaths: "/health"
838838

839839
# ---------------------------------------------------------------------------
840840
# CORS Configuration
@@ -1689,7 +1689,7 @@ governance-service:
16891689
# @default -- See values below
16901690
startupProbe:
16911691
httpGet:
1692-
path: /health
1692+
path: /health/ready
16931693
port: http
16941694
failureThreshold: 30
16951695
periodSeconds: 10
@@ -1708,7 +1708,7 @@ governance-service:
17081708
# @default -- See values below
17091709
readinessProbe:
17101710
httpGet:
1711-
path: /health
1711+
path: /health/ready
17121712
port: http
17131713
initialDelaySeconds: 5
17141714
periodSeconds: 5
@@ -1864,6 +1864,11 @@ governance-service:
18641864
# Options: json, text, console, pretty
18651865
logFormat: "json"
18661866

1867+
# -- Skip Paths
1868+
# @default -- `/health`
1869+
# Paths to skip in logs (prefix match)
1870+
skipPaths: "/health"
1871+
18671872
# -- Credential Encryption Key
18681873
# @default -- `""` (auto-configured from global.secrets.encryption)
18691874
credentialEncryptionKey: ""

‎charts/governance-service/README.md‎

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -338,22 +338,22 @@ When deployed via the umbrella chart, these global values are automatically used
338338

339339
### Health Checks
340340

341-
| Key | Type | Default | Description |
342-
| ---------------------------------- | ------ | ----------- | ----------------------------- |
343-
| startupProbe.httpGet.path | string | `"/health"` | Startup probe HTTP path |
344-
| startupProbe.httpGet.port | string | `"http"` | Startup probe port |
345-
| startupProbe.periodSeconds | int | `10` | Startup probe period |
346-
| startupProbe.failureThreshold | int | `30` | Startup failure threshold |
347-
| livenessProbe.httpGet.path | string | `"/health"` | Liveness probe HTTP path |
348-
| livenessProbe.httpGet.port | string | `"http"` | Liveness probe port |
349-
| livenessProbe.initialDelaySeconds | int | `10` | Liveness probe initial delay |
350-
| livenessProbe.periodSeconds | int | `10` | Liveness probe period |
351-
| livenessProbe.failureThreshold | int | `3` | Liveness failure threshold |
352-
| readinessProbe.httpGet.path | string | `"/health"` | Readiness probe HTTP path |
353-
| readinessProbe.httpGet.port | string | `"http"` | Readiness probe port |
354-
| readinessProbe.initialDelaySeconds | int | `5` | Readiness probe initial delay |
355-
| readinessProbe.periodSeconds | int | `5` | Readiness probe period |
356-
| readinessProbe.failureThreshold | int | `2` | Readiness failure threshold |
341+
| Key | Type | Default | Description |
342+
| ---------------------------------- | ------ | ----------------- | ----------------------------- |
343+
| startupProbe.httpGet.path | string | `"/health/ready"` | Startup probe HTTP path |
344+
| startupProbe.httpGet.port | string | `"http"` | Startup probe port |
345+
| startupProbe.periodSeconds | int | `10` | Startup probe period |
346+
| startupProbe.failureThreshold | int | `30` | Startup failure threshold |
347+
| livenessProbe.httpGet.path | string | `"/health"` | Liveness probe HTTP path |
348+
| livenessProbe.httpGet.port | string | `"http"` | Liveness probe port |
349+
| livenessProbe.initialDelaySeconds | int | `10` | Liveness probe initial delay |
350+
| livenessProbe.periodSeconds | int | `10` | Liveness probe period |
351+
| livenessProbe.failureThreshold | int | `3` | Liveness failure threshold |
352+
| readinessProbe.httpGet.path | string | `"/health/ready"` | Readiness probe HTTP path |
353+
| readinessProbe.httpGet.port | string | `"http"` | Readiness probe port |
354+
| readinessProbe.initialDelaySeconds | int | `5` | Readiness probe initial delay |
355+
| readinessProbe.periodSeconds | int | `5` | Readiness probe period |
356+
| readinessProbe.failureThreshold | int | `2` | Readiness failure threshold |
357357

358358
### Database Configuration
359359

@@ -436,6 +436,7 @@ All config values support global fallbacks when deployed via umbrella chart.
436436
| config.environment | string | `""` | Application environment (auto-configured from global.environmentType) |
437437
| config.logLevel | string | `"info"` | Logging level (debug/info/warn/error) |
438438
| config.logFormat | string | `"json"` | Log output format (json/text/console/pretty) |
439+
| config.skipPaths | string | `"/health"` | Paths to skip in logs (prefix match) |
439440
| config.credentialEncryptionKey | string | `""` | Encryption key (auto-configured from global.secrets.encryption) |
440441

441442
#### HTTP Server Configuration
@@ -619,12 +620,18 @@ View all environment variables:
619620
kubectl exec -it deployment/governance-service -n governance -- env | sort
620621
```
621622

622-
Test health endpoint:
623+
Test health endpoint (liveness):
623624

624625
```bash
625626
kubectl exec -it deployment/governance-service -n governance -- curl localhost:10001/health
626627
```
627628

629+
Test readiness endpoint:
630+
631+
```bash
632+
kubectl exec -it deployment/governance-service -n governance -- curl localhost:10001/health/ready
633+
```
634+
628635
### Common Issues
629636

630637
**Application not accessible**
@@ -676,9 +683,11 @@ kubectl exec -it deployment/governance-service -n governance -- curl localhost:1
676683

677684
## Health Endpoints
678685

679-
| Endpoint | Description |
680-
| ------------- | -------------------- |
681-
| `GET /health` | Overall health check |
686+
| Endpoint | Description |
687+
| ------------------- | -------------------------------------------------- |
688+
| `GET /health` | Overall health check (used by livenessProbe) |
689+
| `GET /health/ready` | Readiness check (used by readiness/startup probes) |
690+
| `GET /health/auth` | Identity provider health check |
682691

683692
### API Documentation
684693

‎charts/governance-service/templates/configmap.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,5 @@ data:
2525
# ==========================================================================
2626
LOG_LEVEL: "{{ .Values.config.logLevel }}"
2727
LOG_FORMAT: "{{ .Values.config.logFormat }}"
28+
LOGGER_SKIP_PATHS: "{{ .Values.config.skipPaths }}"
2829
{{- end }}

‎charts/governance-service/values.yaml‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ initContainers: []
222222
# @default -- See values below
223223
startupProbe:
224224
httpGet:
225-
path: /health
225+
path: /health/ready
226226
port: http
227227
failureThreshold: 30
228228
periodSeconds: 10
@@ -241,7 +241,7 @@ livenessProbe:
241241
# @default -- See values below
242242
readinessProbe:
243243
httpGet:
244-
path: /health
244+
path: /health/ready
245245
port: http
246246
initialDelaySeconds: 5
247247
periodSeconds: 5
@@ -397,6 +397,11 @@ config:
397397
# Options: json, text, console, pretty
398398
logFormat: "json"
399399

400+
# -- Skip Paths
401+
# @default -- `/health`
402+
# Paths to skip in logs (prefix match)
403+
skipPaths: "/health"
404+
400405
# -- Credential Encryption Key
401406
# @default -- `""` (auto-configured from global.secrets.encryption)
402407
credentialEncryptionKey: ""

‎docs/auth0/deployment-guide-aws.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1484,9 +1484,15 @@ The script waits for the governance platform to be running, verifies database mi
14841484
# Auth Service health
14851485
curl -s https://$DOMAIN/authService/health | jq .
14861486
1487+
# Auth Service readiness
1488+
curl -s https://$DOMAIN/authService/health/ready | jq .
1489+
14871490
# Governance Service health
14881491
curl -s https://$DOMAIN/governanceService/health | jq .
14891492
1493+
# Governance Service readiness
1494+
curl -s https://$DOMAIN/governanceService/health/ready | jq .
1495+
14901496
# Governance Studio (should return 200)
14911497
curl -s -o /dev/null -w "%{http_code}" https://$DOMAIN/
14921498

‎docs/auth0/deployment-guide-azure.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1509,9 +1509,15 @@ The script waits for the governance platform to be running, verifies database mi
15091509
# Auth Service health
15101510
curl -s https://$DOMAIN/authService/health | jq .
15111511
1512+
# Auth Service readiness
1513+
curl -s https://$DOMAIN/authService/health/ready | jq .
1514+
15121515
# Governance Service health
15131516
curl -s https://$DOMAIN/governanceService/health | jq .
15141517
1518+
# Governance Service readiness
1519+
curl -s https://$DOMAIN/governanceService/health/ready | jq .
1520+
15151521
# Governance Studio (should return 200)
15161522
curl -s -o /dev/null -w "%{http_code}" https://$DOMAIN/
15171523

‎docs/auth0/deployment-guide-gcp.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1485,9 +1485,15 @@ The script waits for the governance platform to be running, verifies database mi
14851485
# Auth Service health
14861486
curl -s https://$DOMAIN/authService/health | jq .
14871487
1488+
# Auth Service readiness
1489+
curl -s https://$DOMAIN/authService/health/ready | jq .
1490+
14881491
# Governance Service health
14891492
curl -s https://$DOMAIN/governanceService/health | jq .
14901493
1494+
# Governance Service readiness
1495+
curl -s https://$DOMAIN/governanceService/health/ready | jq .
1496+
14911497
# Governance Studio (should return 200)
14921498
curl -s -o /dev/null -w "%{http_code}" https://$DOMAIN/
14931499

0 commit comments

Comments
 (0)