Skip to content

Commit

Permalink
docs: add postgres and tui instructions (#6149)
Browse files Browse the repository at this point in the history
Signed-off-by: Amro Misbah <amromisba7@gmail.com>
  • Loading branch information
misba7 authored Sep 27, 2023
1 parent 00673ae commit 6269d30
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 14 deletions.
33 changes: 30 additions & 3 deletions docs/admin/install/helm-install/amazon-eks.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,32 @@ Releases of images are in style 1.0.0-beta.0, 1.0.0-0
cnCouchbaseUser: janssen
```

- PostgreSQL for persistence storage

In a production environment, a production grade PostgreSQL server should be used such as `Amazon RDS`

For testing purposes, you can deploy it on the EKS cluster using the following command:

```
helm install my-release --set auth.postgresPassword=Test1234#,auth.database=jans -n jans oci://registry-1.docker.io/bitnamicharts/postgresql
```

Add the following yaml snippet to your `override.yaml` file:

```yaml
global:
cnPersistenceType: sql
config:
configmap:
cnSqlDbName: jans
cnSqlDbPort: 5432
cnSqlDbDialect: pgsql
cnSqlDbHost: my-release-mysql.jans.svc
cnSqlDbUser: postgres
cnSqlDbTimezone: UTC
cnSqldbUserPassword: Test1234#
```

- MySQL for persistence storage

Expand All @@ -197,8 +222,7 @@ Releases of images are in style 1.0.0-beta.0, 1.0.0-0
For testing purposes, you can deploy it on the EKS cluster using the following commands:

```
helm repo add bitnami https://charts.bitnami.com/bitnami
helm install my-release --set auth.rootPassword=Test1234#,auth.database=jans bitnami/mysql -n jans
helm install my-release --set auth.rootPassword=Test1234#,auth.database=jans -n jans oci://registry-1.docker.io/bitnamicharts/mysql
```

Add the following yaml snippet to your `override.yaml` file:
Expand Down Expand Up @@ -256,4 +280,7 @@ Releases of images are in style 1.0.0-beta.0, 1.0.0-0
helm repo add janssen https://docs.jans.io/charts
helm repo update
helm install janssen janssen/janssen -n jans -f override.yaml
```
```

## Configure Janssen
You can use the [TUI](../../kubernetes-ops/tui-k8s.md) to configure Janssen components. The TUI calls the Config API to perform ad hoc configuration.
35 changes: 31 additions & 4 deletions docs/admin/install/helm-install/google-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,17 +178,41 @@ Releases of images are in style 1.0.0-beta.0, 1.0.0-0
```


- PostgreSQL for persistence storage

In a production environment, a production grade PostgreSQL server should be used such as `Cloud SQL`

For testing purposes, you can deploy it on the GKE cluster using the following command:

```
helm install my-release --set auth.postgresPassword=Test1234#,auth.database=jans -n jans oci://registry-1.docker.io/bitnamicharts/postgresql
```

Add the following yaml snippet to your `override.yaml` file:

```yaml
global:
cnPersistenceType: sql
config:
configmap:
cnSqlDbName: jans
cnSqlDbPort: 5432
cnSqlDbDialect: pgsql
cnSqlDbHost: my-release-mysql.jans.svc
cnSqlDbUser: postgres
cnSqlDbTimezone: UTC
cnSqldbUserPassword: Test1234#
```

- MySQL for persistence storage

In a production environment, a production grade MySQL server should be used such as `Cloud SQL`

For testing purposes, you can deploy it on the GKE cluster using the following commands:
For testing purposes, you can deploy it on the GKE cluster using the following command:

```
helm repo add bitnami https://charts.bitnami.com/bitnami
helm install my-release --set auth.rootPassword=Test1234#,auth.database=jans bitnami/mysql -n jans
helm install my-release --set auth.rootPassword=Test1234#,auth.database=jans -n jans oci://registry-1.docker.io/bitnamicharts/mysql
```

Add the following yaml snippet to your `override.yaml` file:
Expand Down Expand Up @@ -245,4 +269,7 @@ Releases of images are in style 1.0.0-beta.0, 1.0.0-0
helm repo add janssen https://docs.jans.io/charts
helm repo update
helm install janssen janssen/janssen -n jans -f override.yaml
```
```

## Configure Janssen
You can use the [TUI](../../kubernetes-ops/tui-k8s.md) to configure Janssen components. The TUI calls the Config API to perform ad hoc configuration.
35 changes: 31 additions & 4 deletions docs/admin/install/helm-install/microsoft-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,17 +183,41 @@ Releases of images are in style 1.0.0-beta.0, 1.0.0-0
cnCouchbaseUser: janssen
```

- PostgreSQL for persistence storage

In a production environment, a production grade PostgreSQL server should be used such as `Azure Database for PostgreSQL`

For testing purposes, you can deploy it on the AKS cluster using the following command:

```
helm install my-release --set auth.postgresPassword=Test1234#,auth.database=jans -n jans oci://registry-1.docker.io/bitnamicharts/postgresql
```

Add the following yaml snippet to your `override.yaml` file:

```yaml
global:
cnPersistenceType: sql
config:
configmap:
cnSqlDbName: jans
cnSqlDbPort: 5432
cnSqlDbDialect: pgsql
cnSqlDbHost: my-release-mysql.jans.svc
cnSqlDbUser: postgres
cnSqlDbTimezone: UTC
cnSqldbUserPassword: Test1234#
```

- MySQL for persistence storage

In a production environment, a production grade MySQL server should be used such as `Azure Database for MySQL`

For testing purposes, you can deploy it on the AKS cluster using the following commands:
For testing purposes, you can deploy it on the AKS cluster using the following command:

```
helm repo add bitnami https://charts.bitnami.com/bitnami
helm install my-release --set auth.rootPassword=Test1234#,auth.database=jans bitnami/mysql -n jans
helm install my-release --set auth.rootPassword=Test1234#,auth.database=jans -n jans oci://registry-1.docker.io/bitnamicharts/mysql
```

Add the following yaml snippet to your `override.yaml` file:
Expand Down Expand Up @@ -251,4 +275,7 @@ Releases of images are in style 1.0.0-beta.0, 1.0.0-0
helm repo add janssen https://docs.jans.io/charts
helm repo update
helm install janssen janssen/janssen -n jans -f override.yaml
```
```

## Configure Janssen
You can use the [TUI](../../kubernetes-ops/tui-k8s.md) to configure Janssen components. The TUI calls the Config API to perform ad hoc configuration.
5 changes: 2 additions & 3 deletions docs/admin/kubernetes-ops/tui-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@ tags:
2. Now we can grab the FQDN, client-id, client-secret, and connect using the following commands:
```
FQDN= #Add your FQDN here
# We are assuming janssen is deployed in `jans` namespace
TUI_CLIENT_ID=$(kubectl get cm cn -o json -n jans | grep '"tui_client_id":' | sed -e 's#.*:\(\)#\1#' | tr -d '"' | tr -d "," | tr -d '[:space:]')
TUI_CLIENT_SECRET=$(kubectl get secret cn -o json -n jans | grep '"tui_client_pw":' | sed -e 's#.*:\(\)#\1#' | tr -d '"' | tr -d "," | tr -d '[:space:]' | base64 -d)
TUI_CLIENT_ID=$(kubectl get cm cn -n <namespace> --template={{.data.jca_client_id}})
TUI_CLIENT_SECRET=$(kubectl get secret cn -n <namespace> --template={{.data.jca_client_pw}} | base64 -d)
#add -noverify if your FQDN is not registered
python3 jans-cli-tui-linux-ubuntu-X86-64.pyz --host $FQDN --client-id $TUI_CLIENT_ID --client-secret $TUI_CLIENT_SECRET
```

0 comments on commit 6269d30

Please sign in to comment.