You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add registry settings admin task to access guide (#554)
* add registry settings admin task to access guide, fix broken link to cli guide
* add peer review feedback from breda, clean up
* more clean up
* more tidy up
Copy file name to clipboardExpand all lines: docs/registry/access-mgmt-registry/README.adoc
+48-42Lines changed: 48 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,111 +93,117 @@ As a {registry} instance owner, an instance administrator, or an organization ad
93
93
[role="_abstract"]
94
94
{product-long-registry} uses Role-Based Access Control (RBAC) to manage how other user accounts and service accounts access the {registry} instances that you create and the artifacts that they contain. You can manage access for only the {registry} instances that you create or for instances that the owner has allowed you to access and change.
95
95
96
-
An account in {product-long-registry} is either a user account or a service account. A user account enables users in your organization to access your {registry} instances. A service account enables your client application or tool to connect securely and to access your {registry} instances.
96
+
An account in {product-long-registry} is either a user account or a service account. A user account enables users in your organization to access your {registry} instances. A service account enables client applications or tools to connect securely to your {registry} instances.
97
97
98
98
99
99
=== User roles in {product-long-registry}
100
100
101
101
The {registry} web console provides an *Access* tab on the {registry} instance page. {registry} instance owners, instance administrators, and organization administrators can use this tab to manage the following user roles:
102
102
103
-
* *Administrator* - Can perform the following in this {registry} instance:
104
-
** View or write user roles
105
-
** View or write schema and API artifacts
106
-
** Configure global rules for compatibility and validity
107
-
** Import/export {registry} data
108
-
* *Manager* - Can view or write schema and API artifacts in this {registry} instance
109
-
* *Viewer* - Can view schema and API artifacts in this {registry} instance
103
+
Administrator:: Users with the Administrator role can perform the following tasks in this {registry} instance:
104
+
* View or write schema and API artifacts
105
+
* Configure user roles for access
106
+
* Configure {registry} settings
107
+
* Configure global rules for artifact compatibility and validity
108
+
* Import or export {registry} data
109
+
Manager:: Users with the Manager role can view or write schema and API artifacts in this {registry} instance.
110
+
Viewer:: Users with the Viewer role can view schema and API artifacts in this {registry} instance.
110
111
111
-
IMPORTANT: The owner of a {registry} instance has the administrator role for that instance by default, and can assign roles in the same organization. Other user accounts or service accounts in the organization have no access to that instance by default.
112
+
IMPORTANT: The owner of a {registry} instance has the Administrator role for that instance by default, and can assign roles in the same organization. Other user accounts or service accounts in the organization have no access to that instance by default.
112
113
113
-
In addition to the web console, the `rhoas` CLI provides commands to manage user roles, and the core {registry} REST API also provides Admin API endpoints for managing user roles.
114
+
In addition to the web console, the `rhoas` CLI provides commands to manage user roles. The core {registry} REST API also provides Admin API endpoints for managing user roles.
114
115
115
116
[id="proc-viewing-registry-roles_{context}"]
116
117
== Viewing user roles in a {registry} instance
117
118
118
119
[role="_abstract"]
119
-
You can view the user roles assigned to your {registry} instances that manage how other user accounts or service accounts interact with the instance and the artifacts that it contains. You can view user roles and accounts only for instances that you create or for instances that the owner has assigned you access to.
120
+
You can view the user roles assigned to your {registry} instances to manage how other user accounts or service accounts interact with the instance and the artifacts that it contains. You can view user roles and accounts only for instances that you create or for instances that the owner has assigned you access to.
120
121
121
122
.Prerequisites
122
-
* The {registry} instance has been created and is in *Ready* state.
123
-
* The user accounts or service accounts that you want to view have been created in the organization and have already been assigned user roles.
123
+
* You're logged in to the {registry} web console at {service-url-registry}[^].
124
+
* The {registry} instance is created and is in *Ready* state.
125
+
* The user accounts or service accounts that you want to view are created in the organization and are assigned user roles.
126
+
124
127
125
128
.Procedure
126
-
. In the web console, go to *{registry}* > *{registry} Instances* and click the name of the {registry} instance that you want to view roles and accounts for.
129
+
. In the {service-url-registry}[{registry} web console], click the name of the {registry} instance that you want to view roles and accounts for.
127
130
. Click the *Access* tab to view the roles and accounts assigned for this instance:
128
131
.. To view specific accounts, click *Account*, enter the user account or service account name, and click the search button.
129
-
.. To view accounts with a specific role, click *Role*, select *Filter by role* and then the role you want (for example, *Administrator*), and click the search button.
130
-
. Click *Clear all filters* when done.
132
+
.. To view accounts with a specific role, click *Role*, click *Filter by role*, and select the role you want (for example, *Administrator*), and then click the search button.
133
+
. When you are finished, click *Clear all filters*.
131
134
132
135
[id="proc-setting-registry-roles_{context}"]
133
136
== Assigning user roles in a {registry} instance
134
137
135
138
[role="_abstract"]
136
-
In {product-long-registry}, you can assign user roles in your {registry} instances to manage how other user accounts or service accounts interact with the instance and the artifacts that it contains. You can assign user roles only for instances that you create or for instances that the owner has assigned you access to.
139
+
In {product-long-registry}, you can assign user roles for your {registry} instances to manage how other user accounts or service accounts interact with the instance and the artifacts that it contains. You can assign user roles only for instances that you create or for instances that the owner has assigned you access to.
137
140
138
141
.Prerequisites
139
-
* The {registry} instance has been created and is in *Ready* state.
140
-
* The user accounts or service accounts that you're assigning roles to have been created in the organization.
142
+
* You're logged in to the {registry} web console at {service-url-registry}[^].
143
+
* The {registry} instance is created and is in *Ready* state.
144
+
* The user accounts or service accounts that you're assigning roles to are created in the organization.
141
145
142
146
.Procedure
143
-
. In the web console, go to *{registry}* > *{registry} Instances* and click the name of the {registry} instance that you want to assign roles for.
144
-
. Click the *Access* tab to view the accounts and roles already assigned for this instance.
147
+
. In the {service-url-registry}[{registry} web console], click the name of the {registry} instance that you want to assign roles for.
148
+
. Click the *Access* tab to view the accounts and roles assigned for this instance.
145
149
. Click *Grant access* to assign roles to accounts.
146
150
. In the *Account* field, select or enter the service account or user account name that you want to assign the role to:
147
-
** A service account enables your application or tool to connect securely to your instance
148
-
** A user account enables users in your organization to access instances
151
+
** A service account enables your application or tool to connect securely to your instance.
152
+
** A user account enables users in your organization to access instances.
149
153
+
150
-
NOTE: If you don't see users in the drop-down list, ask your organization administrator to grant access to view other user accounts. For more information, see {base-url}{access-mgmt-url-registry}#proc-user-account-access_managing-access-service-registry[Allowing users to view other user accounts].
154
+
NOTE: If you don't see users in the list, ask your organization administrator to grant access to view other user accounts. For more information, see {base-url}{access-mgmt-url-registry}#proc-user-account-access_managing-access-service-registry[Allowing users to view other user accounts].
151
155
. Select the *Role* that you want to assign to your account, for example, *Manager* for write access to this instance.
152
156
. Click *Save*.
153
157
154
158
[id="proc-remove-registry-roles_{context}"]
155
159
== Editing or removing user roles in a {registry} instance
156
160
157
161
[role="_abstract"]
158
-
You can edit or remove the user roles assigned in your {registry} instances that manage how other user accounts or service accounts interact with the instance and the artifacts that it contains. You can edit or remove user roles only for the instances that you create or for instances that the owner has assigned you access to.
162
+
You can edit or remove the user roles assigned in your {registry} instances to manage how other user accounts or service accounts interact with the instance and the artifacts that it contains. You can edit or remove user roles only for the instances that you create or for instances that the owner has assigned you access to.
159
163
160
164
.Prerequisites
161
-
* The {registry} instance has been created and is in *Ready* state.
162
-
* The user accounts or service accounts have been created in the organization and the user roles have already been assigned.
165
+
* You're logged in to the {registry} web console at {service-url-registry}[^].
166
+
* The {registry} instance is created and is in *Ready* state.
167
+
* The user accounts or service accounts are created in the organization and the user roles are assigned.
163
168
164
169
.Procedure
165
-
. In the web console, go to *{registry}* > *{registry} Instances* and click the name of the {registry} instance that you want to remove a user role for.
170
+
. In the {service-url-registry}[{registry} web console], click the name of the {registry} instance that you want to remove a user role for.
166
171
. Click the *Access* tab to view the accounts and roles assigned for this instance.
167
-
. Select the options menu (three vertical dots) next to the assigned *Role* name:
168
-
.. To change to a different role, click *Edit* and select the new user role, for example, *Viewer* for read-only access to this instance.
169
-
.. To remove the currently assigned role, click *Remove* and confirm in the dialog.
172
+
. Click the options menu (three vertical dots) next to the assigned *Role* name:
173
+
.. To change to a different role, click *Edit*, select the new user role, for example, *Viewer* for read-only access, and then click *Save*.
174
+
.. To remove the currently assigned role, click *Remove*, and then click *Remove* again to confirm.
170
175
171
176
[id="proc-user-account-access_{context}"]
172
177
== Allowing users to view other user accounts
173
178
174
179
[role="_abstract"]
175
-
As an organization administrator, you can use Role-Based Access Control (RBAC) in the {org-name} web console to allow users to view other users in an organization.
180
+
As an organization administrator, you can use Role-Based Access Control (RBAC) in the {org-name} Hybrid Cloud Console to allow users to view other users in an organization.
176
181
177
182
You set up access by assigning a predefined role called `User Access principal viewer` to a user group.
178
-
By assigning the role, users within the group are able to do the following:
183
+
By assigning the role, users in the group can do the following tasks:
179
184
180
-
* View and select other users when changing owners and managing access to {registry} instances in the web console
181
-
* Specify user names when managing {registry} instances using the `rhoas` CLI for {product-long-registry}
185
+
* View and select other users when changing owners and managing access to {registry} instances in the {registry} web console.
186
+
* Specify user names when managing {registry} instances using the `rhoas` CLI for {product-long-registry}.
182
187
183
188
.Prerequisites
184
-
* You're logged into the {org-name} web console as an organization administrator.
185
-
* A user group contains the users to assign the role to.
189
+
* You're logged in to the {registry} web console at {service-url-registry}[^] as an organization administrator.
190
+
* A user group is created that contains the users to assign the role to.
186
191
187
192
NOTE: If you want to add the `User Access principal viewer` role to a single user, create a new group for that user only.
188
193
189
194
ifndef::community[]
190
-
For more information on setting up user access in the web console, see the link:https://access.redhat.com/documentation/en-us/red_hat_hybrid_cloud_console/[_User Access Configuration Guide for Role-based Access Control (RBAC)_^].
195
+
For more information on setting up user access in the {org-name} Hybrid Cloud Console, see the link:https://access.redhat.com/documentation/en-us/red_hat_hybrid_cloud_console/[_User Access Configuration Guide for Role-based Access Control (RBAC)_^].
191
196
endif::[]
192
197
193
198
.Procedure
194
199
195
-
. In the upper-right corner of the {registry} web console, select the gear icon, and click *Settings* > *User Access* > *Groups*
200
+
. At the top of the {service-url-registry}[{registry} web console], select the gear icon.
201
+
. Click *Settings*, then *User Access*, and then *Groups*.
196
202
. Click the name of the user group.
197
-
. From the *Roles* tab, click *Add role* and select `User Access principal viewer` to add the role to the group.
198
-
. Click *Add to group* to add the role to the group.
203
+
. From the *Roles* tab, click *Add role*, and select `User Access principal viewer`.
204
+
. Click *Add to group*.
199
205
+
200
-
The role is added to the list of selected roles on the *Roles* tab.
206
+
The role is also added to the list of selected roles on the *Roles* tab.
0 commit comments