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

Jump to bottom

Add OPA documentation #48

Merged
merged 2 commits into from
Sep 20, 2021
Merged

Add OPA documentation #48

merged 2 commits into from
Sep 20, 2021

Conversation

ereslibre
Copy link
Member

@ereslibre ereslibre commented Aug 27, 2021 •
edited
Loading

Note well: to be merged only when the OPA work is merged and released.

Fixes: #47

This documentation covers the general Rego information and also two
specific sections about Open Policy Agent and Gatekeeper.

In other order of news, when I was writing this documentation I also updated the policy-evaluator opa branch with support for running gatekeeper policies :)

@ereslibre ereslibre requested a review from flavio August 27, 2021 15:17
viccuad
viccuad reviewed Sep 6, 2021
View reviewed changes
Copy link
Member

@viccuad viccuad left a comment

Choose a reason for hiding this comment

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

Good write up, helped me understand OPA and Gatekeeper!

@viccuad viccuad self-requested a review September 9, 2021 08:05
flavio
flavio requested changes Sep 9, 2021
View reviewed changes
Copy link
Member

@flavio flavio left a comment

Choose a reason for hiding this comment

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

Great job, I left some comments. I hope everything is clear and consistent, I did the review over many days...

src/SUMMARY.md Show resolved Hide resolved
src/writing-policies/rego/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/02-builtin-support.md Outdated Show resolved Hide resolved
src/writing-policies/rego/02-builtin-support.md Outdated Show resolved Hide resolved
src/writing-policies/rego/open-policy-agent/03-build-and-run.md Show resolved Hide resolved
src/writing-policies/rego/open-policy-agent/04-distribute.md Outdated Show resolved Hide resolved
src/writing-policies/rego/open-policy-agent/04-distribute.md Outdated Show resolved Hide resolved
src/writing-policies/rego/gatekeeper/03-build-and-run.md Show resolved Hide resolved
@ereslibre
Copy link
Member Author

@flavio All feedback has been addressed. Please have a look. I also recommend to run mdbook locally to get a better idea of how it looks and feels.

flavio
flavio requested changes Sep 14, 2021
View reviewed changes
Copy link
Member

@flavio flavio left a comment

Choose a reason for hiding this comment

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

Thanks for the fixes, we are definitely heading in the right direction. I left some more comments

src/writing-policies/rego/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/02-builtin-support.md Outdated Show resolved Hide resolved
src/writing-policies/rego/gatekeeper/04-distribute.md Outdated Show resolved Hide resolved
src/writing-policies/rego/gatekeeper/04-distribute.md Outdated Show resolved Hide resolved
src/writing-policies/rego/open-policy-agent/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/open-policy-agent/02-create-policy.md Outdated Show resolved Hide resolved
src/writing-policies/rego/open-policy-agent/04-distribute.md Outdated Show resolved Hide resolved
@flavio flavio mentioned this pull request Sep 15, 2021
Merged
flavio
flavio requested changes Sep 15, 2021
View reviewed changes
Copy link
Member

@flavio flavio left a comment

Choose a reason for hiding this comment

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

LGTM, there's just one small fix to do. Once this is done I think you can squash everything into a single commit (or multiple ones, if you prefer).

We will merge that as soon as we finish all the work on the OPA/Gatekeeper story

src/writing-policies/rego/gatekeeper/02-create-policy.md Outdated Show resolved Hide resolved
@ereslibre
Add OPA documentation
5a04b9b 
This documentation covers the general Rego information and also two
specific sections about Open Policy Agent and Gatekeeper.
ereslibre
ereslibre commented Sep 20, 2021
View reviewed changes
Copy link
Member Author

@ereslibre ereslibre left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Canot request changes/approve. Typo

src/writing-policies/rego/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/gatekeeper/01-intro.md Outdated Show resolved Hide resolved
src/writing-policies/rego/open-policy-agent/01-intro.md Outdated Show resolved Hide resolved
@flavio
Add clarification about Rego support
f2e2265 
Be explicit about the releases of kwctl and policy-server that handle
Rego policies.
@flavio flavio merged commit d9ac860 into main Sep 20, 2021
@flavio flavio deleted the opa branch September 20, 2021 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@flavio flavio flavio requested changes

@viccuad viccuad viccuad approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document how to use OPA policies
3 participants
@ereslibre @flavio @viccuad