bigbang icon indicating copy to clipboard operation
bigbang copied to clipboard

Update Keycloak admin credentials docs/examples

Open p1-repo-sync-bot[bot] opened this issue 1 year ago • 5 comments

As David noted, the project's docs/examples for Keycloak admin credentials configuration need to be updated to reflect the correct working config, as listed in the issue description.

The outdated examples are likely missed artifacts triggered by the transition from the previous Wildfly generation of Keycloak to the recent Quarkus generation

diff --git a/docs/guides/using-bigbang/default-credentials.md b/docs/guides/using-bigbang/default-credentials.md
index f50be77d..d30adc30 100644
--- a/docs/guides/using-bigbang/default-credentials.md
+++ b/docs/guides/using-bigbang/default-credentials.md
@@ -27,5 +27,5 @@ The applications in the table below provide both SSO and built in auth. The tabl
 | Sonarqube | `admin` | `admin` | Default password can be overridden with Helm values `addons.sonarqube.values.account.adminPassword` |
 | Anchore | `admin` | (randomly generated) | Use `kubectl get secrets -n anchore anchore-anchore-enterprise -o go-template='{{.data.ANCHORE_ADMIN_PASSWORD \| base64decode}}'` to get the password, or override with Helm values `addons.anchore.values.anchoreGlobal.defaultAdminPassword` |
 | Mattermost | N/A | N/A | Prompted to setup an account when you first hit the virtual service - this user becomes admin, no default user |
-| Keycloak | `admin` | `password` | Default username and password can be overridden with Helm values `addons.keycloak.values.secrets.credentials.stringData.adminuser` and `addons.keycloak.values.secrets.credentials.stringData.password` respectively |
+| Keycloak | `admin` | `password` | Default username and password can be overridden with Helm values `addons.keycloak.values.secrets.env.stringData.KEYCLOAK_ADMIN` and `addons.keycloak.values.secrets.env.stringData.KEYCLOAK_ADMIN_PASSWORD` respectively |
 | Neuvector | `admin` | `admin` | You should change the default password when you log into Neuvector. Can also be changed via the chart at the `controller.secret.data.userinitcfg.yaml` key, see the [upstream docs for more details and examples](https://open-docs.neuvector.com/deploying/production/configmap).|

diff --git a/docs/understanding-bigbang/package-architecture/keycloak.md b/docs/understanding-bigbang/package-architecture/keycloak.md
index 6cfe3471..21634aa9 100644
--- a/docs/understanding-bigbang/package-architecture/keycloak.md
+++ b/docs/understanding-bigbang/package-architecture/keycloak.md
@@ -127,10 +127,10 @@ addons:
   keycloak:
     values:
       secrets:
-        credentials:
+        env:
           stringData:
-            adminuser: your_admin_username
-            password: your_admin_password
+            KEYCLOAK_ADMIN: your_admin_username
+            KEYCLOAK_ADMIN_PASSWORD: your_admin_password

p1-repo-sync-bot[bot] avatar Mar 28 '24 09:03 p1-repo-sync-bot[bot]