Merge pull request #34227 from tengqm/zh-eventratelimit-api

[zh] Translate eventratelimit API (v1alpha1)
pull/34256/head
Kubernetes Prow Robot 2022-06-12 20:42:10 -07:00 committed by GitHub
commit b9182dbb2b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 152 additions and 0 deletions

View File

@ -0,0 +1,152 @@
---
title: Event Rate Limit Configuration (v1alpha1)
content_type: tool-reference
package: eventratelimit.admission.k8s.io/v1alpha1
---
<!--
## Resource Types
-->
## 资源类型 {#resource-types}
- [Configuration](#eventratelimit-admission-k8s-io-v1alpha1-Configuration)
## `Configuration` {#eventratelimit-admission-k8s-io-v1alpha1-Configuration}
<!--
<p>Configuration provides configuration for the EventRateLimit admission
controller.</p>
-->
<p>Configuration 为 EventRateLimit 准入控制器提供配置数据。</p>
<table class="table">
<thead><tr><th width="30%"><!--Field-->字段</th><th><!--Description-->描述</th></tr></thead>
<tbody>
<tr><td><code>apiVersion</code><br/>string</td><td><code>eventratelimit.admission.k8s.io/v1alpha1</code></td></tr>
<tr><td><code>kind</code><br/>string</td><td><code>Configuration</code></td></tr>
<tr><td><code>limits</code> <B>[Required]</B><br/>
<a href="#eventratelimit-admission-k8s-io-v1alpha1-Limit"><code>[]Limit</code></a>
</td>
<td>
<!--
<p>limits are the limits to place on event queries received.
Limits can be placed on events received server-wide, per namespace,
per user, and per source+object.
At least one limit is required.</p>
-->
<p>limits 是为所接收到的事件查询设置的限制。可以针对服务器端接收到的事件设置限制,
按逐个名字空间、逐个用户、或逐个来源+对象组合的方式均可以。
至少需要设置一种限制。</p>
</td>
</tr>
</tbody>
</table>
## `Limit` {#eventratelimit-admission-k8s-io-v1alpha1-Limit}
<!--
**Appears in:**
-->
**出现在:**
- [Configuration](#eventratelimit-admission-k8s-io-v1alpha1-Configuration)
<!--
<p>Limit is the configuration for a particular limit type</p>
-->
<p>Limit 是为特定限制类型提供的配置数据。</p>
<table class="table">
<thead><tr><th width="30%"><!--Field-->字段</th><th><!--Description-->描述</th></tr></thead>
<tbody>
<tr><td><code>type</code> <B><!--[Required]-->[必需]</B><br/>
<a href="#eventratelimit-admission-k8s-io-v1alpha1-LimitType"><code>LimitType</code></a>
</td>
<td>
<!--
<p>type is the type of limit to which this configuration applies</p>
-->
<p>type 是此配置所适用的限制的类型。</p>
</td>
</tr>
<tr><td><code>qps</code> <B><!--[Required]-->[必需]</B><br/>
<code>int32</code>
</td>
<td>
<!--
<p>qps is the number of event queries per second that are allowed for this
type of limit. The qps and burst fields are used together to determine if
a particular event query is accepted. The qps determines how many queries
are accepted once the burst amount of queries has been exhausted.</p>
-->
<p>qps 是针对此类型的限制每秒钟所允许的事件查询次数。qps 和 burst
字段一起用来确定是否特定的事件查询会被接受。qps 确定的是当超出查询数量的
burst 值时可以接受的查询个数。</p>
</td>
</tr>
<tr><td><code>burst</code> <B><!--[Required]-->[必需]</B><br/>
<code>int32</code>
</td>
<td>
<!--
<p>burst is the burst number of event queries that are allowed for this type
of limit. The qps and burst fields are used together to determine if a
particular event query is accepted. The burst determines the maximum size
of the allowance granted for a particular bucket. For example, if the burst
is 10 and the qps is 3, then the admission control will accept 10 queries
before blocking any queries. Every second, 3 more queries will be allowed.
If some of that allowance is not used, then it will roll over to the next
second, until the maximum allowance of 10 is reached.</p>
-->
<p>burst 是针对此类型限制的突发事件查询数量。qps 和 burst 字段一起使用可用来确定特定的事件查询是否被接受。
burst 字段确定针对特定的事件桶bucket可以接受的规模上限。
例如,如果 burst 是 10qps 是 3那么准入控制器会在接收 10 个查询之后阻塞所有查询。
每秒钟可以额外允许 3 个查询。如果这一限额未被用尽,则剩余的限额会被顺延到下一秒钟,
直到再次达到 10 个限额的上限。</p>
</td>
</tr>
<tr><td><code>cacheSize</code><br/>
<code>int32</code>
</td>
<td>
<!--
<p>cacheSize is the size of the LRU cache for this type of limit. If a bucket
is evicted from the cache, then the allowance for that bucket is reset. If
more queries are later received for an evicted bucket, then that bucket
will re-enter the cache with a clean slate, giving that bucket a full
allowance of burst queries.</p>
<p>The default cache size is 4096.</p>
<p>If limitType is 'server', then cacheSize is ignored.</p>
-->
<p>cacheSize 是此类型限制的 LRU 缓存的规模。如果某个事件桶bucket被从缓存中剔除
该事件桶所对应的限额也会被重置。如果后来再次收到针对某个已被剔除的事件桶的查询,
则该事件桶会重新以干净的状态进入缓存,因而获得全量的突发查询配额。</p>
<p>默认的缓存大小是 4096。</p>
<p>如果 limitType 是 “server”则 cacheSize 设置会被忽略。</p>
</td>
</tr>
</tbody>
</table>
## `LimitType` {#eventratelimit-admission-k8s-io-v1alpha1-LimitType}
<!--
(Alias of `string`)
**Appears in:**
-->
`string` 类型的别名)
**出现在:**
- [Limit](#eventratelimit-admission-k8s-io-v1alpha1-Limit)
<!--
<p>LimitType is the type of the limit (e.g., per-namespace)</p>
-->
<p>LimitType 是限制类型例如per-namespace</p>