Skip to content

Commit

Permalink
Merge pull request #78 from Signalen/docs/77-update-docs
Browse files Browse the repository at this point in the history
Update docs with renewed instructions
  • Loading branch information
bartjkdp authored Aug 5, 2024
2 parents 24a20fc + 0cdcccc commit dd69784
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
The Signalen backoffice relies on an external OpenID Connect identity provider for authentication of users. If no instance is available, [Dex](https://github.com/dexidp/dex) could be used with a static user as follows:

```bash
helm repo add stable https://kubernetes-charts.storage.googleapis.com/
helm repo add dex https://charts.dexidp.io
helm upgrade --install \
dex stable/dex \
dex dex/dex \
--create-namespace \
--namespace dex \
--set "config.issuer=https://dex.signalen.example.com" \
Expand All @@ -22,7 +22,9 @@ helm upgrade --install \
--set "config.staticClients[0].redirectURIs[0]=https://signalen.example.com/manage/incidents" \
--set "config.oauth2.responseTypes={token,id_token}" \
--set "ingress.enabled=true" \
--set "ingress.hosts[0]=dex.signalen.example.com"
--set "ingress.hosts[0].host=dex.signals.example.com" \
--set "ingress.hosts[0].paths[0].path=/" \
--set "ingress.hosts[0].paths[0].pathType=ImplementationSpecific"
```

This command will install Dex in the dex namespace and exposes an [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) on dex.signalen.example.com. It creates the following static user:
Expand Down Expand Up @@ -54,7 +56,9 @@ helm upgrade --install \
--set "settings.userIdField=email" \
--set "settings.classificationEndpoint=https://classification.signals.example.com/signals_mltool" \
--set "ingress.enabled=true" \
--set "ingress.hosts[0]=api.signals.example.com"
--set "ingress.hosts[0].host=api.signals.example.com" \
--set "ingress.hosts[0].paths[0].path=/" \
--set "ingress.hosts[0].paths[0].pathType=ImplementationSpecific"
```

And install the frontend chart:
Expand All @@ -67,7 +71,9 @@ helm upgrade --install \
--set "oidc.authEndpoint=https://dex.signals.example.com/auth" \
--set "config.apiBaseUrl=https://api.signals.example.com/signals" \
--set "ingress.enabled=true" \
--set "ingress.hosts[0]=signals.example.com"
--set "ingress.hosts[0].host=signals.example.com" \
--set "ingress.hosts[0].paths[0].path=/" \
--set "ingress.hosts[0].paths[0].pathType=ImplementationSpecific"
```

And install the classification chart:
Expand All @@ -79,7 +85,10 @@ helm upgrade --install \
--namespace signalen \
--set "signalsCategoryUrl=https://api.signals.example.com/signals/v1/public/terms" \
--set "ingress.enabled=true" \
--set "ingress.hosts[0]=classification.signals.example.com"
--set "ingress.hosts[0].host=classification.signals.example.com" \
--set "ingress.hosts[0].paths[0].path=/" \
--set "ingress.hosts[0].paths[0].pathType=ImplementationSpecific"

```

## Uninstall the charts
Expand Down

0 comments on commit dd69784

Please sign in to comment.