Skip to content

Updates the FEATURE_RESTRICTED_USERS config value #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2022
Merged

Updates the FEATURE_RESTRICTED_USERS config value #529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 2 additions & 22 deletions modules/config-fields-user.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,14 @@

*Default:* `True`

| **FEATURE_RESTRICTED_USERS** | Boolean | Restricts normal users from reading and writing content and creating organizations.
| **FEATURE_RESTRICTED_USERS** | Boolean | When set, restricted users cannot create organizations or content in their own namespace. Normal permissions apply for an organization's membership, for example, a restricted user will still have normal permissions in organizations based on the teams that they are members of.

*Default:* `True`
*Default:* `False`

| **GLOBAL_READONLY_SUPER_USERS** | String | When set, grants users of this list read access to all repositories, regardless of whether they are public repositories.

| **RESTRICTED_USERS_WHITELIST** | String | When set, specific users can be excluded from the `FEATURE_RESTRICTED_USERS` setting.

| **RESTRICTED_USER_READ_ONLY** | Boolean | When set, restricts users to read-only operations unless otherwise specified in `RESTRICTED_USERS_WHITELIST`.

*Default:* `True`
|===

[id="user-config-field-reference"]
Expand Down Expand Up @@ -100,34 +97,17 @@ FEATURE_RESTRICTED_USERS: true
---
----

[id="configuring-restricted-users-read-only"]
=== RESTRICTED_USER_READ_ONLY configuration reference

.Prerequisites

* `FEATURE_RESTRICTED_USERS` is set to `true` in your `config.yaml` file.

[source,yaml]
----
---
FEATURE_RESTRICTED_USERS: true
RESTRICTED_USER_READ_ONLY: true
---
----

[id="configuring-restricted-users-whitelist"]
=== RESTRICTED_USERS_WHITELIST configuration reference

.Prerequisites

* `FEATURE_RESTRICTED_USERS` is set to `true` in your `config.yaml` file.
* `RESTRICTED_USER_READ_ONLY` is set to `true` in your `config.yaml` file.

[source,yaml]
----
---
FEATURE_RESTRICTED_USERS: true
RESTRICTED_USER_READ_ONLY: true
RESTRICTED_USERS_WHITELIST:
- user1
---
Expand Down
8 changes: 2 additions & 6 deletions modules/config-updates-38.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,9 @@ With this field, administrators can add or remove superusers without having to u

| xref:configuring-global-readonly-super-users[**GLOBAL_READONLY_SUPER_USERS**] | String | When set, grants users of this list read access to all repositories, regardless of whether they are public repositories.

| xref:configuring-feature-restricted-users[**FEATURE_RESTRICTED_USERS**] | Boolean | Restricts normal users from reading and writing content and creating organizations.
| xref:configuring-feature-restricted-users[**FEATURE_RESTRICTED_USERS**] | Boolean | When set, restricted users cannot create organizations or content in their own namespace. Normal permissions apply for an organization's membership, for example, a restricted user will still have normal permissions in organizations based on the teams that they are members of.

*Default:* `True`

| xref:configuring-restricted-users-read-only[**RESTRICTED_USER_READ_ONLY**] | Boolean | When set, restricts users to read-only operations unless otherwise specified in `RESTRICTED_USERS_WHITELIST`.

*Default:* `True`
*Default:* `False`

| xref:configuring-restricted-users-whitelist[**RESTRICTED_USERS_WHITELIST**] | String | When set, specific users can be excluded from the `FEATURE_RESTRICTED_USERS` setting.
|===
10 changes: 1 addition & 9 deletions modules/rn_3_80.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,10 @@ For more information, see link:https://access.redhat.com/documentation/en-us/red

* The following configuration fields have been added to enhance user permissions:

** **FEATURE_RESTRICTED_USERS**: This configuration field restricts normal users from reading and writing content and creating organizations.
** **FEATURE_RESTRICTED_USERS**: When set, restricted users cannot create organizations or content in their own namespace. Normal permissions apply for an organization's membership, for example, a restricted user will still have normal permissions in organizations based on the teams that they are members of.
+
For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.8/html-single/configure_red_hat_quay/index#enabling-superusers-full-access[FEATURE_RESTRICTED_USERS].

** **RESTRICTED_USER_READ_ONLY**: When set, restricts users to read-only operations unless otherwise specified in `RESTRICTED_USERS_WHITELIST`.
+
For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.8/html-single/configure_red_hat_quay/index#enabling-restricted-users-read-only[RESTRICTED_USER_READ_ONLY].

** **RESTRICTED_USERS_WHITELIST**: With this configuration field enabled, administrators can exclude users from the `FEATURE_RESTRICTED_USERS` setting.
+
For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.8/html-single/configure_red_hat_quay/index#enabling-restricted-users-whitelist[RESTRICTED_USERS_WHITELIST].
Expand Down Expand Up @@ -236,10 +232,6 @@ Some features available in previous releases have been deprecated or removed. De
|-
|-

| link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.8/html-single/configure_red_hat_quay/index#enabling-restricted-users-read-only[RESTRICTED_USER_READ_ONLY]
| General Availability
| -
| -

| link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.8/html-single/configure_red_hat_quay/index#enabling-restricted-users-whitelist[RESTRICTED_USERS_WHITELIST]
| General Availability
Expand Down