Keycloak How-to #1839

karl-cardenas-coding · 2023-11-22T23:47:14Z

Describe the Change

This PR carries over the work @dmitry-spectro did in PR #1383

Review Changes

netlify · 2023-11-22T23:47:19Z

✅ Deploy Preview for docs-spectrocloud ready!

Name	Link
🔨 Latest commit	`eff4170`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-spectrocloud/deploys/65674c5152a69a00089d0884
😎 Deploy Preview	https://deploy-preview-1839--docs-spectrocloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

lennessyy

Looks good - added some copyediting suggestions

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md|194 col 25| [Vale.Spelling] Did you really mean 'Keycloak'?
docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md|202 col 138| [Vale.Spelling] Did you really mean 'Keycloak'?
docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md|207 col 4| [Vale.Spelling] Did you really mean 'Keycloak'?
docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md|209 col 4| [Vale.Spelling] Did you really mean 'Keycloak'?
docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md|209 col 13| [Vale.Spelling] Did you really mean 'Quickstarts'?
docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md|211 col 11| [Vale.Spelling] Did you really mean 'Keycloak'?

github-actions · 2023-11-28T23:48:44Z

docs/docs-content/user-management/saml-sso/saml-sso.md

@@ -36,3 +36,6 @@ Enable SSO by following our [Enable SSO in Palette](enable-saml.md) guide.


 - [Palette SSO with Okta SAML](palette-sso-with-okta-saml.md)
+
+
+- [Palette SSO with Keycloak](palette-sso-with-keycloak.md)


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Keycloak'?

github-actions · 2023-11-28T23:48:44Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+---
+
+
+Keycloak is an open-source Identity and Access Management (IAM) tool, primarily used for simplifying the authentication and authorization processes in modern applications and services. It provides a wide range of features including Single Sign-On (SSO), two-factor authentication, and social login capabilities. Keycloak is designed to manage users, credentials, roles, and groups efficiently, enabling developers to secure their applications and services with minimal additional coding. Keycloak supports various industry-standard protocols like OpenID Connect, OAuth 2.0, and SAML 2.0, facilitating integration with a multitude of platforms and services.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Keycloak'?

github-actions · 2023-11-28T23:48:44Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+---
+
+
+Keycloak is an open-source Identity and Access Management (IAM) tool, primarily used for simplifying the authentication and authorization processes in modern applications and services. It provides a wide range of features including Single Sign-On (SSO), two-factor authentication, and social login capabilities. Keycloak is designed to manage users, credentials, roles, and groups efficiently, enabling developers to secure their applications and services with minimal additional coding. Keycloak supports various industry-standard protocols like OpenID Connect, OAuth 2.0, and SAML 2.0, facilitating integration with a multitude of platforms and services.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Keycloak'?

github-actions · 2023-11-28T23:48:44Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+---
+
+
+Keycloak is an open-source Identity and Access Management (IAM) tool, primarily used for simplifying the authentication and authorization processes in modern applications and services. It provides a wide range of features including Single Sign-On (SSO), two-factor authentication, and social login capabilities. Keycloak is designed to manage users, credentials, roles, and groups efficiently, enabling developers to secure their applications and services with minimal additional coding. Keycloak supports various industry-standard protocols like OpenID Connect, OAuth 2.0, and SAML 2.0, facilitating integration with a multitude of platforms and services.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Keycloak'?

github-actions · 2023-11-28T23:48:44Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+Keycloak is an open-source Identity and Access Management (IAM) tool, primarily used for simplifying the authentication and authorization processes in modern applications and services. It provides a wide range of features including Single Sign-On (SSO), two-factor authentication, and social login capabilities. Keycloak is designed to manage users, credentials, roles, and groups efficiently, enabling developers to secure their applications and services with minimal additional coding. Keycloak supports various industry-standard protocols like OpenID Connect, OAuth 2.0, and SAML 2.0, facilitating integration with a multitude of platforms and services.
+
+
+You can integrate Keycloak with Palette to enable SSO for your users. This guide will walk you through the steps to set up Keycloak as an OIDC provider for Palette.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Keycloak'?

github-actions · 2023-11-28T23:48:46Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+  ![alt_text](/keycloak/user-management_saml-sso_keycloak-10-keycloak-admin.png "Keycloak Admin")
+
+
+You have now configured SSO for Palette with Keycloak. You can now log in to Palette using the admin user you created in Keycloak. Use the validation steps below to validate the SSO configuration. Check out the [Create a Team](#create-a-team) section to learn how to create a team and assign roles to users.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Keycloak'?

github-actions · 2023-11-28T23:48:46Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+
+1. Log out of Palette. Click on the top right **User Menu** and select **Log out**.
+
+2. Sign in to Palette using the admin user you created in Keycloak. You will be redirected to the Keycloak login page. Enter the credentials for the admin user you created in Keycloak.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Keycloak'?

github-actions · 2023-11-28T23:48:46Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+
+  ![Keycloak Admin console](/keycloak//user-management_palette-rback_keycloak_login.png)
+
+3. Upon successful authentication, you will be redirected to Palette. You will be logged in to Palette as the admin user you created in Keycloak.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Keycloak'?

github-actions · 2023-11-28T23:48:46Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+
+## Create a Team
+
+1. Log in to Palette as a Tenant Admin. Navigate to the left **Main Menu** and select **Users & Teams**. Click on the **Teams** tab to access the Teams page. Click on the **Create Team** button to create a new team.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Terms] Use 'admin' instead of 'Admin'.

github-actions · 2023-11-28T23:48:46Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+2. Provide a team name, such as `admins` but leave the **Members** field empty. Click on **Confirm** to create the team.
+
+
+3. Next, select the **admins** row to access the team settings page. Click on **New Project Role** and asdd the **Project Admin** role to the **Default** project. Click on **Confirm** to save the changes.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'asdd'?

…oak-v2

…keycloak-v2

github-actions · 2023-11-29T00:37:12Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+
+- [Keycloak Documentation](https://www.keycloak.org/documentation)
+
+- [Keycloak Quickstarts](https://www.keycloak.org/getting-started/getting-started-kube)


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Quickstarts'?

github-actions · 2023-11-29T00:46:52Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 29.5%, saving 2.15 MB.

Filename	Before	After	Improvement	Visual comparison
`static/assets/docs/images/keycloak/user-management_palette-rback_keycloak_login.png`	179.77 KB	105.49 KB	-41.3%	View diff
`static/assets/docs/images/keycloak/user-management_palette-rback_palette-rbac-model.png`	3.58 MB	2.45 MB	-31.7%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-01-keycloak-service.png`	215.70 KB	140.11 KB	-35.0%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-02-callback-url.png`	227.44 KB	178.16 KB	-21.7%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-03-create-client.png`	179.94 KB	126.67 KB	-29.6%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-04-palette-username.png`	129.53 KB	89.70 KB	-30.7%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-05-client-authentication.png`	130.57 KB	82.24 KB	-37.0%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-06-keycloak-callback.png`	170.72 KB	120.03 KB	-29.7%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-07-keycloak-credentials.png`	207.99 KB	165.36 KB	-20.5%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-08-palette-callback.png`	405.77 KB	331.50 KB	-18.3%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-09-palette-oidc-enabled.png`	285.79 KB	227.41 KB	-20.4%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-10-keycloak-admin.png`	182.10 KB	142.37 KB	-21.8%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-11-palette-sso.png`	656.85 KB	439.82 KB	-33.0%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-14-palette-groups.png`	124.11 KB	90.28 KB	-27.3%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-15-palette-project.png`	150.37 KB	107.85 KB	-28.3%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-16-palette-sso-admins.png`	216.78 KB	155.66 KB	-28.2%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-17-keycloak-user.png`	187.39 KB	144.48 KB	-22.9%	View diff
`static/assets/docs/images/keycloak/user-management_saml-sso_keycloak-18-keycloak-password.png`	133.39 KB	98.38 KB	-26.2%	View diff

509 images did not require optimisation.

…keycloak-v2

github-actions · 2023-11-29T14:36:48Z

docs/docs-content/user-management/saml-sso/palette-sso-with-keycloak.md

+
+12. Click on **Save** to save the client configuration.
+
+  ![alt_text](/keycloak/user-management_saml-sso_keycloak-06-keycloak-callback.png "Keycloak callback")


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'alt_text'?

* docs: migrated keycloak and refactored * docs: removed unused images * Apply suggestions from code review Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> * docs: added vale rule for keycloak * Optimised images with calibre/image-actions --------- Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit 13521cd)

vault-token-factory-spectrocloud · 2023-11-29T14:49:06Z

💔 Some backports could not be created

Status	Branch	Result
✅	version-4-0
❌	version-3-4	Backport failed because of merge conflicts
✅	version-4-1

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 1839

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

* docs: migrated keycloak and refactored * docs: removed unused images * Apply suggestions from code review Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> * docs: added vale rule for keycloak * Optimised images with calibre/image-actions --------- Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit 13521cd) Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: migrated keycloak and refactored * docs: removed unused images * Apply suggestions from code review Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> * docs: added vale rule for keycloak * Optimised images with calibre/image-actions --------- Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

karl-cardenas-coding added 2 commits November 22, 2023 16:45

docs: migrated keycloak and refactored

371ecef

docs: removed unused images

3447788

karl-cardenas-coding mentioned this pull request Nov 22, 2023

adding Keycloak to SSO guides #1383

Closed

karl-cardenas-coding added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-1 Backport change to version 4.1 labels Nov 22, 2023

lennessyy approved these changes Nov 27, 2023

View reviewed changes

karl-cardenas-coding and others added 2 commits November 28, 2023 15:56

Apply suggestions from code review

dbec4bd

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

Merge branch 'master' into keycloak-v2

e45cefd

karl-cardenas-coding marked this pull request as ready for review November 28, 2023 23:48

karl-cardenas-coding requested a review from a team as a code owner November 28, 2023 23:48

karl-cardenas-coding requested review from addetz, caroldelwing and ritawatson November 28, 2023 23:48

github-actions bot reviewed Nov 28, 2023

View reviewed changes

karl-cardenas-coding added 3 commits November 28, 2023 17:34

Merge branch 'master' of github.com:spectrocloud/librarium into keycl…

6ae7cc5

…oak-v2

Merge branch 'keycloak-v2' of github.com:spectrocloud/librarium into …

72eba20

…keycloak-v2

docs: added vale rule for keycloak

bd2282e

github-actions bot reviewed Nov 29, 2023

View reviewed changes

Optimised images with calibre/image-actions

5215981

karl-cardenas-coding added 2 commits November 29, 2023 07:35

docs: vale feedback

2626763

Merge branch 'keycloak-v2' of github.com:spectrocloud/librarium into …

eff4170

…keycloak-v2

karl-cardenas-coding enabled auto-merge (squash) November 29, 2023 14:36

github-actions bot reviewed Nov 29, 2023

View reviewed changes

karl-cardenas-coding merged commit 13521cd into master Nov 29, 2023
10 checks passed

karl-cardenas-coding deleted the keycloak-v2 branch November 29, 2023 14:48

vault-token-factory-spectrocloud bot mentioned this pull request Nov 29, 2023

[version-4-0] docs: added keycloak How-to (#1839) #1851

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Nov 29, 2023

[version-4-1] docs: added keycloak How-to (#1839) #1852

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Dec 22, 2023

Provide missing Autocale information #1857

Merged

vault-token-factory-spectrocloud bot mentioned this pull request Feb 16, 2024

Update Vale to accept PCGs, vCPU, and vCPUs #2246

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Keycloak How-to #1839

Keycloak How-to #1839

karl-cardenas-coding commented Nov 22, 2023 •

edited

Loading

netlify bot commented Nov 22, 2023 •

edited

Loading

lennessyy left a comment

github-actions bot left a comment

github-actions bot Nov 28, 2023

github-actions bot Nov 28, 2023

github-actions bot Nov 28, 2023

github-actions bot Nov 28, 2023

github-actions bot Nov 28, 2023

github-actions bot Nov 28, 2023

github-actions bot Nov 28, 2023

github-actions bot Nov 28, 2023

github-actions bot Nov 28, 2023

github-actions bot Nov 28, 2023

github-actions bot Nov 29, 2023

github-actions bot commented Nov 29, 2023

github-actions bot Nov 29, 2023

vault-token-factory-spectrocloud bot commented Nov 29, 2023

		@@ -36,3 +36,6 @@ Enable SSO by following our [Enable SSO in Palette](enable-saml.md) guide.


		- [Palette SSO with Okta SAML](palette-sso-with-okta-saml.md)


		- [Palette SSO with Keycloak](palette-sso-with-keycloak.md)

		---


		Keycloak is an open-source Identity and Access Management (IAM) tool, primarily used for simplifying the authentication and authorization processes in modern applications and services. It provides a wide range of features including Single Sign-On (SSO), two-factor authentication, and social login capabilities. Keycloak is designed to manage users, credentials, roles, and groups efficiently, enabling developers to secure their applications and services with minimal additional coding. Keycloak supports various industry-standard protocols like OpenID Connect, OAuth 2.0, and SAML 2.0, facilitating integration with a multitude of platforms and services.

		Keycloak is an open-source Identity and Access Management (IAM) tool, primarily used for simplifying the authentication and authorization processes in modern applications and services. It provides a wide range of features including Single Sign-On (SSO), two-factor authentication, and social login capabilities. Keycloak is designed to manage users, credentials, roles, and groups efficiently, enabling developers to secure their applications and services with minimal additional coding. Keycloak supports various industry-standard protocols like OpenID Connect, OAuth 2.0, and SAML 2.0, facilitating integration with a multitude of platforms and services.


		You can integrate Keycloak with Palette to enable SSO for your users. This guide will walk you through the steps to set up Keycloak as an OIDC provider for Palette.

		![alt_text](/keycloak/user-management_saml-sso_keycloak-10-keycloak-admin.png "Keycloak Admin")


		You have now configured SSO for Palette with Keycloak. You can now log in to Palette using the admin user you created in Keycloak. Use the validation steps below to validate the SSO configuration. Check out the [Create a Team](#create-a-team) section to learn how to create a team and assign roles to users.


		1. Log out of Palette. Click on the top right User Menu and select Log out.

		2. Sign in to Palette using the admin user you created in Keycloak. You will be redirected to the Keycloak login page. Enter the credentials for the admin user you created in Keycloak.


		![Keycloak Admin console](/keycloak//user-management_palette-rback_keycloak_login.png)

		3. Upon successful authentication, you will be redirected to Palette. You will be logged in to Palette as the admin user you created in Keycloak.


		## Create a Team

		1. Log in to Palette as a Tenant Admin. Navigate to the left Main Menu and select Users & Teams. Click on the Teams tab to access the Teams page. Click on the Create Team button to create a new team.

		2. Provide a team name, such as `admins` but leave the Members field empty. Click on Confirm to create the team.


		3. Next, select the admins row to access the team settings page. Click on New Project Role and asdd the Project Admin role to the Default project. Click on Confirm to save the changes.


		- [Keycloak Documentation](https://www.keycloak.org/documentation)

		- [Keycloak Quickstarts](https://www.keycloak.org/getting-started/getting-started-kube)


		12. Click on Save to save the client configuration.

		![alt_text](/keycloak/user-management_saml-sso_keycloak-06-keycloak-callback.png "Keycloak callback")

Keycloak How-to #1839

Keycloak How-to #1839

Conversation

karl-cardenas-coding commented Nov 22, 2023 • edited Loading

Describe the Change

Review Changes

netlify bot commented Nov 22, 2023 • edited Loading

✅ Deploy Preview for docs-spectrocloud ready!

lennessyy left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 28, 2023

Choose a reason for hiding this comment

github-actions bot Nov 29, 2023

Choose a reason for hiding this comment

github-actions bot commented Nov 29, 2023

github-actions bot Nov 29, 2023

Choose a reason for hiding this comment

vault-token-factory-spectrocloud bot commented Nov 29, 2023

💔 Some backports could not be created

Manual backport

Questions ?

karl-cardenas-coding commented Nov 22, 2023 •

edited

Loading

netlify bot commented Nov 22, 2023 •

edited

Loading