-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document OIDC options for Spectro VM Dashboard: PEM-2283 (#1526)
* Drafted possible additions for OIDC, added links * Added 'Configure OIDC Options' * Removed extra breaks * Uncommented paragraph re OIDC roles * Revised a couple sentences. * Add desc of dshbrd access based on OIDC selection * Updated the doc description * Fixed slightly awk wording * Fixed URLs * Inserted an omitted word * Fix one more URL (cherry picked from commit a0e1f84)
- Loading branch information
1 parent
d2d99cf
commit 3c68f8b
Showing
5 changed files
with
69 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
docs/docs-content/vm-management/vm-packs-profiles/configure_OIDC.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
--- | ||
sidebar_label: "Configure OIDC" | ||
title: "Configure OIDC" | ||
description: "Learn how to configure OIDC so Palette displays the Virtual Machine Dashboard." | ||
icon: " " | ||
hide_table_of_contents: false | ||
sidebar_position: 15 | ||
tags: ["vmo", "oidc"] | ||
--- | ||
|
||
|
||
|
||
|
||
Palette displays the Virtual Machine dashboard based on the OpenID Connect (OIDC) Identity Provider option that you select in the Kubernetes layer of the infrastructure profile. | ||
|
||
|
||
## Prerequisites | ||
|
||
- A configured infrastructure profile. For more information, review [Create a Cluster Profile](../../cluster-profiles/task-define-profile.md). | ||
|
||
|
||
## Enable OIDC | ||
|
||
1. Log in to [Palette](https://console.spectrocloud.com/). | ||
|
||
2. From the left **Main Menu** click **Profiles**. | ||
|
||
3. Select the cluster profile to update. Palette displays profile details and the profile stack. | ||
|
||
4. Select the Kubernetes layer in the profile stack, and choose an OIDC Identity Provider option. Refer to [Configure OIDC Identify Provider](../../integrations/kubernetes.md#configure-oidc-identity-provider) to learn more about OIDC options. | ||
|
||
Selecting **None** or **Palette** will display the Virtual Machine dashboard in a tab. | ||
|
||
Selecting **Inherit from Tenant** or **Custom** will display a link to the dashboard on the cluster overview page. | ||
|
||
:::caution | ||
|
||
We do not recommend choosing **None** in a production environment, as it may disable authentication for add-ons that rely on OIDC. | ||
|
||
::: | ||
|
||
5. Click **Confirm Updates**. | ||
|
||
6. Save your changes. | ||
|
||
|
||
## Validate | ||
|
||
1. From the left **Main Menu** click **Profiles**. | ||
|
||
2. Select the cluster profile you updated. Palette displays profile details and the profile stack. | ||
|
||
3. Select the Kubernetes layer. Palette displays the OIDC Identity Provider you selected - either **None**, **Palette**, **Inherit from Tenant**, or **Custom**. | ||
|
||
|
||
## Next Steps | ||
|
||
You are now ready to create the VMO profile. Refer to [Create the VMO Profile](../vm-packs-profiles/create-vmo-profile.md) for guidance. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters