Update documentation

SCT-Engineering · Apr 16, 2025 · 219e349 · 219e349
1 parent 4ce631e
commit 219e349
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 Terraform module for deploying and configuring Keycloak on EKS clusters.
 
+Keycloak is a temporary OIDC solution to our clusters for enabling SSO login to the three web applications core to observability with the platform, ie. the Kubernetes Dashboard, Grafana and Kiali. Eventually, Keycloak will be replaced with OKTA provided OIDC, once TCO is ready for supporting this integration. Keycloak works in concert with GoGatekeeper that serves as an OIDC proxy fronting the web applications and validating the tokens originating from Keycloak. In our current configuration, we have a single generic user named `user` that acts as a master key for authenticating with Keycloak in the `cluster-user` realm, which is created by this module, and may access any of these applications. To retrieve the generic user password, run the following command: `kubectl get secret -n keycloak keycloak-user-creds -o jsonpath="{.data.password}" | base64 --decode ; echo`
+
+![Explanation of architecture](./simple-arch.svg "Explanation of architecture")
+
 ## Overview
 - Deploys Keycloak identity and access management solution
 - Configures AWS integration for authentication

diff --git a/simple-arch.svg b/simple-arch.svg