Update Requirements, Design and Approach authored by Sourabh Roy's avatar Sourabh Roy
...@@ -58,20 +58,20 @@ Discussions with various Module Owners and CSP is in progress and below requirem ...@@ -58,20 +58,20 @@ Discussions with various Module Owners and CSP is in progress and below requirem
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; a. OSDU Admin UI App – The frontend application development in development scope. This is planned to be developed in Angular 9. Anything other than this block in the below diagram is assumed to be shared to development team.<br/> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; a. OSDU Admin UI App – The frontend application development in development scope. This is planned to be developed in Angular 9. Anything other than this block in the below diagram is assumed to be shared to development team.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;b. OSDU Instance Identity Provider – This is the Identity provider which will be used for authentication. The details of the IDP will need to be shared with the development team for initial configuration<br/> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;b. OSDU Instance Identity Provider – This is the Identity provider which will be used for authentication. The details of the IDP will need to be shared with the development team for initial configuration<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;c. User Identity is the User email and authorization token which will be passed as header information for invoking any <br/> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;c. User Identity is the User email and authorization token which will be passed as header information for invoking any <br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;d. OSDU Platform API Management – It is the cloud specific API Management Gateway which will provide REST endpoints to Admin UI Apps. This will internally get data from “OSDU Data Platform” by internally validating user authorization (entitlements) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;d. OSDU Platform API Management – It is the cloud specific API Management Gateway which will provide REST endpoints to Admin UI Apps. This will internally get data from “OSDU Data Platform” by internally validating user authorization (entitlements)<br/>
![img1](uploads/f57ffc9192deb65204c336c8afdfe4cf/img1.png) ![img1](uploads/f57ffc9192deb65204c336c8afdfe4cf/img1.png)
3. Below is a representation of high-level flow integration of OSDU Admin UI Application: 3. Below is a representation of high-level flow integration of OSDU Admin UI Application:
![img2](uploads/bc7a269dcd217fd03e702c96e86237a7/img2.png) ![img2](uploads/bc7a269dcd217fd03e702c96e86237a7/img2.png)
4. During the initial setup of OSDU instance, a super user is added to various groups. This superuser will be responsible for configuring the groups access to various other users using Admin UI Application. The entitlements API’s will be used to manage users and groups mapping <br/> 4. During the initial setup of OSDU instance, a super user is added to various groups. This superuser will be responsible for configuring the groups access to various other users using Admin UI Application. The entitlements API’s will be used to manage users and groups mapping <br/>
5. Below is a prototype screen of how the initial landing page will look like: 5. Below is a prototype screen of how the initial landing page will look like: <br/>
![img3](uploads/de46ea425834a41a9728f3f19f156fb6/img3.png)<br/> ![img3](uploads/de46ea425834a41a9728f3f19f156fb6/img3.png)<br/>
<b>6. Manage Users</b><br/> <b>6. Manage Users</b><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Below is a prototype screen of how the E&O manage users/groups page will look like: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Below is a prototype screen of how the E&O manage users/groups page will look like: <br/>
![manage_users](uploads/0831139749e8c7ebb6538b10c6258325/manage_users.jpg) ![manage_users](uploads/0831139749e8c7ebb6538b10c6258325/manage_users.jpg)
<ul> <li>User with Owner role will be able to add a member and delete a member from his group</li> <li>Owner can also decide the permission of member that is going to be added in that group</li> <li>All the logged in users irrespective of their role will be able to view the members of their group</li> <li>Search functionality is also provided to users to ease their work</li> </ul> <ul> <li>User with Owner role will be able to add a member and delete a member from his group</li> <li>Owner can also decide the permission of member that is going to be added in that group</li> <li>All the logged in users irrespective of their role will be able to view the members of their group</li> <li>Search functionality is also provided to users to ease their work</li> </ul>
<b>6. Manage Groups </b><br/> <b>6. Manage Groups </b><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Below is a prototype screen of how the E&O manage groups page will look like: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Below is a prototype screen of how the E&O manage groups page will look like:<br/><br/>
![manage_groups](uploads/cb487a51d99f43afb4df930d369f4c32/manage_groups.jpg) ![manage_groups](uploads/cb487a51d99f43afb4df930d369f4c32/manage_groups.jpg)<br/>
<ul> <li>User with Owner role and Admin or Creator permission will be able to create a group and can also delete a group</li> <li>User with Owner role and Viewer permission can only view the list of groups and member inside a group</li> <li>Search functionality is also provided to users to easily search a group or user</li> </ul> <ul> <li>User with Owner role and Admin or Creator permission will be able to create a group and can also delete a group</li> <li>User with Owner role and Viewer permission can only view the list of groups and member inside a group</li> <li>Search functionality is also provided to users to easily search a group or user</li> </ul>
<h2>4. Admin Application Deployment Approach</h2> <h2>4. Admin Application Deployment Approach</h2>
<p>Deployment approach is yet to be finalized. A few options discussed are as below:</p> <p>Deployment approach is yet to be finalized. A few options discussed are as below:</p>
... ...
......