Skip to content

Commit 33aa282

Browse files
committed
Document the EventRateLimit admission controller
1 parent 8004acd commit 33aa282

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/admin/admission-controllers.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,42 @@ If your cluster supports containers that run with escalated privileges, and you
100100
restrict the ability of end-users to exec commands in those containers, we strongly encourage
101101
enabling this plug-in.
102102

103+
### EventRateLimit (alpha)
104+
105+
This plug-in is introduced in v1.9 to mitigate the problem where the API server gets flooded by
106+
event requests. The cluster admin can specify event rate limits by:
107+
108+
* Ensuring that `eventratelimit.admission.k8s.io/v1alpha1=true` is included in the
109+
`--runtime-config` flag for the API server;
110+
* Enabling the `EventRateLimit` admission controller;
111+
* Including a `EventRateLimit` configuration in the file provided to the API
112+
server's command line flag `--admission-control-config-file`.
113+
114+
There are four types of limits that can be specified in the configuration:
115+
116+
* `Server`: All event requests received by the API server share a single bucket.
117+
* `Namespace`: Each namespace has a dedicated bucket.
118+
* `User`: Each user is allocated a bucket.
119+
* `SourceAndObject`: A bucket is assigned by each combination of source and
120+
involved object of the event.
121+
122+
Below is a sample snippet for such a configuration:
123+
124+
```yaml
125+
EventRateLimit:
126+
limits:
127+
- type: Namespace
128+
qps: 50
129+
burst: 100
130+
cacheSize: 2000
131+
- type: User
132+
qps: 10
133+
burst: 50
134+
```
135+
136+
See the [EventRateLimit proposal](https://git.k8s.io/community/contributors/design-proposals/api-machinery/admission_control_event_rate_limit.md)
137+
for more details.
138+
103139
### GenericAdmissionWebhook (alpha)
104140
105141
This plug-in is related to the [Dynamic Admission Control](/docs/admin/extensible-admission-controllers)

0 commit comments

Comments
 (0)