From 04400cd6b591d2496a64164dbf6946f11fd1623a Mon Sep 17 00:00:00 2001 From: hanancha Date: Mon, 30 Nov 2020 14:32:39 -0800 Subject: [PATCH 1/3] Updating rbac documentation --- docs/source/rbac.rst | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/docs/source/rbac.rst b/docs/source/rbac.rst index 455db467e..38ea9a58b 100644 --- a/docs/source/rbac.rst +++ b/docs/source/rbac.rst @@ -1,14 +1,6 @@ Role Based Access Control ========================= -.. note:: - - Prior to StackStorm 3.3, Extreme Networks provided a commercial version of the StackStorm automation platform which included Role Based Access Control (RBAC). - -Extreme Workflow Composer was donated to Linux Foundation, but those components are not yet integrated into the StackStorm release. Please visit https://stackstorm.com/2020/05/27/extreme-networks-donates-ewc-to-linux-foundation/ for more details. - - These components are NOT available in the StackStorm 3.3 release, but will be integrated into the community edition of StackStorm in future release(s). - Role Based Access Control (RBAC) allows system administrators to restrict users' access and limit the operations they can perform. For instance, you could give your database operator access only to the database-related actions. @@ -232,18 +224,13 @@ There are some exceptions, described below: Enabling RBAC ------------- -If you installed |ewc| using the :doc:`one-line install `, RBAC will be automatically -enabled. It will assign the ``admin`` role to ``stanley`` and ``st2admin``. - -If you installed |ewc| separately, by installing the ``bwc-enterprise`` package on top of |st2|, you -will need to manually enable RBAC, and assign ``admin`` privileges to ``stanley``. It is not -enabled by default. To enable it, add this section to ``/etc/st2/st2.conf``: +To enable rbac, add this section to ``/etc/st2/st2.conf``: .. code-block:: ini [rbac] enable = True - backend = enterprise + backend = default Run ``sudo st2ctl restart-component st2api`` to apply that change. From 3e99486b83bf3364d706f1fbe4da4919546e7885 Mon Sep 17 00:00:00 2001 From: hanancha Date: Wed, 2 Dec 2020 11:50:06 -0800 Subject: [PATCH 2/3] Updating rbac docs to include PR reviews. --- docs/source/rbac.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/source/rbac.rst b/docs/source/rbac.rst index 38ea9a58b..58ac7a41d 100644 --- a/docs/source/rbac.rst +++ b/docs/source/rbac.rst @@ -1,6 +1,12 @@ Role Based Access Control ========================= +.. note:: + + Prior to StackStorm 3.3, Extreme Networks provided a commercial version of the StackStorm automation + platform which included Role Based Access Control (RBAC). As these enterprise features were donated to + the Linux Foundation, RBAC is now available in StackStorm Open Source since 3.4. + Role Based Access Control (RBAC) allows system administrators to restrict users' access and limit the operations they can perform. For instance, you could give your database operator access only to the database-related actions. @@ -224,6 +230,9 @@ There are some exceptions, described below: Enabling RBAC ------------- +To configure RBAC you will need to manually enable it in ``st2.conf`` and assign ``admin`` privileges to default +user ``stanley``. + To enable rbac, add this section to ``/etc/st2/st2.conf``: .. code-block:: ini From e2144f2f8ea66a0f400be413266b6d3b4bc3ff8c Mon Sep 17 00:00:00 2001 From: armab Date: Thu, 3 Dec 2020 22:35:56 +0000 Subject: [PATCH 3/3] Add a link to RBAC Github source code repository --- docs/source/rbac.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/rbac.rst b/docs/source/rbac.rst index 58ac7a41d..530754f98 100644 --- a/docs/source/rbac.rst +++ b/docs/source/rbac.rst @@ -12,6 +12,7 @@ the operations they can perform. For instance, you could give your database oper to the database-related actions. Read through the detailed overview below, or jump straight to a :ref:`usage example `. +The source code for the RBAC module can be accessed at https://github.com/stackstorm/st2-rbac-backend. Terminology -----------