Skip to content
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

Remove references to the Override checkbox for filters #3548

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Remove references to the Override checkbox for filters #3548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ae1bd4
Unlimited is not selected by default
aneta-petrova Jan 6, 2025
d91e852
Remove references to Override checkbox (procedure)
aneta-petrova Jan 6, 2025
dd976a7
Reword Unlimited step to make it work after Override is removed
aneta-petrova Jan 6, 2025
0e8616e
Remove references to Override checkbox (example)
aneta-petrova Jan 6, 2025
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
7 changes: 3 additions & 4 deletions guides/common/modules/proc_adding-permissions-to-a-role.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,11 @@ To use the CLI instead of the {ProjectWebUI}, see the xref:cli-adding-permission
. Select the *Resource type* from the drop-down list.
The _(Miscellaneous)_ group gathers permissions that are not associated with any resource group.
. Click the permissions you want to select from the *Permission* list.
. Depending on the *Resource type* selected, you can select or deselect the *Unlimited* and *Override* checkbox.
The *Unlimited* checkbox is selected by default, which means that the permission is applied on all resources of the selected type.
When you disable the *Unlimited* checkbox, the *Search* field activates.
. For certain *Resource type* options, the *Unlimited* checkbox is available.
If *Unlimited* is selected, the permission is applied on all resources of the selected type.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to add that unlimited will be disabled if the role parent has a loc/org selected, alert in foreman says: "Info alert:The filter is scoped to the selected organizations and locations, therefore can't be unlimited"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm inclined to say that we don't need to go into this kind of detail here. I left a comment on the code PR with a minor suggestion to change the wording of the alert. I'd say that if users will know what's happening from looking at the web UI form, then that's great and there is no need for additional words in the docs.

If *Unlimited* is unselected, the *Search* field activates.
In this field you can specify further filtering with use of the {Project} search syntax.
For more information, see xref:Granular_Permission_Filtering_{context}[].
When you enable the *Override* checkbox, you can add additional locations and organizations to allow the role to access the resource type in the additional locations and organizations; you can also remove an already associated location and organization from the resource type to restrict access.
. Click *Next*.
. Click *Submit* to save changes.

Expand Down
5 changes: 0 additions & 5 deletions guides/common/modules/proc_applying-permissions-for-the-host-resource-type.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,3 @@ To do so, specify the environment name in the *Search* field, for example:
----
Dev
----

You can limit user permissions to a certain organization or location with the use of the granular permission filter in the *Search* field.
However, some resource types provide a GUI alternative, an *Override* checkbox that provides the *Locations* and *Organizations* tabs.
On these tabs, you can select from the list of available organizations and locations.
For more information, see xref:Creating_an_Organization_Specific_Manager_Role_{context}[].
2 changes: 0 additions & 2 deletions guides/common/modules/proc_creating-an-organization-specific-manager-role.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,4 @@ You are then prompted to insert a name for the cloned role, for example _org-1 a
. Click _org-1 admin_, and click *Filters* to view all associated filters.
The default filters work for most use cases.
However, you can optionally click *Edit* to change the properties for each filter.
For some filters, you can enable the *Override* option if you want the role to be able to access resources in additional locations and organizations.
For example, by selecting the *Domain* resource type, the *Override* option, and then additional locations and organizations using the *Locations* and *Organizations* tabs, you allow this role to access domains in the additional locations and organizations that is not associated with this role.
You can also click *New filter* to associate new filters with this role.