Skip to content

Commit bf1e276

Browse files
committed
Roles, Users, and Permissions in MTV
1 parent 12f9122 commit bf1e276

File tree

1 file changed

+38
-11
lines changed

1 file changed

+38
-11
lines changed

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

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ The most commonly used CR settings are listed in this table:
161161
|====
162162
+
163163
.Example YAML file
164-
[sample,YAML]
164+
[source,YAML]
165165
----
166166
kind: Tackle
167167
apiVersion: tackle.konveyor.io/v1alpha1
@@ -220,7 +220,6 @@ When installed on https://developers.redhat.com/products/openshift-local/overvie
220220
|Memory (GiB)
221221
|Description
222222

223-
224223
|`10`
225224
|{ProductShortName} cannot run the analysis due to insufficient memory
226225

@@ -264,25 +263,53 @@ To prevent out-of-memory events and protect nodes, use the `--eviction-hard` set
264263

265264
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.
266265

267-
268266
== 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
267+
{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
272268
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.
273269

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.
270+
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], administrators can log in to 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.
278271

279272
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.
280273

281274
For more information, see
282275
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
283276
Hat Single Sign-On features and concepts].
284277

285-
=== Roles and Permissions
278+
=== Roles, Personas, Users, and Permissions
279+
280+
{ProductShortName} makes use of three roles, each of which corresponds to a persona:
281+
282+
.Roles and personas
283+
[cols="50%,50%", options="header"]
284+
|====
285+
|Role
286+
|Persona
287+
288+
|`tackle-admin`
289+
|Administrator
290+
291+
|`tackle-architect`
292+
|Architect
293+
294+
|`tackle-migrator`
295+
|Migrator
296+
|====
297+
298+
The roles are already defined in your RHSSO instance. You do not need to create them.
299+
300+
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.
301+
302+
==== Roles and Personas
303+
304+
Although a user can have more than one role, each role corresponds to a specific persona:
305+
306+
* Administrator: An administrator has all the permissions that architects and migrators have, along with access to some application-wide configuration parameters that other users can consume but cannot change or view. Examples: Git credentials, Maven `settings.xml` files.
307+
308+
* Architect: A technical lead for the migration project that 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.
309+
310+
* Migrator: A developer who can analyze applications, but not create, modify, or delete them.
311+
312+
==== Roles and permissions
286313

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

0 commit comments

Comments
 (0)