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

[DX-1261] Update partitioned-policies.md with note about ACL #4411

Merged
merged 4 commits into from
Apr 16, 2024

Conversation

behcio
Copy link
Contributor

@behcio behcio commented Apr 12, 2024

User description

When partitioned policies are assigned to a token, at least of these policies needs to enforce ACL - this part was missing.

For internal users - Please add a Jira DX PR ticket to the subject!



Preview Link

https://deploy-preview-4411--tyk-docs.netlify.app/docs/nightly/basic-config-and-security/security/security-policies/partitioned-policies/#example-use-case

Description


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labelled the PR

Type

documentation


Description

  • Added important clarification in the security policies documentation to specify that when applying partitioned policies to a key, at least one policy must enforce ACL. This ensures users are aware of the ACL enforcement requirements for partitioned policies.

Changes walkthrough

Relevant files
Documentation
partitioned-policies.md
Update ACL Requirement Note for Partitioned Policies         

tyk-docs/content/basic-config-and-security/security/security-policies/partitioned-policies.md

  • Added a note specifying that at least one of the partitioned policies
    assigned to a key needs to enforce ACL.
  • +1/-0     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    When partitioned policies are assigned to a token, at least of these policies needs to enforce ACL - this part was missing.
    Copy link
    Contributor

    PR Description updated to latest commit (4094369)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    1, because the PR involves a straightforward documentation update, adding a single note about ACL requirements in partitioned policies. The change is simple and does not require in-depth technical review or validation through tests.

    🧪 Relevant tests

    No

    🔍 Possible issues

    No

    🔒 Security concerns

    No

    Code feedback:

    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

    • When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    
    [pr_reviewer]
    some_config1=...
    some_config2=...
    

    See the review usage page for a comprehensive guide on using this tool.

    Copy link
    Contributor

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Enhancement
    Clarify the requirement for enforcing ACL in partitioned policies.

    Consider rephrasing the added note to clarify the requirement and its implications. The
    current wording "at least one of these policies needs to enforce ACL" might be ambiguous
    to readers unfamiliar with the context. A clearer explanation could help users understand
    whether this is a recommendation for best practices or a strict requirement for policy
    functionality.

    tyk-docs/content/basic-config-and-security/security/security-policies/partitioned-policies.md [34]

    -*   When applying partitioned policies to a key, at least one of these policies needs to enforce ACL
    +*   Note: For partitioned policies applied to a key to be effective, it is required that at least one policy enforces the Access Control Limit (ACL). This ensures that access rights are properly managed.
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

    • When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    
    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    

    See the improve usage page for a comprehensive guide on using this tool.

    Copy link

    netlify bot commented Apr 12, 2024

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 40a710d
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/661e5b2a032401000883db77
    😎 Deploy Preview https://deploy-preview-4411--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @behcio behcio changed the title Update partitioned-policies.md with note about ACL [DX-1261] Update partitioned-policies.md with note about ACL Apr 12, 2024
    @behcio behcio requested a review from agata-wit April 15, 2024 07:47
    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Apr 15, 2024

    Hi @behcio thanks for contributing the fix. Would you be able to add a preview link and a label for which release this targets or now label if it is intended for the current release

    @behcio
    Copy link
    Contributor Author

    behcio commented Apr 16, 2024

    @dcs3spp Preview link added. As for labels... which label should I add if it's something that applies all the way back to 3.0? :)

    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Apr 16, 2024

    @dcs3spp Preview link added. As for labels... which label should I add if it's something that applies all the way back to 3.0? :)

    Thanks @behcio , 🤔 maybe for that use case add a new label, all?

    Copy link
    Contributor

    @dcs3spp dcs3spp left a comment

    Choose a reason for hiding this comment

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

    Thanks @behcio for submitting updated content fix. PR LGTM, I have made some minor suggestions and then think we can release

    @dcs3spp dcs3spp added the all label Apr 16, 2024
    @dcs3spp dcs3spp merged commit e0b6a14 into master Apr 16, 2024
    10 checks passed
    @dcs3spp dcs3spp deleted the partitioned-policies-acl-update branch April 16, 2024 11:08
    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Apr 16, 2024

    /release to release-5.3

    Copy link

    tykbot bot commented Apr 16, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Apr 16, 2024
    Update partitioned-policies.md with note about ACL
    
    (cherry picked from commit e0b6a14)
    Copy link

    tykbot bot commented Apr 16, 2024

    @dcs3spp Succesfully merged PR

    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Apr 16, 2024

    /release to release-5.2

    Copy link

    tykbot bot commented Apr 16, 2024

    Working on it! Note that it can take a few minutes.

    Copy link

    tykbot bot commented Apr 16, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Apr 16, 2024
    Update partitioned-policies.md with note about ACL
    
    (cherry picked from commit e0b6a14)
    buger added a commit that referenced this pull request Apr 16, 2024
    … note about ACL (#4411)
    
    [DX-1261] Update partitioned-policies.md with note about ACL (#4411)
    
    Update partitioned-policies.md with note about ACL
    Copy link

    tykbot bot commented Apr 16, 2024

    @dcs3spp Succesfully merged PR

    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Apr 16, 2024

    /release to release-4

    Copy link

    tykbot bot commented Apr 16, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Apr 16, 2024
    Update partitioned-policies.md with note about ACL
    
    (cherry picked from commit e0b6a14)
    buger added a commit that referenced this pull request Apr 16, 2024
    …ote about ACL (#4411)
    
    [DX-1261] Update partitioned-policies.md with note about ACL (#4411)
    
    Update partitioned-policies.md with note about ACL
    Copy link

    tykbot bot commented Apr 16, 2024

    @dcs3spp Succesfully merged PR

    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Apr 16, 2024

    /release to release-3.2

    Copy link

    tykbot bot commented Apr 16, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Apr 16, 2024
    Update partitioned-policies.md with note about ACL
    
    (cherry picked from commit e0b6a14)
    buger added a commit that referenced this pull request Apr 16, 2024
    … note about ACL (#4411)
    
    [DX-1261] Update partitioned-policies.md with note about ACL (#4411)
    
    Update partitioned-policies.md with note about ACL
    Copy link

    tykbot bot commented Apr 16, 2024

    @dcs3spp Succesfully merged PR

    dcs3spp pushed a commit that referenced this pull request Apr 16, 2024
    … note about ACL (#4411) (#4420)
    
    [DX-1261] Update partitioned-policies.md with note about ACL (#4411)
    
    Co-authored-by: behcio <[email protected]>
    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Apr 16, 2024

    /release to release-3.1

    Copy link

    tykbot bot commented Apr 16, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Apr 16, 2024
    Update partitioned-policies.md with note about ACL
    
    (cherry picked from commit e0b6a14)
    buger added a commit that referenced this pull request Apr 16, 2024
    … note about ACL (#4411)
    
    [DX-1261] Update partitioned-policies.md with note about ACL (#4411)
    
    Update partitioned-policies.md with note about ACL
    Copy link

    tykbot bot commented Apr 16, 2024

    @dcs3spp Succesfully merged PR

    @dcs3spp
    Copy link
    Contributor

    dcs3spp commented Apr 16, 2024

    /release to release-3-lts

    Copy link

    tykbot bot commented Apr 16, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Apr 16, 2024
    Update partitioned-policies.md with note about ACL
    
    (cherry picked from commit e0b6a14)
    buger added a commit that referenced this pull request Apr 16, 2024
    …th note about ACL (#4411)
    
    [DX-1261] Update partitioned-policies.md with note about ACL (#4411)
    
    Update partitioned-policies.md with note about ACL
    Copy link

    tykbot bot commented Apr 16, 2024

    @dcs3spp Succesfully merged PR

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants