Bug 1319547

Summary: Automate the generation of the User and Administrator Roles
Product: Red Hat Enterprise Virtualization Manager Reporter: Megan Lewis <melewis>
Component: DocumentationAssignee: rhev-docs <rhev-docs>
Status: CLOSED NOTABUG QA Contact: rhev-docs <rhev-docs>
Severity: unspecified Docs Contact:
Priority: medium    
Version: unspecifiedCC: dpinkert, eedri, juan.hernandez, juwu, lbopf, lsurette, melewis, rbalakri, srevivo, ylavi
Target Milestone: ovirt-4.1.6Keywords: Triaged
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-02-26 00:50:46 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Docs RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Megan Lewis 2016-03-21 02:02:23 UTC
The tables in 1.1.2.2. User and Administrator Roles in the Admin Guide are missing many of the roles listed in RHEV. The tables need to be updated. The examples outlined in 1.1.1.3. User Role and Authorization Examples should also be reviewed to make sure they are still relevant. 

Link to the content: 
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html/Administration_Guide/chap-Administering_and_Maintaining_the_Red_Hat_Enterprise_Virtualization_Environment.html#sect-Roles

Comment 1 Megan Lewis 2016-04-07 04:25:46 UTC
I was chatting to David Pinkerton, a consultant who has been working on a detailed design doc for RHEV, and his customer has specifically requested these tables and that they be updated to reflect the current roles. He was able to find these tables in the 3.2 docs. 

He mentioned when he was looking for these tables in the 3.6 docs but was unable to find them. Perhaps it would be better to move this content from 1.1. Global Configuration to Chapter 13. Users and Roles?

Comment 2 Yaniv Lavi 2016-04-26 11:55:40 UTC
Why is looking in the UI not sufficient to get this info?

Comment 3 Megan Lewis 2016-04-28 06:19:23 UTC
Hi Yaniv, 

I'm following up with David as to what his customer was looking for by having the list of users and roles detailed in the docs. I'll let you know when he gets back to me. 

Megan

Comment 4 Yaniv Lavi 2016-04-28 06:47:19 UTC
Restoring the needinfo until the info is provided.

Comment 5 Megan Lewis 2016-05-05 04:38:54 UTC
Hey Yaniv, 

Sorry I didn't realise I removed the flag. 

David responded that this was a new installation for a customer with no previous RHEV experience and no access to the GUI. They requested the role information to assist in planning their roles out. 

Megan

Comment 6 Yaniv Lavi 2016-05-09 11:05:20 UTC
oVirt 4.0 Alpha has been released, moving to oVirt 4.0 Beta target.

Comment 10 Megan Lewis 2016-05-12 01:41:15 UTC
*** Bug 1300518 has been marked as a duplicate of this bug. ***

Comment 16 Juan Hernández 2016-11-07 09:50:30 UTC
The list of roles isn't fixed, so it can't be easily extracted from the source. It can be easily extracted from a live server, running a database query or using the API. With the API it would be something like this (using version 4 of the Python SDK):

  # Get the reference to the service that manages the roles:
  roles_service = connection.system_service().roles_service()

  # Retrieve the roles:
  roles = roles_service.list()

  # For each role print its name and description:
  for role in roles:
      print("%s: %s" % (role.name, role.description))

That would print something like this:

  SuperUser: Roles management administrator
  UserRole: Standard User Role
  PowerUserRole: User Role, allowed to create VMs, Templates and Disks
  ...

I am adding the complete example to the Python SDK (and to the other SDKs as well):

  Add example showing how to list system roles
  https://gerrit.ovirt.org/66130

Comment 17 Juan Hernández 2016-11-07 10:56:07 UTC
The complete example is here:

  https://github.com/oVirt/ovirt-engine-sdk/blob/master/sdk/examples/list_roles.py

Comment 18 Yaniv Lavi 2016-11-08 12:56:18 UTC
Eyal, can we get this list released with every new build, so we can update this in the docs continuously?

Comment 19 Eyal Edri 2016-11-08 13:56:23 UTC
reading comment #16 and especially "It can be easily extracted from a live server" I don't see how we can do it, builds don't install oVirt-engine and you don't have a live server you can extract it from.

You'll need probably a jenkins job running Lago from latest engine, extracts the relevant data from it and then publish it to a yum repo / web server so another script can take it from there.

Its not something trivial and we'll need to understand the whole flow before trying to implement something like it.