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.

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

Add docs for OPA access control #20246

Merged
merged 1 commit into from
Feb 1, 2024
Merged

Conversation

mosabua
Copy link
Member

@mosabua mosabua commented Dec 29, 2023

Description

Converting readme from code PR into docs output and updating wording, grammar, content, and so on.

It would be great to have a few very simple rego scripts as example. Something like read only access for everyone, read only for specific catalogs only and users and groups, and maybe one or two more .. and then link to the relevant sections in the OPA docs for more. Any tips @vagaerg or @sbernauer ?

Additional context and related issues

#19532

Release notes

(x) This is not user-visible or is docs only, and no release notes are required.

Release notes entry comes from code PR.

Copy link
Member

@vagaerg vagaerg left a comment

Choose a reason for hiding this comment

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

LGTM other than the minor nitpick

Will work shortly on merging our work in https://github.com/bloomberg/trino/tree/add-open-policy-agent-with-docs/plugin/trino-opa/schema-docs here
That contains examples and full documentation for each operation

We've also built some JSON Schemas we could share, but that's potentially out of scope for this

@mosabua
Copy link
Member Author

mosabua commented Jan 9, 2024

I fixed the nit and will leave PR as is for now. Lets see when we get the code PR merged. Then we can adjust the docs to the same level and add more later.

@mosabua mosabua changed the title Add docs for OPA access control (WIP) Add docs for OPA access control Jan 15, 2024
@dain
Copy link
Member

dain commented Jan 27, 2024

This looks good. I think we should remove duplicate stuff from the readme, so we don't have two places to maintain.

@mosabua
Copy link
Member Author

mosabua commented Jan 27, 2024

@dain once the code PR is merged I will rebase and add the removal of the readme to this PR .. thats what we agreed with @vagaerg .. I will do a last check to confirm I got it all..

@dain dain changed the title (WIP) Add docs for OPA access control Add docs for OPA access control Feb 1, 2024
Copy link
Member

@dain dain left a comment

Choose a reason for hiding this comment

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

Minor comments, but otherwise looks good

docs/src/main/sphinx/security/opa-access-control.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/security/opa-access-control.md Outdated Show resolved Hide resolved
@mosabua mosabua merged commit 646be76 into trinodb:master Feb 1, 2024
7 of 17 checks passed
@mosabua mosabua deleted the opa-docs branch February 1, 2024 00:26
@github-actions github-actions bot added this to the 438 milestone Feb 1, 2024
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.

4 participants