Skip to content

Commit ac54abb

Browse files
tstraleymjang
andauthored
Update and clarify NGINX One RBAC docs (#265)
* Update and clarify NGINX One RBAC docs --------- Co-authored-by: Mike Jang <[email protected]>
1 parent a3870f7 commit ac54abb

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

content/nginx-one/rbac/rbac-api.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ product: NGINX One
77
docs: DOCS-000
88
---
99

10-
Beyond [Default roles]({{< relref "/nginx-one/rbac/roles.md" >}}), you may need to set up custom roles. For convenience, we include a list of API groups that you could use to specify permissions for custom roles.
11-
12-
These are not NGINX One APIs.
10+
Beyond the [Default roles]({{< relref "/nginx-one/rbac/roles.md" >}}) for NGINX One Console access, you can create [custom roles](https://docs.cloud.f5.com/docs-v2/administration/how-tos/user-mgmt/roles#custom-roles) with more precisely defined access permissions.
11+
You can assign custom roles to users or service accounts. You can associate these roles with specific namespaces, to help facilitate the principle of least privilege across your tenant.
12+
For this use-case, we include a list of API groups that you can use to specify permissions for custom roles with more granular access controls to NGINX One Console APIs.
1313

1414
## F5 API groups for NGINX One
1515

16-
The following table lists the **[F5 XC roles](https://docs.cloud.f5.com/docs-v2/administration/how-tos/user-mgmt/roles)** that you can use. These are narrowly scoped API Groups that align with all the features and functionality within the NGINX One Console. These groups can help you create custom roles tailored to your specific needs.
16+
The following table lists the available API groups that you can use to construct a Role. These are narrowly scoped API groups that align with all the features and functionality within the NGINX One Console. These groups can help you create custom roles tailored to your specific needs.
1717

18-
{{< note >}}If you create custom roles using the more granular API Groups, users may not have access until you add the corresponding API Groups to their roles.{{< /note >}}
18+
{{< note >}}If you create custom roles using these API groups, users may not have access to all capabilities of the browser web portal.{{< /note >}}
1919

2020
| API Group Name | Level of Access | Description |
2121
|-----------------------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------|
@@ -27,7 +27,7 @@ The following table lists the **[F5 XC roles](https://docs.cloud.f5.com/docs-v2/
2727
| f5xc-nginx-one-custom-all-instances-manage | Write | View and delete all Instances. |
2828
| f5xc-nginx-one-custom-instance-manage | Write | View and edit Instance details. |
2929
| f5xc-nginx-one-custom-instance-read | Read | View Instance and configuration details. |
30-
| f5xc-nginx-one-custom-certificate-manage | Write | View TSL/SSL certificate details. Create, update, and delete any managed certificates. |
30+
| f5xc-nginx-one-custom-certificate-manage | Write | View TLS/SSL certificate details. Create, update, and delete any managed certificates. |
3131
| f5xc-nginx-one-custom-certificate-read | Read | View TLS/SSL certificates. |
3232
| f5xc-nginx-one-custom-all-certificates-manage | Write | View all TLS/SSL certificates. Delete managed certificates. |
3333
| f5xc-nginx-one-custom-data-plane-key-manage | Write | View, create, update, and delete any Data Plane Keys. Note: The actual Data Plane Key is shown _only_ when created. |

content/nginx-one/rbac/roles.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,14 @@ We provide three default **[roles](https://docs.cloud.f5.com/docs-v2/administrat
1313

1414
### Admin
1515

16-
The Admin role, identified as <code>f5xc-nginx-one-admin</code>, provides full read and write access to all endpoints and features within the NGINX One Console.
16+
The Admin role, identified as `f5xc-nginx-one-admin`, provides full read and write access to all endpoints and features within the NGINX One Console.
17+
It also supports RBAC for related XC services, as described in [Role-based Access Control Concepts](https://flatrender.tora.reviews/docs-v2/administration/how-tos/user-mgmt/rbac).
1718

1819
### User
1920

20-
Our standard User role, listed as <code>f5xc-nginx-one-user</code> in the role list, provides read and write access to all endpoints and features, save for those considered to be administrator level. An example of an administrator level feature would be **[Instance Settings](https://docs.nginx.com/nginx-one/how-to/nginx-configs/clean-up-unavailable-instances/)** where unavailable instance clean up logic is set.
21+
Our standard User role, listed as `f5xc-nginx-one-user` in the role list, provides read and write access to all endpoints and features, save for those considered to be administrator level. An example of an administrator level feature would be **[Instance Settings](https://docs.nginx.com/nginx-one/how-to/nginx-configs/clean-up-unavailable-instances/)** where unavailable instance clean up logic is set.
2122

2223
### Monitor
2324

24-
Our read only or Monitor role, <code>f5xc-nginx-one-monitor</code>, grants read only access to all non-administrator features and endpoints within the NGINX One Console.
25+
Our read only or Monitor role, `f5xc-nginx-one-monitor`, grants read only access to all non-administrator features and endpoints within the NGINX One Console.
2526

0 commit comments

Comments
 (0)