Skip to content

Add NGF permissions document #810

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

Merged
merged 4 commits into from
Jul 15, 2025

Conversation

sarthyparty
Copy link
Contributor

@sarthyparty sarthyparty commented Jul 14, 2025

Proposed changes

Add a NGF permissions document so that users can see what the security context of NGF is and what permissions it requires.

Problem: Users don't know about NGF security and permissions.

Solution: I added a permissions document that helps with that.

Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

Copy link

github-actions bot commented Jul 14, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Jul 14, 2025
@sarthyparty
Copy link
Contributor Author

I have hereby read the F5 CLA and agree to its terms

@sjberman sjberman requested a review from a team July 14, 2025 17:07
  - Clarify root filesystem as read-only except for writable volumes
  - Generalize volume descriptions for better maintainability
  - Change namespace reference to "control plane namespace"
  - Remove privilege escalation exceptions and troubleshooting
  - Improve document structure and readability
@sarthyparty sarthyparty requested a review from sjberman July 14, 2025 18:15
@sarthyparty sarthyparty requested a review from sjberman July 14, 2025 18:39
@sarthyparty sarthyparty marked this pull request as ready for review July 14, 2025 18:54
@sarthyparty sarthyparty requested a review from a team as a code owner July 14, 2025 18:54
@sarthyparty sarthyparty merged commit a1a004b into nginx:main Jul 15, 2025
7 checks passed
@sarthyparty sarthyparty deleted the add-ngf-permissions-doc branch July 15, 2025 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants