Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[version-4-5] docs: DOC-1588 (#5395) #5406

Merged
merged 1 commit into from
Jan 13, 2025
Merged

[version-4-5] docs: DOC-1588 (#5395) #5406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 0 additions & 128 deletions docs/docs-content/clusters/cluster-management/palette-webctl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,131 +68,3 @@ You can now issue kubectl commands against your host cluster.
### Validate

Verify you have access to your host cluster by issuing kubectl commands against it.

<!-- # Overview

Palette leverages Kubectl through an in-built command line interface for the users to communicate with their workload clusters. This enables our users to deploy applications, inspect and manage cluster resources, and view logs using the Palette terminal without an external terminal.

# Usage Scenarios

* Cluster Access
* Cluster access with OIDC Authentication enabled
* Cluster access with Spectro Proxy
* CLI-Based Cluster Access

## Cluster Access

For general scenario, a user can connect to the cluster directly as below:

<br/>

1. Launch a cluster from the `Project Admin` Console.


2. Go the the `Cluster Details` page


3. Click the `Connect` button available at the `Kubernetes Config File.`


4. Wait for the terminal to be launched and start communicating to the cluster using the `kubectl` commands.


## Cluster Access with OIDC Authentication Enabled

Cluster access with OIDC authentication enables the clients to verify the end user's identity before establishing cluster connectivity. The user needs to establish an OIDC-based authentication to the cluster through an identity provider of their choice. To establish cluster access with OIDC authentication, follow the steps below:

<br/>

1. Connfigure the OIDC provider callback or redirect url to use the following URL: `https://console.spectrocloud.com/v1/shelly/oidc/callback`


2. Launch a cluster from the **Project** scope and enable cluster OIDC.

**Note:** To enable OIDC, the user can use the Spectro RBAC Add-on or the Kubernetes YAML file.


3. Go the the **Cluster Details** page.


4. Click the **Connect** button by the **Kubernetes Config File**


5. Wait for the terminal to be launched.


6. Once the terminal is launched, give a kubectl command to obtain the console endpoint.


7. Copy the endpoint on the terminal, open a browser window, and provide your OIDC credentials.


8. After successful login to the page, get back to the terminal and start communicating to the cluster using the `kubectl` commands.

## Cluster Access with Spectro Proxy

Palette users can attach [Spectro Proxy](/integrations/frp/) pack to the cluster profile while profile creation. This installs the FRP client to the workload clusters and configures it with an FRP server to establish external connectivity for private clusters. To establish cluster access with Spectro Proxy (Forward Reverse Proxy), follow the steps below:

<br/>

1. Launch a cluster from the ‘Project Admin’ Console.
**Note:** The cluster profile must have an attached Spectro Proxy add-on pack.


2. Go the the `Cluster Details` page.


3. Click the ‘Connect’ button at the ‘Kubernetes Config File.’


4. Wait for the terminal to be launched.


5. Once the terminal launch, give the following command:

```
kubectl config set-cluster <CLUSTER_NAME> --insecure-skip-tls-verify=true
```


6. This establishes the connectivity between the workload cluster and external API. Now the user can start communicating to the cluster using the ‘kubectl’ commands.

:::info

While creating EKS clusters with a **Private** endpoint, adding a proxy pack is mandatory for establishing Palette Web kubectl connectivity.

:::


## CLI-Based Cluster Access

The users can establish connectivity for public clusters via the public cloud CLI. To establish the CLI-based cluster access, follow the steps below:

<br />

1. Launch a cluster from the `Project Administrator` Console.


2. Go the the `Cluster Details` page.


3. Click the `Connect` button available at the `Kubernetes Config File.`


4. Wait for the terminal to be launched. Once the terminal is launched, configure the `Public Cloud CLI`.

**Example:**
For AWS clusters, the CLI can be configured using the below command and authenticate using the AWS console credentials like Access key and Secret key.

<br />

```
aws configure
```


5. Once the configuration is done, start communicating to the cluster using the ‘kubectl’ commands.



-->
9 changes: 4 additions & 5 deletions docs/docs-content/user-management/saml-sso/palette-sso-with-adfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,10 @@ standard that Palette employs. You can only use the OIDC-based approach for Micr
9. These two redirect URIs are required for SSO to work with Palette. You can also add additional redirect URIs. The
URIs in the table below are useful when you want to use AD FS for OIDC authentication into your Kubernetes clusters.

| URL | Type of Access |
| ---------------------------------------------------------- | ----------------------------------------------------------- |
| `http://localhost:8000` | Using kubectl with the kube-login plugin from a workstation |
| `https://console.spectrocloud.com/v1/shelly/oidc/callback` | Using the web-based kubectl console |
| `https://<fqdn_of_k8s_dashboard>/oauth/callback` | Using OIDC authentication into Kubernetes Dashboard |
| URL | Type of Access |
| ------------------------------------------------ | ----------------------------------------------------------- |
| `http://localhost:8000` | Using kubectl with the kube-login plugin from a workstation |
| `https://<fqdn_of_k8s_dashboard>/oauth/callback` | Using OIDC authentication into Kubernetes Dashboard |

10. When you have completed entering redirect URIs, click **Next**. On the next page of the wizard, select **Generate a
shared secret** and click **Copy to clipboard** to copy the secret value and save it somewhere. You will need to
Expand Down
9 changes: 4 additions & 5 deletions docs/docs-content/user-management/saml-sso/palette-sso-with-okta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,10 @@ The following steps will guide you on how to enable Palette SSO with
8. These two redirect URIs are required for SSO to work with Palette. You can also add additional redirect URIs. The
URIs in the table below are useful when you want to use Okta for OIDC authentication into your Kubernetes clusters.

| URL | Type of Access |
| ---------------------------------------------------------- | ------------------------------------------------------------ |
| `http://localhost:8000` | Using kubectl with the kube-login plugin from a workstation. |
| `https://console.spectrocloud.com/v1/shelly/oidc/callback` | Using the web-based kubectl console. |
| `https://<fqdn_of_k8s_dashboard>/oauth/callback` | Using OIDC authentication into Kubernetes Dashboard. |
| URL | Type of Access |
| ------------------------------------------------ | ------------------------------------------------------------ |
| `http://localhost:8000` | Using kubectl with the kube-login plugin from a workstation. |
| `https://<fqdn_of_k8s_dashboard>/oauth/callback` | Using OIDC authentication into Kubernetes Dashboard. |

9. When you have completed entering redirect URIs, scroll down to the **Assignments** section and section and select
**Allow everyone in your organization to access**. Leave the **Enable immediate access with Federation Broker Mode**
Expand Down
Loading