Skip to content

Some clarifications in documentation of File-Based Access Control#19861

Merged
mosabua merged 2 commits intotrinodb:masterfrom
ksobolew:kudi/fbac-docs-clarification
Nov 28, 2023
Merged

Some clarifications in documentation of File-Based Access Control#19861
mosabua merged 2 commits intotrinodb:masterfrom
ksobolew:kudi/fbac-docs-clarification

Conversation

@ksobolew
Copy link
Copy Markdown
Contributor

Description

Move a paragraph slightly higher in FBAC docs: The information in that paragraph are important to fully understand the semantics of FBAC, but several bug reports indicate that it's easy to miss. Perhaps moving it before the :::{note} section will make it harder to miss.

Emphasize and clarify behavior when there are no FBAC schema rules, including some instructions on how to remove that behavior if it's not desired.

Additional context and related issues

Release notes

(x) This is not user-visible or is docs only, and no release notes are required.
( ) Release notes are required. Please propose a release note for me.
( ) Release notes are required, with the following suggested text:

# Section
* Fix some things. ({issue}`issuenumber`)

The information in that paragraph are important to fully understand the
semantics of FBAC, but several bug reports indicate that it's easy to
miss. Perhaps moving it before the `:::{note}` section will make it
harder to miss.
@cla-bot cla-bot bot added the cla-signed label Nov 22, 2023
@ksobolew ksobolew requested a review from mosabua November 22, 2023 11:28
@github-actions github-actions bot added the docs label Nov 22, 2023
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
For each rule set, permission is based on the first matching rule read from top
For each rule set, permission is based on the first matching rule read from the top

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
to bottom. If no rule matches, access is denied. If no rules are provided at
to the bottom of the configuration file. If no rule matches, access is denied. If no rules are provided at

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
all, then access is granted. If the latter behavior is not desired, it's easy to
all, then access is granted. You can remove access grant

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
remove it by adding a section with empty set of rules at that particular level,
by adding a section with an empty set of rules at that particular level,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
e.g.:
for example:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
At the catalog level one would have to add a single "dummy" rule for each
At the catalog level you have to add a single "dummy" rule for each

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
accessible catalog, though.
accessible catalog.

@mosabua
Copy link
Copy Markdown
Member

mosabua commented Nov 22, 2023

Related - #17689

@mosabua
Copy link
Copy Markdown
Member

mosabua commented Nov 22, 2023

Could you also address the questions from #18370 ?

@ksobolew ksobolew force-pushed the kudi/fbac-docs-clarification branch from 8021cea to 149c868 Compare November 28, 2023 16:59
@ksobolew
Copy link
Copy Markdown
Contributor Author

Could you also address the questions from #18370 ?

I would like to, but I can't tell what is the core issue there

Including some instructions on how to remove that behavior if it's not
desired.
@mosabua mosabua force-pushed the kudi/fbac-docs-clarification branch from 149c868 to 8c61259 Compare November 28, 2023 17:39
@mosabua
Copy link
Copy Markdown
Member

mosabua commented Nov 28, 2023

Good to go now. Thank you @ksobolew

@mosabua mosabua merged commit 95482f7 into trinodb:master Nov 28, 2023
@github-actions github-actions bot added this to the 434 milestone Nov 28, 2023
@ksobolew ksobolew deleted the kudi/fbac-docs-clarification branch November 29, 2023 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants