DoD-Platform-One / bigbang

BigBang the product
https://repo1.dso.mil/big-bang/bigbang
Apache License 2.0
168 stars 68 forks source link

Update Keycloak admin credentials docs/examples #58

Closed p1-repo-sync-bot[bot] closed 6 months ago

p1-repo-sync-bot[bot] commented 8 months ago

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] commented 7 months ago

ryan.j.garcia commented:

Hi @david.urrutia do the commands from this document work? https://repo1.dso.mil/big-bang/product/packages/keycloak/-/blob/main/docs/configuration.md?ref_type=heads#admin-user

If so we can get them updated to all reflect that

p1-repo-sync-bot[bot] commented 6 months ago

wyatt.fry commented:

Reached out to David to ask for a response to Ryan and Jacob

p1-repo-sync-bot[bot] commented 6 months ago

lgomez2 commented:

I deployed a dev cluster and validated that the keycloak admin user and password should be nested under secrets.env.stringData, and not secrets.credentials.stringData. Looking through past merge requests this change was introduced over a year ago in MR #87

I'll make the correction to the documentation.

Screenshot_2024-05-14_at_3.17.30_PM

Screenshot_2024-05-14_at_3.24.25_PM

p1-repo-sync-bot[bot] commented 6 months ago

lgomez2 commented:

Validated BB umbrella chart credential values and updated documentation for the umbrell chart have opened MR 4357

p1-repo-sync-bot[bot] commented 6 months ago

lgomez2 commented:

Validated BB umbrella chart credential values and updated documentation for the umbrella chart

MR 4357

p1-repo-sync-bot[bot] commented 6 months ago

lgomez2 commented:

Keycloak Package MR was also merged in.

Setting ticket to resolved status.

p1-repo-sync-bot[bot] commented 6 months ago

Issue 'Update Keycloak admin credentials docs/examples' closed from GitLab side