adding Keycloak to SSO guides #1383
Conversation
dmitry-spectro
requested review from
karl-cardenas-coding,
rahulhazra97 and
sudkul87
and removed request for
a team
❌ Deploy Preview for docs-spectrocloud failed.
|
| <a href="#gdcalert19">alert19</a> | ||
| <a href="#gdcalert20">alert20</a> | ||
|
|
||
| <p style="color: red; font-weight: bold">>>>>> PLEASE check and correct alert issues and delete this message and the inline alerts.<hr></p> |
There was a problem hiding this comment.
Remove all HTML tags and elements.
| # Palette Keycloak integration | ||
|
|
||
|
|
||
| ## Prerequisites: |
There was a problem hiding this comment.
| ## Prerequisites: | |
| # Prerequisites |
There was a problem hiding this comment.
Your document must adhere to the following layout:
# Title
# Prerequisites
# Enablement
1. Action 1 ...
...
...
N. Action N
# Validate
Notice that there are no H2 tags. Read the details here.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
|
|
||
| <p style="color: red; font-weight: bold">>>>>> gd2md-html alert: ERRORs: 0; WARNINGs: 0; ALERTS: 20.</p> | ||
| <ul style="color: red; font-weight: bold"><li>See top comment block for details on ERRORs and WARNINGs. <li>In the converted Markdown or HTML, search for inline alerts that start with >>>>> gd2md-html alert: for specific instances that need correction.</ul> |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud.ableism] Avoid using ableism terms. Use 'display' instead of 'See'.
|
|
||
|
|
||
|
|
||
| # Palette Keycloak integration |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|
|
||
| 1. Access to Palette | ||
| 2. Keycloak exposed on an external IP address, preferably with DNS name |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|
|
||
| 1. Provision a k8s cluster from Palette and download its kubeconfig | ||
| 2. Let’s install keycloak on our Kubernetes cluster with CLI: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'keycloak'?
|
|
||
| 1. Provision a k8s cluster from Palette and download its kubeconfig | ||
| 2. Let’s install keycloak on our Kubernetes cluster with CLI: | ||
| 3. After a couple of minutes, verify which address Keycloak got: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|  | ||
|
|
||
|
|
||
| 23. I add a team “admins” and add “Project Admin” role to my project “Default” |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'admin' instead of 'Admin'.
|
|
||
|  | ||
|
|
||
| 26. I go back to Keycloak, click on “Users” on the left hand side and create a user, making sure “Username”, “Email”, “First Name” and “Last Name” are all filled in. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|  | ||
|
|
||
| 28. If I now open another incognito window, go to Palette and log in with my newly created user in Keycloak, I should be automatically logged in Palette as admin! |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|  | ||
|
|
||
| 29. Voilà, our example is done,we’re logged in with the user from Keycloak without touching anything in Palette |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|  | ||
|
|
||
|
|
||
| Please contact us if you have any further questions on how to set up proper RBAC! |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Exclamation] Don't use exclamation points in text.
| @@ -0,0 +1,134 @@ | |||
| # Palette Keycloak integration | |||
|
|
|||
| This document permits to integrate Palette with Keycloak and log in to Palette with credentials stored in Keycloak | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
| @@ -0,0 +1,134 @@ | |||
| # Palette Keycloak integration | |||
|
|
|||
| This document permits to integrate Palette with Keycloak and log in to Palette with credentials stored in Keycloak | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
| ## Installation | ||
|
|
||
| 1. Provision a Kubernetes cluster from Palette and download its kubeconfig | ||
| 2. Install keycloak on our Kubernetes cluster with CLI: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'keycloak'?
| wget -q -O - https://raw.githubusercontent.com/keycloak/keycloak-quickstarts/latest/kubernetes-examples/keycloak-ingress.yaml | sed "s/KEYCLOAK_HOST/a5f3a06f0063143fea26b6a086cb2c89-1900572074.eu-west-3.elb.amazonaws.com/" | kubectl create -f - | ||
| ``` | ||
|
|
||
| This creates an ingress and Palette should now show Keycloak service: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
| This creates an ingress and Palette should now show Keycloak service: | ||
|
|
||
|  |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'alt_text'?
|
|
||
|  | ||
|
|
||
| ## OPTIONAL: Create a Team in Palette and add one more user in Keycloak |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|  | ||
|
|
||
| 23. Add a team “admins” and add “Project Admin” role to the “Default” project |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'admin' instead of 'Admin'.
|
|
||
|  | ||
|
|
||
| 26. Go back to Keycloak, click on “Users” on the left hand side and create a user, making sure “Username”, “Email”, “First Name” and “Last Name” are all filled in. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|  | ||
|
|
||
| 28. Open another incognito window, go to Palette and log in with the newly created user in Keycloak. You should be automatically logged in Palette as admin! |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Keycloak'?
|
|
||
|  | ||
|
|
||
| 29. Voilà, the example is done, you should be logged in with the user from Keycloak without touching anything in Palette! |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Exclamation] Don't use exclamation points in text.
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 7%, saving 401.35 KB.
507 images did not require optimisation. |
|
@dmitry-spectro I'm closing this ticket as the merge conflicts are a bit tricky to resolve. I created a new PR #1839 |
Describe the Change
This PR adds Keycloak integration guide to SSO
Review Changes
💻 Add Preview URL
🎫 Jira Ticket