Resolve "sso_quickstart.md is blank"
Docs Merge Request
Changes
- fixed hyperlink markdown syntax issue with quickstart.md
- sso_quickstart.md was accidentally deleted / made blank, reverted that change to restore it. (the following are additional changes after restoring the sso_quickstart.md, which won't correctly show up as a diff, since it was accidentally deleted.)
- updated logic so BIG_BANG_VERSION would reference a latest version instead of a pinned version, added a comment about how to pin to a version + the last version the guide was tested against.
- updated dependencies k3d, helm, kustomize, kubectl to same versions the quickstart.md had recently been updated to.
- updated k3d cluster create flags to account for breaking changes from k3d v4.x -> v5.x
- removed
--values $HOME/bigbang/docs/example_configs/opa-overrides-k3d.yaml
reference to external file, and instead embedded the contents of that file in the how to guide, should be more resilient incase the file ever gets renamed or moved. - corrected a
| sudo tee -a ~/.ssh/config
--to be-->| tee -a ~/.ssh/config
after realizing an edge case where it'd fail + that it wasn't needed. - re-added valid wildcard ingress cert into keycloak's values (it had been moved to a new location, which means this how to guide was probably broken for a few months until this refresh occurred.)
- split some long markdown sections in 2, and removed apostrophes in some sections to improve ability to copy paste.
Note:
I did an E2E retest of the guide after finishing all commits / tweaks.
Preview of Changed markdown file
Current
Changes
For Issue
Closes #1134 (closed)
Merge request reports
Activity
added kinddocs statusdoing labels
assigned to @cmcgrath
added 1 commit
- 97e40623 - removed unnecessary sudo that could cause issues in an edge case
This will take a little longer than I thought. I just now noticed that this had been broken for months.
about 4 months ago the helm install logic used to reference point to a proper cert for keycloak
https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/1.19.0/chart/keycloak-dev-values.yaml#L53helm upgrade --install bigbang \$HOME/bigbang/chart \ --values \$HOME/bigbang/chart/keycloak-dev-values.yaml \ <--this changed --values \$HOME/ib_creds.yaml \ --values \$HOME/keycloak_qs_demo_values.yaml \ --namespace=bigbang --create-namespace
It got changed from the above to a dummy value.
--values \$HOME/bigbang/docs/example_configs/keycloak-dev-values.yaml \
https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/1.30.0/docs/example_configs/keycloak-dev-values.yaml#L53So I'll need to fix that and make it more robust against future breakage.
Edited by Christopher McGrathadded 5 commits
- a0c701d6 - improved idempotent logic to prevent human error edge case, slightly adjusted...
- acbbcf17 - moved some comments from commented out shell to text boxes to avoid a false error message.
- b6f21ba3 - added note to step 5 about a 4 min wait being normal
- a71690dd - added a note about command might take 10 mins
- 29a1a0cb - re-added valid wildcard ingress cert into keycloaks values
Toggle commit listadded statusreview label and removed statusdoing label
requested review from @kenna81
added 1 commit
- 593b06fb - clarified some directions and split some markdown sections for better copy pastability
added 1 commit
- b4e4f6c3 - added note about slow network edge case to step 5
added 1 commit
- 6455007d - added more what to expect notes to steps 16, 17, 18
added 1 commit
- cbe3b56c - fixed 2 issues introduced by spell check auto linter, ' in shell comment...
Ok Ready to merge
Pushed 2 changes to fix issues caused by auto spell check linter:
- I noticed that if I have a
#[admin@Laptop:~] echo hi # some code comment doesn't not have an apostrophe echo hi
^-- when copy pasting code comments with apostrophe's ('), it prevents copy paste from working correctly. I had previously purposefully misspelled isn't as isnt in a code comment to avoid this issue. The spell checker readded it which would have broken copy paste. To resolve I spelled it as isn't (valid by spell checker), and moved it outside of the code comment.
- 4 spaces had been removed, they had been added to cause purposeful line breaks to make the formatting of this section easier to read. 2 spaces has the same effect as 4 spaces, so I reverted the change only used 2 spaces vs 4 spaces. (some of the forced line breaks are there on purpose to improve readability) https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/1134-update-sso-quickstart/docs/guides/deployment_scenarios/sso_quickstart.md#step-14-create-an-application-identity-service-account-non-person-entity-in-keycloak-for-the-authdemo-webpage
requested review from @jasonkrause and @ryan.j.garcia
mentioned in commit c543bcc8