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

ENG-14702: Update documentation for repo level policies #602

Merged
merged 5 commits into from
Jan 2, 2025

Conversation

gengdahlCyral
Copy link
Contributor

@gengdahlCyral gengdahlCyral commented Dec 30, 2024

Description of the change

Added deprecation note to deprecated rego templates and updated rego policy test case to use one of the supported rego templates (object-protection).

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklists

Development

  • Lint rules pass locally
  • The code changed/added as part of this pull request has been covered with tests
  • All tests related to the changed code pass in development

Code review

  • This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached
  • Jira issue referenced in commit message and/or PR title

Testing

UT

…cy test case to use one of the supported rego templates (object-protection).
@gengdahlCyral gengdahlCyral changed the title ENG-14702: Removed references to deprecated rego templates ENG-14702: Added deprecation note to deprecated rego templates Dec 30, 2024
@@ -71,15 +71,38 @@ All templates use parameters defined as JSON, below is a list of all the corresp

-> You can also use the Cyral API `GET` `/v1/regopolicies/templates` to retrieve all existing templates and their corresponding parameters schema.

### Data Firewall (data-firewall)
### Object Protection (object-protection)
Copy link
Contributor

Choose a reason for hiding this comment

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

Since we're updating this, maybe add information about the two new templates (ungoverned-statements and fail-closed) should be added as well.

@yoursnerdly yoursnerdly changed the title ENG-14702: Added deprecation note to deprecated rego templates ENG-14702: Update documentation for repo level policies Dec 30, 2024
Copy link
Contributor

@yoursnerdly yoursnerdly left a comment

Choose a reason for hiding this comment

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

LGTM - @gengdahlCyral please let me know if you have any further suggestions related to documentation update.

Copy link
Contributor Author

@gengdahlCyral gengdahlCyral left a comment

Choose a reason for hiding this comment

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

Looks good to me, do you want to do merge and tag @yoursnerdly ?

@yoursnerdly yoursnerdly merged commit 6e189d5 into main Jan 2, 2025
3 checks passed
@yoursnerdly yoursnerdly deleted the remove-deprecated-rego-templates branch January 2, 2025 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants