Skip to content

Commit c3ea3b8

Browse files
docs: Updated the content of deploy/rbac.md (#10054)
Due to Kubernetes having deprecated the use of configmap as a mechanism for elections, we have migrated to a mechanism based on leases resources. However, the documentation has not been updated, resulting in inconsistencies. Signed-off-by: Jintao Zhang <[email protected]>
1 parent 712e10d commit c3ea3b8

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/deploy/rbac.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,39 +29,38 @@ namespace specific permissions defined by the `Role` named `ingress-nginx`.
2929

3030
These permissions are granted in order for the ingress-nginx-controller to be
3131
able to function as an ingress across the cluster. These permissions are
32-
granted to the ClusterRole named `ingress-nginx`
32+
granted to the `ClusterRole` named `ingress-nginx`
3333

3434
* `configmaps`, `endpoints`, `nodes`, `pods`, `secrets`: list, watch
3535
* `nodes`: get
36-
* `services`, `ingresses`: get, list, watch
36+
* `services`, `ingresses`, `ingressclasses`, `endpointslices`: get, list, watch
3737
* `events`: create, patch
3838
* `ingresses/status`: update
39+
* `leases`: list, watch
3940

4041
### Namespace Permissions
4142

4243
These permissions are granted specific to the ingress-nginx namespace. These
43-
permissions are granted to the Role named `ingress-nginx`
44+
permissions are granted to the `Role` named `ingress-nginx`
4445

4546
* `configmaps`, `pods`, `secrets`: get
4647
* `endpoints`: get
4748

4849
Furthermore to support leader-election, the ingress-nginx-controller needs to
49-
have access to a `configmap` using the resourceName `ingress-controller-leader-nginx`
50+
have access to a `leases` using the resourceName `ingress-nginx-leader`
5051

5152
> Note that resourceNames can NOT be used to limit requests using the “create”
5253
> verb because authorizers only have access to information that can be obtained
5354
> from the request URL, method, and headers (resource names in a “create” request
5455
> are part of the request body).
5556
56-
* `configmaps`: get, update (for resourceName `ingress-controller-leader-nginx`)
57-
* `configmaps`: create
57+
* `leases`: get, update (for resourceName `ingress-controller-leader`)
58+
* `leases`: create
5859

59-
This resourceName is the concatenation of the `election-id` and the
60-
`ingress-class` as defined by the ingress-controller, which defaults to:
60+
This resourceName is the `election-id` defined by the ingress-controller, which defaults to:
6161

6262
* `election-id`: `ingress-controller-leader`
63-
* `ingress-class`: `nginx`
64-
* `resourceName` : `<election-id>-<ingress-class>`
63+
* `resourceName` : `<election-id>`
6564

6665
Please adapt accordingly if you overwrite either parameter when launching the
6766
ingress-nginx-controller.

0 commit comments

Comments
 (0)