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.

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

Clarify how user search works #1525

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 9 additions & 1 deletion docs/how-to-guides/new-user-guides/add-users-to-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ Following project creation, you can add users as project members so that they ca
1. In the **Members** tab, click **Add**.
1. Search for the user or group that you want to add to the project.

:::note Notes:

- At least 2 characters must be typed in the search box for results to appear
- Users can be searched based on their username or display name
- Search is prefix-based (eg. a user named `Stan Dard` will appear when searching for `Sta`, but not when searching for `Dar`) and case-sensitive

:::

If external authentication is configured:

- Rancher returns users from your external authentication source as you type.
Expand Down Expand Up @@ -63,4 +71,4 @@ Following project creation, you can add users as project members so that they ca
**Result:** The chosen users are added to the project.

- To revoke project membership, select the user and click **Delete**. This action deletes membership, not the user.
- To modify a user's roles in the project, delete them from the project, and then re-add them with modified roles.
- To modify a user's roles in the project, delete them from the project, and then re-add them with modified roles.
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ Cluster administrators can edit the membership for a cluster, controlling which
1. In the **Member Roles** tab, click **Add Member**.
1. Search for the user or group that you want to add to the cluster.

:::note Notes:

- At least 2 characters must be typed in the search box for results to appear
- Users can be searched based on their username or display name
- Search is prefix-based (eg. a user named `Stan Dard` will appear when searching for `Sta`, but not when searching for `Dar`) and case-sensitive

:::

If external authentication is configured:

- Rancher returns users from your [external authentication](../../authentication-permissions-and-global-configuration/authentication-config/authentication-config.md) source as you type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,15 @@ By default, your user is added as the project `Owner`.
To add members:

1. In the **Members** tab, click **Add**.
1. From the **Select Member** field, search for a user or group that you want to assign project access. Note: You can only search for groups if external authentication is enabled.
1. From the **Select Member** field, search for a user or group that you want to assign project access. You can only search for groups if external authentication is enabled.

:::note Notes:

- At least 2 characters must be typed in the search box for results to appear
- Users can be searched based on their username or display name
- Search is prefix-based (eg. a user named `Stan Dard` will appear when searching for `Sta`, but not when searching for `Dar`) and case-sensitive

:::
1. In the **Project Permissions** section, choose a role. For more information, refer to the [documentation on project roles.](../authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md)

### 4. Optional: Add Resource Quotas
Expand Down