Skip to content

Commit fd0af6d

Browse files
RichardHochanarnold97
authored andcommitted
Roles, Personas, Users, and Permissions (MTV 7.1; mta-documentation rep)o
1 parent 8d3ac97 commit fd0af6d

File tree

2 files changed

+74
-18
lines changed

2 files changed

+74
-18
lines changed

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

Lines changed: 70 additions & 14 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}
@@ -19,7 +19,7 @@ The {ProductShortName} Operator is a structural layer that manages resources dep
1919
[id="openshift-persistent-volume-requirements_{context}"]
2020
== Persistent volume requirements
2121

22-
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:
22+
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:
2323

2424
.Required persistent volumes
2525
[cols="25%,25%,25%,25%", options="header"]
@@ -44,17 +44,13 @@ To successfully deploy, the {ProductShortName} Operator requires 3 RWO persisten
4444
|RWO
4545
|Keycloak back end database
4646

47-
|`pathfinder postgresql`
48-
|1 GiB
49-
|RWO
50-
|Pathfinder back end database
51-
5247
|`cache`
5348
|100 GiB
5449
|RWX
5550
|Maven m2 cache; required if the `rwx_supported` configuration option is set to `true`
5651
|====
5752

53+
[id="installing-mta-operator-and-ui_{context}"]
5854
== Installing the {ProductName} Operator and the {WebName}
5955

6056
You can install the {ProductName} ({ProductShortName}) and the {WebName} on Red Hat OpenShift versions 4.13-4.15.
@@ -215,6 +211,7 @@ mirror:
215211
helm: {}
216212
----
217213

214+
218215
[id="eviction-threshold_{context}"]
219216
=== Eviction threshold
220217

@@ -232,6 +229,7 @@ To prevent out-of-memory events and protect nodes, use the `--eviction-hard` set
232229

233230
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.
234231

232+
235233
[id="mta-7-red-hat-single-sign-on_{context}"]
236234
== Red Hat Single Sign-On
237235

@@ -240,18 +238,76 @@ https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6[Red
240238
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
241239
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.
242240

243-
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
244-
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
245-
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
246-
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.
241+
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.
247242

248243
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.
249244

250245
For more information, see
251-
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
252-
Hat Single Sign-On features and concepts].
246+
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].
247+
248+
[id="mta-roles-personas-users-permissions_{context}"]
249+
=== Roles, Personas, Users, and Permissions
250+
251+
{ProductShortName} makes use of three roles, each of which corresponds to a persona:
252+
253+
.Roles and personas
254+
[cols="50%,50%", options="header"]
255+
|====
256+
|Role
257+
|Persona
258+
259+
|`tackle-admin`
260+
|Administrator
261+
262+
|`tackle-architect`
263+
|Architect
264+
265+
|`tackle-migrator`
266+
|Migrator
267+
|====
268+
269+
The roles are already defined in your RHSSO instance. You do not need to create them.
270+
271+
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.
272+
273+
[id="mta-roles-personas-ui-views_{context}"]
274+
==== Roles, personas, and access to {WebName} views
275+
276+
Although a user can have more than one role, each role corresponds to a specific persona:
277+
278+
* 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.
279+
280+
* 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.
281+
282+
* Migrator: A user who can analyze applications, but not create, modify, or delete them.
283+
284+
As described in xref:mta-ui-interface-views[User interface views], {ProductShortName} has two views, *Administration* and *Migration*.
285+
286+
Only administrators can access *Administration* view. Architects and migrators have no access to *Administration* view, they cannot even see it.
287+
288+
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.
289+
290+
The ability of administrators, architects, and migrators to access the *Administration* and *Migration* views of the {ProductShortName} {WebName} is summarized in the table below:
291+
292+
.Roles vs. access to {ProductShortName} views
293+
[cols=",,,",options="header",]
294+
|===
295+
|Menu
296+
|Architect
297+
|Migrator
298+
|Admin
299+
|Administration
300+
|No
301+
|No
302+
|Yes
303+
|Migration
304+
|Yes
305+
|Yes
306+
|Yes
307+
|===
253308

254-
=== Roles and Permissions
309+
[id="mta-roles-permissions_{context}"]
310+
==== Roles and permissions
255311

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

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)