Skip to content

Commit

Permalink
docs: DOC-1462 DOC-1463 Docs Feedback (#4567)
Browse files Browse the repository at this point in the history
* docs: DOC-1462

* docs: DOC-1463

* chore: trigger ci
  • Loading branch information
karl-cardenas-coding authored Nov 4, 2024
1 parent c474c18 commit afdb1ae
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 48 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,106 +6,136 @@ hide_table_of_contents: false
tags: ["clusters", "cluster management", "filters"]
---

The page guides you on how to create a Palette Resource Filter and add these filters to the users to establish cluster
The page guides you on how to create a Resource Filter and how to add these filters to the users to establish cluster
access restrictions.

## Create Resource Filter

You must create a Resource Filter in Palette to establish user-based access restrictions to clusters across multiple
projects. The resource filters are created under the scope of Tenant Admin. To create a resource filter, follow the
steps below:
You must create a Resource Filter in Palette to establish user-based, or team-based access restrictions to clusters
across multiple projects. The resource filters are created under the scope of Tenant Admin. To create a resource filter,
follow the steps below.

<br />
### Prerequisites

- A [Palette account](https://console.spectrocloud.com) with Tenant scope privileges.

### Create Resource Filter

1. Log in to Palette as **Tenant Admin** and go to **Tenant Settings** from the left **Main Menu**.
1. Log in to Palette as **Tenant Admin**.

2. Select **Filters** tab and click **+New Resource Filter**.
2. Navigate to the left **Main Menu** and select **Tenant Settings**.

3. To the **Create New Filter** wizard give the following information:
3. From the **Tenant Settings Menu**, expand the **Platform Settings** and click on **Filters**.

- Filter Name: A custom name for the tag filter.
- A filter expression. Use the following table to familiarize yourself with the filter expression format:
4. Click on **+New Resource Filter**.

| Conjunction | Property | Operator | Tag-Value |
| ----------- | -------- | -------- | ---------------- |
| and | Tag | is | Custom tag value |
| or | Tag | is | Custom tag value |
| and | Tag | is not | Custom tag value |
| or | Tag | is not | Custom tag value |
5. Fill out the input fields in the **Create Resource Filter** wizard. Use the following table to understand the input
fields:

4. Click the **Confirm** button to complete the filter creation wizard.
- Filter Name: A custom name for the tag filter. Keep in mind the tags are case-sensitive.
- A filter expression. Use the following table to familiarize yourself with the filter expression format:

**Note:** The tags are case-sensitive.
| Conjunction | Property | Operator | Tag-Value |
| ----------- | -------- | -------- | ---------------- |
| and | Tag | is | Custom tag value |
| or | Tag | is | Custom tag value |
| and | Tag | is not | Custom tag value |
| or | Tag | is not | Custom tag value |

6. Click the **Confirm** button to complete the filter creation wizard.

### Validate

Upon creating a filter, a display message will pop up to confirm the successful creation of the tag. You can also use
the following steps to review the filter is available for use.

1. Navigate to the left **Main Menu** and click on **Tentant Settings**.
1. Log in to Palette as **Tenant Admin**.

2. Navigate to the left **Main Menu** and select **Tenant Settings**.

2. Access the **Manage Filters** page to find the filter name listed.
3. From the **Tenant Settings Menu**, expand the **Platform Settings** and click on **Filters**.

3. You can **Edit** and **Delete** filters by clicking on the **three-dot Menu** at the end of the row.
4. Locate the filter you created in the list of filters displayed.

## Add Resource Role

You can assign the resource filter created, in combination with roles, to a
[user](../../../user-management/new-user.md#create-a-new-user) to enforce access restriction. Palette provisions two
types of roles:
You can assign the created resource filter and roles to a user or team to enforce access restrictions. There are two
types of roles that can be assigned:

- [Palette Global Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#palette-global-resource-roles),
the set of roles that are available in Palette by default.
- [Palette Global Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#palette-global-resource-roles)
are a set of roles that are available in Palette by default.

- [Custom Resource Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#palette-custom-resource-roles),
can be generated according to your requirements from the available set of permissions and operations.
- [Custom Resource Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#palette-custom-resource-roles)
can be created according to your requirements from the available set of permissions and operations.

### Prerequisites

- A [Palette account](https://console.spectrocloud.com) with Tenant scope privileges.

* A [user created](../../../user-management/new-user.md#create-a-new-user) to assign the resource privileges.
- A Palette [user](../../../user-management/new-user.md#create-a-new-user) or team to assign the resource privileges.

### Assign Resource Roles and Filter

To assign the resource roles and filter to the user follow the below steps: <br />
To assign the resource roles and filter to the user follow the below steps.

1. Log in to Palette as Tenant Admin

2. Select the user to be assigned with a role from the **Users & Teams** from the left **Main Menu** to go to **User
Details**.
2. Navigate to the left **Main Menu** and click on **Users & Teams**.

3. From the user details wizard, select **Resource Roles** Tab and click **+ New Resource Role**.
3. Select the user or team to assign the role.

4. In the **Add Roles to User** wizard, enter the following details:
4. From the user details wizard, select **Resource Roles** tab and click **New Resource Role**.

5. In the **Add Roles to User** wizard, enter the following details:

- **Projects**: The projects to which the user is assigned.
- **Filers**: Select the filters to be assigned from the drop-down. The Filters created will be displayed in the
drop-down menu.
- Select the **check box** to assign the roles to the user from the list displayed. These are Palette built-in roles.
**drop-down Menu**.
- Select the check box to assign the roles to the user from the list displayed. The roles displayed are Palette built-in
roles.

5. Click **Confirm** to complete the Add Role wizard.

### Validate

Upon creating a filter, a display message will pop up to confirm the successful role assignment. You can also use the
following steps to review the roles created:

1. Navigate to the left **Main Menu** and click on **Clusters**.

2. This page will list all the clusters to which the user has access based on the filter created. You need to switch to
each project and review the accessible clusters.

## Remove or Edit the Role

You can remove or edit the roles assigned to the user or team from the **Resource Roles** tab in the **User Details**

### Prerequisites

- A [Palette account](https://console.spectrocloud.com) with Tenant scope privileges.

### Remove or Edit the Role

To remove or edit an attached role:

1. Log in to Palette as Tenant Admin

2. From the left **Main Menu** click on **Users & Teams**. This will take you to the **User Details** page.
2. Navigate to the left **Main Menu** and click on **Users & Teams**.

3. From the **Resource Roles** tab, click the **three-dot** menu towards the role name.
3. Click on the user or team to remove or edit the role.

4. Click **Edit** or **Remove** option from the drop-down menu.
4. From the **Resource Roles** tab, click the **three-dot Menu** towards the role name.

5. Click **Edit** or **Remove** option from the **drop-down Menu**.

### Validate

Upon creating a filter, a display message will pop up to confirm the successful role assignment. You can also use the
following steps to review the roles created:
1. Log in to Palette as Tenant Admin.

1. Navigate to the left **Main Menu** and click on **Clusters**.
2. Navigate to the left **Main Menu** and click on **Users & Teams**.

2. This page will list all the clusters to which the user has access based on the filter created. You need to switch to
each project and view the accessible clusters.
3. Click on the user or team to review the roles.

## Resource
4. From the **Resource Roles** tab, review the roles assigned to the user or team.

- [Create a New User](../../..//user-management/new-user.md#create-a-new-user)
5. Verify the role is removed or edited successfully.
4 changes: 2 additions & 2 deletions docs/docs-content/workspace/adding-a-new-workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ how a workspace can be created in the Palette console.

2. Associate Clusters

- Select the cluster(s) to be added to the workspace. (See [New Clusters](../clusters/clusters.md) to learn how to
add a new Cluster.) Palette clusters, as well as brownfield clusters, can be added to your workspace.
- Select the clusters to be added to the workspace. (See [New Clusters](../clusters/clusters.md) to learn how to add
a new Cluster.) Palette clusters, as well as brownfield clusters, can be added to your workspace.

- Configure the Cluster Role Binding (optional). Role bindings can be created on all workspace clusters.

Expand Down

0 comments on commit afdb1ae

Please sign in to comment.