Skip to content

Commit

Permalink
Improvements on Documentation suggested by code reviews
Browse files Browse the repository at this point in the history
Signed-off-by: Alfredo Gutierrez <[email protected]>
  • Loading branch information
AlfredoG87 committed Mar 25, 2024
1 parent 2a15d3e commit 82a3348
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions charts/auth-layer-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,55 @@ With the following configurations:
- Minikube or a Kubernetes cluster [(more here)](https://minikube.sigs.k8s.io/docs/start/)
- Helm 3 [(install instructions here)](https://helm.sh/docs/intro/install/)
- kubectl [(install instructions here)](https://kubernetes.io/docs/tasks/tools/)

## Installation

To install the Authentication Layer Server, run the following commands:

- Install the chart, using the custom values file provided in the `values.yaml` file
```bash
helm install htg-auth-server .
```

### Helm Chart Overrides

#### Admin Password

Define a custom password, use `auth.adminPassword` like this:
```bash
helm install htg-auth-server . --set auth.adminPassword=yourpassword
```

#### Client Secret

Define a custom client secret, use `auth.clientSecret` like this:
```bash
helm install htg-auth-server . --set auth.clientSecret=yourclientsecret
```

if setting the client secret from an umbrella chart and need to re-use the same client secret for other charts is recommended to use the `global.auth.clientSecret` property.
```yaml
global:
auth:
clientSecret: yourclientsecret
```
#### Use External DB (PostgreSQL)
By default as part of the helm chart, it will deploy a PostgreSQL database. If you want to use an external database, you can use the following configuration:
```yaml
keycloak:
postgresql:
enabled: false
externalDatabase:
host: myexternalhost
user: myuser
password: mypassword
database: mydatabase
port: 5432
```
*After installation please give some time (a few minutes) for the KeyCloak server to start and be ready to use.*
*For a whole list of configurable parameters see the oficial documentation of the [KeyCloak Helm Chart from Bitnami](https://artifacthub.io/packages/helm/bitnami/keycloak/12.1.3)*
Expand Down

0 comments on commit 82a3348

Please sign in to comment.