starlingx/docs
Code Issues Proposed changes

WRO: OpenStack Role Based Access Control (RBAC) enhancements

Browse Source 
Documentation about how to apply to RBAC policies in Openstack components

Solved merge conflict

Added missing command line, removed requested info and fixed typo

Added extra itens about transferring enhanced policies files from armada app.

Separated upstream-only content and proprietary content.

Reworded upstream content.

Fixed formatting issues.

Fixed typo.

Story 2008910
Task 42786

Signed-off-by: egoncalv <elisamaraaoki.goncalves@windriver.com>
Change-Id: I7c5e9788ac8418706719aac87351cbf02bb2b432
This commit is contained in:
egoncalv 2021-07-06 15:02:37 -03:00
parent 8112e2dc3b
commit 0a67ce8b12
3 changed files with 220 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/_includes/enhanced-rbac-policies.rest Normal file
View File

@ -0,0 +1,19 @@
.. tar-xvf-begin
.. tar-xvf-end
.. r1_begin
#. Download the openstack-armada repo from |prod| in opendev
(`https://opendev.org/starlingx/openstack-armada-app/src/branch/master
<https://opendev.org/starlingx/openstack-armada-app/src/branch/master>`__)
to a remote workstation.
#. Copy the contents of the 'enhanced-policies' folder from remote workstation
to controller.
.. code-block:: none
$ cd /home/sysadmin
$ scp -r <remote-workstation-with-download-of-openstack-armada-app-REPO>/enhanced-policies openstack-enhanced-policies-0.1.0
.. r1_end

199
doc/source/system_configuration/openstack/enhanced-rbac-policies.rst Normal file
View File

@ -0,0 +1,199 @@
.. _enhanced-rbac-policies:
======================
Enhanced RBAC Policies
======================
.. rubric:: |context|
The standard OpenStack RBAC roles and policies can be enhanced by updating
policy configuration in individual OpenStack Services' Helm charts. |prod|
provides an optional set of updated policy configurations for nova, neutron,
glance, cinder, keystone and horizon services that introduce two new roles
('project_admin' and 'project_readonly') and modify the capabilities of the
default 'member' role. A high-level summary of the new roles' capabilities and
the modified 'default' role capabilities are in the following table; a detailed
description is provided at end of page.
.. table::
:widths: auto
+------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| Design | Roles | Permissions summary |
+==================+==================+=============================================================================================================================================+
| Default Role: | member | Users with role 'member' can fully manage a subset of resources of the project |
+------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| New Role to add: | project_admin | Users with role 'project_admin' can fully manage all resources of the project |
+------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| New Role to add: | project_readonly | Users with role 'project_readonly' can only list and display details of resources of the project, and shared resources of other projects |
+------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
Make sure you have access to the |prod-os| |CLI| and follow the instructions in
this document.
.. rubric:: |proc|
#. Log into your active controller.
#. Set up admin credentials for the containerized OpenStack application:
.. code-block:: none
$ source /etc/platform/openrc
$ OS_AUTH_URL=http://keystone.openstack.svc.cluster.local/v3
#. Transfer the enhanced policies yml files to the active controller:
.. only:: partner
.. include:: /_includes/enhanced-rbac-policies.rest
:start-after: tar-xvf-begin
:end-before: tar-xvf-end
.. only:: starlingx
.. include:: /_includes/enhanced-rbac-policies.rest
:start-after: r1_begin
:end-before: r1_end
#. Create the custom roles:
.. code-block:: none
~(keystone_admin)]$ openstack role create project_admin
~(keystone_admin)]$ openstack role create project_readonly
#. In order to enable the extensions required for some of the neutron tests,
include the following configuration to the neutron Helm override yml file:
.. code-block:: none
cat <<EOF >neutron-extensions.yml
conf:
neutron:
DEFAULT:
service_plugins:
- router
- network_segment_range
- qos
- segments
- port_forwarding
- trunk
plugins:
ml2_conf:
ml2:
extension_drivers:
- port_security
- qos
openvswitch_agent:
agent:
extensions:
- qos
- port_forwarding
EOF
system helm-override-update --reuse-values --values=./neutron-extensions.yml |prefix|-openstack neutron openstack
#. Apply the policy overrides for each service to your cloud:
.. parsed-literal::
$ source /etc/platform/openrc
~(keystone_admin)]$ system helm-override-update --reuse-values --values=/home/sysadmin/openstack-enhanced-policies-0.1.0/keystone-policy-overrides.yml |prefix|-openstack keystone openstack
~(keystone_admin)]$ system helm-override-update --reuse-values --values=/home/sysadmin/openstack-enhanced-policies-0.1.0/cinder-policy-overrides.yml |prefix|-openstack cinder openstack
~(keystone_admin)]$ system helm-override-update --reuse-values --values=/home/sysadmin/openstack-enhanced-policies-0.1.0/nova-policy-overrides.yml |prefix|-openstack nova openstack
~(keystone_admin)]$ system helm-override-update --reuse-values --values=/home/sysadmin/openstack-enhanced-policies-0.1.0/neutron-policy-overrides.yml |prefix|-openstack neutron openstack
~(keystone_admin)]$ system helm-override-update --reuse-values --values=/home/sysadmin/openstack-enhanced-policies-0.1.0/glance-policy-overrides.yml |prefix|-openstack glance openstack
~(keystone_admin)]$ system helm-override-update --reuse-values --values=/home/sysadmin/openstack-enhanced-policies-0.1.0/horizon-policy-overrides.yml |prefix|-openstack horizon openstack
~(keystone_admin)]$ system application-apply |prefix|-openstack
#. Watch for application overrides to finish applying:
.. parsed-literal::
$ watch system application-show |prefix|-openstack
-------------
Running Tests
-------------
Please follow the instructions below to test the enhanced policies on your
system. We assume that the new roles were created on your system and the
overrides were successfully applied.
.. rubric:: |proc|
#. Change directory to the openstack-enhanced-policies-0.1.0 you transferred to
your controller node:
.. code-block:: none
$ cd /home/sysadmin/openstack-enhanced-policies-0.1.0
#. IMPORTANT: Create a venv and install the test dependencies:
.. code-block:: none
if [ ! -d .venv ]; then
python3 -m venv .venv
fi
$ source .venv/bin/activate
$ pip install --upgrade pip
$ pip install -r test-requirements.txt
#. Download CirrOS image (dependency for nova and cinder tests):
.. code-block:: none
$ wget http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img
#. Execute the tests on |prod|:
.. code-block:: none
$ source /etc/platform/openrc
$ OS_AUTH_URL=http://keystone.openstack.svc.cluster.local/v3
$ pytest tests/
------------------------
To cleanup after testing
------------------------
You can use the ``run-cleanup-all.sh`` script to remove any leftovers from the
test on the environment:
.. code-block:: none
$ source /etc/platform/openrc
$ OS_AUTH_URL=http://keystone.openstack.svc.cluster.local/v3
$ bash run-cleanup-all.sh
-----------------------
Role Permission Details
-----------------------
.. table::
:widths: auto
+-------------------+---------------------------------------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------+----------------------------------------------------------------+
| Role Permissions | identity(keystone) | compute(nova) | networking(neutron) | image(glance) | volume(cinder) |
+===================+===================================================+=======================================================+==================================================================================================+=======================================================+================================================================+
| member | All operations that legacy role 'member' can do | - Can get list and detail of instances | - Can only create/update/delete port | - Can create and update image, upload image content | - Can create volume |
| | | - Can create instance/Can open console of instance | - Can get list and detail of resources: subnetpool, address scope, networks, subnets, etc. | | - Can create volume from image |
| | | - Can access log of instance | | | - Can create volume snapshot |
| | | - Can access log of instance | | | - Can create volume-backup |
| | | - Can manage keypairs of his/her own | | | |
+-------------------+---------------------------------------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------+----------------------------------------------------------------+
| project_admin | All operations that legacy role 'member' can do | All operations that legacy role 'member' can do | - All operations that legacy role 'member' can do | - All operations that legacy role 'member' can do | - All operations that legacy role 'member' can do |
| | | | - Can create/update/delete 'shared' subnetpool | - Can publicize_image | |
| | | | - Can create/update/delete address scope | | |
| | | | - Can create/update/delete shared network | | |
+-------------------+---------------------------------------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------+----------------------------------------------------------------+
| project_readonly | All operations that legacy role 'member' can do | - Can only get list and detail of instances | - Can only get list and detail of resources: subnetpool, address scopes, networks, subnets,etc. | - Can only get list and detail of images | - Can only get list and detail of volumes, backups, snapshots |
| | | - Can manage key-pairs of his/her own | | | |
+-------------------+---------------------------------------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------+----------------------------------------------------------------+

3
doc/source/system_configuration/openstack/index.rst
View File

@ -23,6 +23,7 @@ Configure OpenStack Services Using Helm Chart Overrides
adding-configuration-rpc-response-max-timeout-in-neutron-conf
assigning-a-dedicated-vlan-id-to-a-target-project-network
customize-openstack-horizon-and-login-banner-branding
enhanced-rbac-policies
------
Cinder
@ -31,4 +32,4 @@ Cinder
.. toctree::
:maxdepth: 1
export-and-import-cinder-backups-to-ceph-pool
export-and-import-cinder-backups-to-ceph-pool