Skip to content

Commit

Permalink
docs: add EditorRestricted role release note (#9007)
Browse files Browse the repository at this point in the history
  • Loading branch information
amandavialva01 authored Mar 15, 2024
1 parent f52f43b commit bc1b431
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/manage/security/rbac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,12 @@ edit, or delete projects and experiments within its scope.
The ``Editor`` role supersedes the ``EditorRestricted`` role and includes permissions to create or
update NTSC tasks within its scope.

- ``EditorRestricted`` users can still open and use scoped JupyterLab notebooks and perform all
experiment-related jobs, just like those with the ``Editor`` role. The only additional
permissions granted by the ``Editor`` role include the ability to create notebooks, TensorBoards,
shells, and commands (NTSC tasks), as well as the permission to update these tasks, such as
changing the task's priority or deleting it.

``WorkspaceAdmin``
==================

Expand Down
22 changes: 22 additions & 0 deletions docs/release-notes/editor-restricted-role.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
:orphan:

**New Features**

- RBAC: Add a pre-canned role called ``EditorRestricted`` which supersedes the ``Viewer`` role and
precedes the ``Editor`` role.

- Like the ``Editor`` role, the ``EditorRestricted`` role grants the permissions to create,
edit, or delete projects and experiments within its designated scope. However, the
``EditorRestricted`` role lacks the permissions to create or update NTSC-type workloads.

Therefore, a user with ``EditorRestricted`` privileges in a given scope is limited when using
the WebUI within that scope since the option to launch JupyterLab notebooks and kill running
tasks will be unavailable. The user will also be unable to run CLI commands that create scoped
notebooks, TensorBoards, shells, and commands and will be unable to perform updates on these
tasks (such as changing the task's priority or deleting it). ``EditorRestricted`` users can
still open and use scoped JupyterLab notebooks and perform all experiment-related jobs, just
like those with the ``Editor`` role.

- The ``EditorRestricted`` role allows workspace and cluster editors and admins to have more
fine-grained control over GPU resources. Thus, users with this role lack the ability to launch
or modify tasks that indefinitely consume slot-requesting resources within a given scope.

0 comments on commit bc1b431

Please sign in to comment.