第 3 章 计划策略配置参考


了解您需要配置 Plan 策略的每个组件的详细参考。

3.1. PlanPolicy 自定义资源参数

了解 PlanPolicy 自定义资源的配置参数,以便可以有效地使用对象。

表 3.1. PlanPolicy 自定义资源配置字段定义表
参数描述

spec.targetRef

对现有网关 API 资源的引用。PlanPolicy 对象可以以网关、HTTPRoute 或 GRPCRoute 为目标。目标资源必须与 PlanPolicy 对象位于同一个命名空间中。

spec.plans

排序计划定义列表。计划按顺序评估,以及应用为 true 的第一个计划。在更常规的 predicates 之前,必须会显示更具体的 predicates。

spec.plans.tier

计划层的唯一标识符,如 金级 (silver )或 bronze。

spec.plans.predicate

指定针对经过身份验证的请求上下文评估的通用表达式语言(CEL)表达式。

spec.plans.limits

指定层的速率限制配置。

3.2. 在 PlanPolicy 中目标 HTTPRoute

当 PlanPolicy 对象以 HTTPRoute 自定义资源(CR)为目标时,您可以使用以下示例对通过该特定路由的所有流量流实施基于计划的速度限制。

HTTPRoute CR 流量实施基于计划率限制的示例

apiVersion: extensions.kuadrant.io/v1alpha1
kind: PlanPolicy
metadata:
  name: <sample_app>
  namespace: ${KUADRANT_DEVELOPER_NS}
spec:
  targetRef:
    group: gateway.networking.k8s.io
    kind: HTTPRoute
    name: <sample_app>
  plans:
    - tier: gold
      predicate: |
        has(auth.identity) && auth.identity.metadata.annotations["secret.kuadrant.io/plan-id"] == "gold"
      limits:
        daily: 1000
        weekly: 5000
    - tier: silver
      predicate: |
        has(auth.identity) && auth.identity.metadata.annotations["secret.kuadrant.io/plan-id"] == "silver"
      limits:
        daily: 500
        weekly: 2000
    - tier: bronze
      predicate: |
        has(auth.identity) && auth.identity.metadata.annotations["secret.kuadrant.io/plan-id"] == "bronze"
      limits:
        daily: 100
        weekly: 500

  • 将 <sample_app > 替换为应用程序的名称。
  • 将 ${KUADRANT_DEVELOPER_NS} 替换为您的对象的命名空间。

    注意

    Common Expression Language (CEL)表达式可以是适用于您的用例的任何表达式。您可以使用与 secret.kuadrant.io/plan-id 表达式不同的表达式。

3.3. 在 PlanPolicy 中目标 GRPCRoute

当 PlanPolicy 对象以 GRPCRoute 自定义资源(CR)为目标时,您可以使用以下示例对通过该特定路由的所有流量流实施基于计划的速率限制:

GRPCRoute CR 流量实施基于计划率限制的示例

apiVersion: extensions.kuadrant.io/v1alpha1
kind: PlanPolicy
metadata:
  name: <sample_app>
  namespace: ${KUADRANT_DEVELOPER_NS}
spec:
  targetRef:
    group: gateway.networking.k8s.io
    kind: GRPCRoute
    name: <sample_app>
  plans:
    - tier: gold
      predicate: |
        has(auth.identity) && auth.identity.metadata.annotations["secret.kuadrant.io/plan-id"] == "gold"
      limits:
        daily: 1000
        weekly: 5000
    - tier: silver
      predicate: |
        has(auth.identity) && auth.identity.metadata.annotations["secret.kuadrant.io/plan-id"] == "silver"
      limits:
        daily: 500
        weekly: 2000
    - tier: bronze
      predicate: |
        has(auth.identity) && auth.identity.metadata.annotations["secret.kuadrant.io/plan-id"] == "bronze"
      limits:
        daily: 100
        weekly: 500

  • 将 <sample_app > 替换为应用程序的名称。
  • 将 {KUADRANT_DEVELOPER_NS} 替换为您的对象的命名空间。
注意

Common Expression Language (CEL)表达式可以是适用于您的用例的任何表达式。您可以使用与 secret.kuadrant.io/plan-id 表达式不同的表达式。

3.4. 在 PlanPolicy 中目标网关对象

当 PlanPolicy 对象以 网关 自定义资源(CR)为目标时,连接链接会强制对附加到该网关 CR 的所有路由强制实施基于计划的速率限制,如下例所示。

网关对象基于计划率限制的示例

apiVersion: extensions.kuadrant.io/v1alpha1
kind: PlanPolicy
metadata:
  name: <sample_app>
  namespace: ${KUADRANT_GATEWAY_NS}
spec:
  targetRef:
    group: gateway.networking.k8s.io
    kind: Gateway
    name: _<sample_app>
  plans:
    # ...

  • 将 <sample_app > 替换为应用程序的名称。
  • 将 ${KUADRANT_GATEWAY_NS} 替换为 网关 对象的命名空间

3.5. PlanPolicies 中的 plan predicates

Plan predicates 是 CEL 表达式,用于决定哪个计划层应用到一个请求。连接链接评估 predicates 按照它们出现在 spec.plans 中的顺序,并选择第一个 predicate 返回 true 的顺序。

支持以下模式:

由 API 密钥 Secret 上的注解标识的计划
predicate: |
  has(auth.identity) && auth.identity.metadata.annotations["secret.kuadrant.io/plan-id"] == "gold"
由 JWT 声明标识的计划
predicate: |
  has(auth.identity) && auth.identity.sub == "premium-user"
由多个条件标识的计划
predicate: |
  has(auth.identity) &&
  auth.identity.metadata.annotations["secret.kuadrant.io/plan-id"] == "gold" &&
  auth.identity.metadata.labels["app"] == "my-app"

每个 predicate 开始时的 has (auth.identity) 检查确认请求在评估特定于计划的条件前确认已通过身份验证。

3.6. Plan Policy 对象的计划限制

每个计划定义中的 limits 字段设置每个时间窗内允许的最大请求数。所有字段都是可选的。仅指定与您的用例相关的窗口。

字段描述

daily

每个日历日的最大请求数。

weekly

每个日历每周的最大请求数。

monthly

每个日历月的最大请求数。

yearly

每个日历年的最大请求数。

custom

一个或多个自定义窗口。每个条目都需要一个 限制 (整数),以及 一个窗口 (持续时间字符串,如 "1h" 或 "1m"。

以下示例显示了使用所有可用限制类型的计划片断:

#...
limits:
  daily: 1000
  weekly: 5000
  monthly: 20000
  yearly: 200000
  custom:
    - limit: 100
      window: "1h"
#...
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

关于红帽文档

Legal Notice

Theme

© 2026 Red Hat
返回顶部