docs/deploy/rbac.md
This example applies to ingress-nginx-controllers being deployed in an environment with RBAC enabled.
Role Based Access Control is comprised of four layers:
ClusterRole - permissions assigned to a role that apply to an entire clusterClusterRoleBinding - binding a ClusterRole to a specific accountRole - permissions assigned to a role that apply to a specific namespaceRoleBinding - binding a Role to a specific accountIn order for RBAC to be applied to an ingress-nginx-controller, that controller
should be assigned to a ServiceAccount. That ServiceAccount should be
bound to the Roles and ClusterRoles defined for the ingress-nginx-controller.
One ServiceAccount is created in this example, ingress-nginx.
There are two sets of permissions defined in this example. Cluster-wide
permissions defined by the ClusterRole named ingress-nginx, and
namespace specific permissions defined by the Role named ingress-nginx.
These permissions are granted in order for the ingress-nginx-controller to be
able to function as an ingress across the cluster. These permissions are
granted to the ClusterRole named ingress-nginx
configmaps, endpoints, nodes, pods, secrets: list, watchnodes: getservices, ingresses, ingressclasses, endpointslices: get, list, watchevents: create, patchingresses/status: updateleases: list, watchThese permissions are granted specific to the ingress-nginx namespace. These
permissions are granted to the Role named ingress-nginx
configmaps, pods, secrets: getendpoints: getFurthermore to support leader-election, the ingress-nginx-controller needs to
have access to a leases using the resourceName ingress-nginx-leader
Note that resourceNames can NOT be used to limit requests using the “create” verb because authorizers only have access to information that can be obtained from the request URL, method, and headers (resource names in a “create” request are part of the request body).
leases: get, update (for resourceName ingress-controller-leader)leases: createThis resourceName is the election-id defined by the ingress-controller, which defaults to:
election-id: ingress-controller-leaderresourceName : <election-id>Please adapt accordingly if you overwrite either parameter when launching the ingress-nginx-controller.
The ServiceAccount ingress-nginx is bound to the Role
ingress-nginx and the ClusterRole ingress-nginx.
The serviceAccountName associated with the containers in the deployment must match the serviceAccount. The namespace references in the Deployment metadata, container arguments, and POD_NAMESPACE should be in the ingress-nginx namespace.