Skip to content

Commit 527b4cd

Browse files
authored
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
1 parent e52fc1c commit 527b4cd

File tree

2 files changed

+49
-43
lines changed

2 files changed

+49
-43
lines changed

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
* link:./docs/registry/getting-started-registry/[Getting started with {product-long-registry}]
2424
* link:./docs/registry/access-mgmt-registry[Managing account access in {product-long-registry}]
25-
* link:./docs/registry/rhoas-cli-registry[Getting started with the rhoas CLI for {product-long-registry}]
25+
* link:./docs/registry/rhoas-cli-getting-started-registry[Getting started with the rhoas CLI for {product-long-registry}]
2626
* link:./docs/registry/quarkus-registry[Using Quarkus applications with Kafka instances and {product-long-registry} instances]
2727

2828
== Core guides

docs/registry/access-mgmt-registry/README.adoc

Lines changed: 48 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -93,111 +93,117 @@ As a {registry} instance owner, an instance administrator, or an organization ad
9393
[role="_abstract"]
9494
{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.
9595

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.
9797

9898

9999
=== User roles in {product-long-registry}
100100

101101
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:
102102

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.
110111

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.
112113

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.
114115

115116
[id="proc-viewing-registry-roles_{context}"]
116117
== Viewing user roles in a {registry} instance
117118

118119
[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.
120121

121122
.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+
124127

125128
.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.
127130
. Click the *Access* tab to view the roles and accounts assigned for this instance:
128131
.. 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*.
131134

132135
[id="proc-setting-registry-roles_{context}"]
133136
== Assigning user roles in a {registry} instance
134137

135138
[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.
137140

138141
.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.
141145

142146
.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.
145149
. Click *Grant access* to assign roles to accounts.
146150
. 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.
149153
+
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].
151155
. Select the *Role* that you want to assign to your account, for example, *Manager* for write access to this instance.
152156
. Click *Save*.
153157

154158
[id="proc-remove-registry-roles_{context}"]
155159
== Editing or removing user roles in a {registry} instance
156160

157161
[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.
159163

160164
.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.
163168

164169
.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.
166171
. 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.
170175

171176
[id="proc-user-account-access_{context}"]
172177
== Allowing users to view other user accounts
173178

174179
[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.
176181

177182
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:
179184

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}.
182187

183188
.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.
186191

187192
NOTE: If you want to add the `User Access principal viewer` role to a single user, create a new group for that user only.
188193

189194
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)_^].
191196
endif::[]
192197

193198
.Procedure
194199

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*.
196202
. 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*.
199205
+
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.
201207

202208
[role="_additional-resources"]
203209
.Additional resources

0 commit comments

Comments
 (0)