Skip to content

Commit 80be58a

Browse files
committed
Roles, Personas, Users, and Permissions (MTV 7.1; mta-documentation rep)o
1 parent eaf76d3 commit 80be58a

File tree

2 files changed

+76
-24
lines changed

2 files changed

+76
-24
lines changed

docs/topics/mta-7-installing-web-console-on-openshift.adoc

Lines changed: 72 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * docs/web-console-guide/master.adoc
44

5-
:_content-type: PROCEDURE
5+
:_mod-docs-content-type: PROCEDURE
66
[id="mta-7-installing-web-console-on-openshift_{context}"]
77

88
= Installing the {ProductName} {WebName}
@@ -16,7 +16,7 @@ The {ProductShortName} Operator is a structural layer that manages resources dep
1616
[id="openshift-persistent-volume-requirements_{context}"]
1717
== Persistent volume requirements
1818

19-
To successfully deploy, the {ProductShortName} Operator requires 3 RWO persistent volumes (PVs) used by different components. If the `rwx_supported` configuration option is set to `true`, the {ProductShortName} Operator requires an additional 2 RWX PVs that are used by Maven and the hub file storage. The PVs are described in the table below:
19+
To successfully deploy, the {ProductShortName} Operator requires 2 RWO persistent volumes (PVs) used by different components. If the `rwx_supported` configuration option is set to `true`, the {ProductShortName} Operator requires an additional 2 RWX PVs that are used by Maven and the hub file storage. The PVs are described in the following table:
2020

2121
.Required persistent volumes
2222
[cols="25%,25%,25%,25%", options="header"]
@@ -41,17 +41,13 @@ To successfully deploy, the {ProductShortName} Operator requires 3 RWO persisten
4141
|RWO
4242
|Keycloak back end database
4343

44-
|`pathfinder postgresql`
45-
|1 GiB
46-
|RWO
47-
|Pathfinder back end database
48-
4944
|`cache`
5045
|100 GiB
5146
|RWX
5247
|Maven m2 cache; required if the `rwx_supported` configuration option is set to `true`
5348
|====
5449

50+
[id="installing-mta-operator-and-ui_{context}"]
5551
== Installing the {ProductName} Operator and the {WebName}
5652

5753
You can install the {ProductName} ({ProductShortName}) and the {WebName} on Red Hat OpenShift versions 4.13-4.15.
@@ -210,6 +206,7 @@ mirror:
210206
helm: {}
211207
----
212208

209+
[id="memory-requirements-mta-openshift-local_{context}"]
213210
== Memory requirements for running {ProductShortName} on Red Hat OpenShift Local
214211

215212
When installed on https://developers.redhat.com/products/openshift-local/overview[Red Hat OpenShift Local], {ProductShortName} requires a minimum amount of memory to complete its analysis. Adding memory makes the analysis process run faster. The table below describes the {ProductShortName} performance with varying amounts of memory.
@@ -220,7 +217,6 @@ When installed on https://developers.redhat.com/products/openshift-local/overvie
220217
|Memory (GiB)
221218
|Description
222219

223-
224220
|`10`
225221
|{ProductShortName} cannot run the analysis due to insufficient memory
226222

@@ -264,25 +260,81 @@ To prevent out-of-memory events and protect nodes, use the `--eviction-hard` set
264260

265261
The amount of memory available for running pods on this node is 28.9 GiB. This amount is calculated by subtracting the `system-reserved` and `eviction-hard` values from the overall capacity of the node. If the memory usage exceeds this amount, the node starts evicting pods.
266262

267-
263+
[id="rhsso-overview-mta_{context}"]
268264
== Red Hat Single Sign-On
269-
{ProductShortName} delegates authentication and authorization to a
270-
https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6[Red
271-
Hat Single Sign-On] (RHSSO) instance managed by the {ProductShortName} operator. Aside from controlling the full lifecycle of the managed RHSSO instance, the {ProductShortName} operator also manages the configuration of a dedicated
272-
https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/configuring_realms[realm] that contains all the roles and permissions that {ProductShortName} requires.
265+
{ProductShortName} delegates authentication and authorization to a https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6[Red Hat Single Sign-On] (RHSSO) instance managed by the {ProductShortName} operator. Aside from controlling the full lifecycle of the managed RHSSO instance, the {ProductShortName} operator also manages the configuration of a dedicated https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/configuring_realms[realm] that contains all the roles and permissions that {ProductShortName} requires.
273266

274-
If an advanced configuration is required in the {ProductShortName} managed RHSSO instance, such as https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/user-storage-federation#adding_a_provider[adding
275-
a provider for User Federation] or https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/identity_broker[integrating
276-
identity providers], users can log into the RHSSO https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/configuring_realms#using_the_admin_console[Admin
277-
Console] through the `/auth/admin` subpath in the `{LC_PSN}-ui` route. The admin credentials to access the {ProductShortName} managed RHSSO instance can be retrieved from the `credential-mta-rhsso` secret available in the namespace in which the {WebName} was installed.
267+
If an advanced configuration is required in the {ProductShortName} managed RHSSO instance, such as https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/user-storage-federation#adding_a_provider[adding a provider for User Federation] or https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/identity_broker[integrating identity providers], users can log into the RHSSO https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/configuring_realms#using_the_admin_console[Admin Console] through the `/auth/admin` subpath in the `{LC_PSN}-ui` route. The admin credentials to access the {ProductShortName} managed RHSSO instance can be retrieved from the `credential-mta-rhsso` secret available in the namespace in which the {WebName} was installed.
278268

279269
A dedicated route for the {ProductShortName} managed RHSSO instance can be created by setting the `rhsso_external_access` parameter to `True` in the *Tackle CR* that manages the {ProductShortName} instance.
280270

281271
For more information, see
282-
https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/red_hat_single_sign_on_features_and_concepts[Red
283-
Hat Single Sign-On features and concepts].
272+
https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/red_hat_single_sign_on_features_and_concepts[Red Hat Single Sign-On features and concepts].
273+
274+
275+
[id="mta-roles-personas-users-permissions_{context}"]
276+
=== Roles, Personas, Users, and Permissions
277+
278+
{ProductShortName} makes use of three roles, each of which corresponds to a persona:
279+
280+
.Roles and personas
281+
[cols="50%,50%", options="header"]
282+
|====
283+
|Role
284+
|Persona
285+
286+
|`tackle-admin`
287+
|Administrator
288+
289+
|`tackle-architect`
290+
|Architect
291+
292+
|`tackle-migrator`
293+
|Migrator
294+
|====
295+
296+
The roles are already defined in your RHSSO instance. You do not need to create them.
297+
298+
If you are an {ProductShortName} administrator, you can create users in your RHSSO and assign each user one or more roles, one role per persona.
299+
300+
[id="mta-roles-personas-ui-views_{context}"]
301+
==== Roles, personas, and access to {WebName} views
302+
303+
Although a user can have more than one role, each role corresponds to a specific persona:
304+
305+
* Administrator: An administrator has all the permissions that architects and migrators have, along with the ability to create some application-wide configuration parameters that other users can consume but cannot change or view. Examples: Git credentials, Maven `settings.xml` files.
306+
307+
* Architect: A technical lead for the migration project who can run assessments and can create and modify applications and information related to them. An architect cannot modify or delete sensitive information, but can consume it. Example: Associate an existing credential to the repository of a specific application.
308+
309+
* Migrator: A user who can analyze applications, but not create, modify, or delete them.
310+
311+
As described in xref:mta-ui-interface-views[User interface views], {ProductShortName} has two views, *Administration* and *Migration*.
312+
313+
Only administrators can access *Administration* view. Architects and migrators have no access to *Administration* view, they cannot even see it.
314+
315+
Administrators can perform all actions supported by *Migration* view. Architects and migrators can see all elements of *Migration* view, but their ability to perform actions in *Migration* view depends on the permissions granted to their role.
316+
317+
The ability of administrators, architects, and migrators to access the *Administration* and *Migration* views of the {ProductShortName} {WebName} is summarized in the table below:
318+
319+
.Roles vs. access to {ProductShortName} views
320+
[cols=",,,",options="header",]
321+
|===
322+
|Menu
323+
|Architect
324+
|Migrator
325+
|Admin
326+
|Administration
327+
|No
328+
|No
329+
|Yes
330+
|Migration
331+
|Yes
332+
|Yes
333+
|Yes
334+
|===
284335

285-
=== Roles and Permissions
336+
[id="mta-roles-permissions_{context}"]
337+
==== Roles and permissions
286338

287339
The following table contains the roles and permissions (scopes) that {ProductShortName} seeds the managed RHSSO instance with:
288340

docs/web-console-guide/master.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ include::topics/templates/document-attributes.adoc[]
1313
//Inclusive language statement
1414
include::topics/making-open-source-more-inclusive.adoc[leveloffset=+1]
1515

16-
[id="mta-6-ui-guide-introduction"]
16+
[id="mta-ui-guide-introduction"]
1717
== Introduction
1818

1919
// About the {WebConsoleBookName}
@@ -25,17 +25,17 @@ include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+2]
2525
// About the {WebName}
2626
include::topics/about-the-user-interface.adoc[leveloffset=+2]]
2727

28-
[id=mta-6-ui-interface-views]
28+
[id=mta-ui-interface-views]
2929
== User interface views
3030

3131
The {ProductName} ({ProductShortName}) {WebName} has two views:
3232

3333
* Administration view
3434
* Migration view
3535

36-
In *Administration* view, you configure the instance environment, working with credentials, repositories, HTTP and HTTPS proxy definitions, custom migration targets, and issue management.
36+
In *Administration* view, administrators can configure the instance environment, work with credentials and repositories, define HTTP and HTTPS proxies, specify custom migration targets, manage issues, and add custom assessment questionnaires.
3737

38-
In *Migration* view, you perform application assessments and analyses, review reports, and add applications for assessment and analysis.
38+
In *Migration* view, all authorized users can review reports, add applications for assessment and analysis. perform application assessments and analyses, create migration waves, view issues that could potentially impact migration, view the status of analysis and discovery tasks through Task Manager. The permissions of the different user roles -- administrators, architects, and migrators -- vary in this view.
3939

4040
// == Administration view
4141
// include::topics/mta-web-administration-view.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)