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

Added documentation for granular API groups feature in NGINX One #370

Merged
merged 2 commits into from
Apr 4, 2025

Conversation

kamalchaturvedi
Copy link
Contributor

@kamalchaturvedi kamalchaturvedi commented Apr 3, 2025

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: Added changelog entry for already existing documentation for granular API groups in NGINX one.

Solution: N/A

Testing: Describe any testing that you did.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an issue on GitHub, ensure that you link to it here:

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 and CHANGELOG.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.

@kamalchaturvedi kamalchaturvedi requested a review from a team as a code owner April 3, 2025 23:23
Copy link

github-actions bot commented Apr 3, 2025

🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree:


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


1 out of 2 committers have signed the CLA.
✅ (mjang)[https://github.com/mjang]
@kamal Chaturvedi
Kamal Chaturvedi seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-one NGINX One Console labels Apr 3, 2025
@kamalchaturvedi
Copy link
Contributor Author

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

@jasonclopper
Copy link

@kamalchaturvedi this references Namespace updates as well, Didn't think that was ready yet?

@kamalchaturvedi
Copy link
Contributor Author

@kamalchaturvedi this references Namespace updates as well, Didn't think that was ready yet?

Those are XC namespaces, as referred to in the intro section of this page: https://docs.nginx.com/nginx-one/rbac/rbac-api/

You can associate these roles with specific namespaces, to help facilitate the principle of least privilege across your tenant.

Would adding a note regarding N1 support for namespaces coming soon help with this ? I wanted to ensure we give user the knowledge of how namespaces can help them segregate these permissions.

Otherwise, i am fine removing this line if it causes confusion.

Copy link
Contributor

@mjang mjang 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 PR, @kamalchaturvedi !

TLDR: I've tried to retain the essential info, while making the content easier to read. I also think that it's better to link to https://docs.nginx.com/nginx-one/rbac/rbac-api/.

@mjang
Copy link
Contributor

mjang commented Apr 4, 2025

Hi @kamalchaturvedi

Inote: if this doesn't work, I have privileges to override and merge this PR.)


Kamal Chaturvedi seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@jasonclopper
Copy link

I think Mike's changes are good.

@mjang
Copy link
Contributor

mjang commented Apr 4, 2025

Based on @jasonclopper 's approval, I'll merge my changes and approve and merge.

@mjang mjang merged commit c1e6ee0 into nginx:main Apr 4, 2025
3 of 4 checks passed
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/nginx-one NGINX One Console
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants