8.9. 与功能相关的产品自定义资源

• applicationPlans map 键名称将用作 system_name。在以下示例中： plan01 和 plan02。

流程

• 在新的 3scale 产品中添加应用程序计划，如下例所示：

  apiVersion: capabilities.3scale.net/v1beta1
  kind: Product
  metadata:
    name: product1
  spec:
    name: "OperatedProduct 1"
    applicationPlans:
      plan01:
        name: "My Plan 01"
        setupFee: "14.56"
      plan02:
        name: "My Plan 02"
        trialPeriod: 3
        costMonth: 3

• period、value 和 metricMethodRef 是必填字段。
• metricMethodRef 引用可以是产品，也可以是后端引用。使用可选的 backend 字段来引用 backend 指标的所有者。

流程

• 为 3scale 产品的应用程序计划定义限值，如下例所示：

  apiVersion: capabilities.3scale.net/v1beta1
  kind: Product
  metadata:
    name: product1
  spec:
    name: "OperatedProduct 1"
    metrics:
      hits:
        description: Number of API hits
        friendlyName: Hits
        unit: "hit"
    applicationPlans:
      plan01:
        name: "My Plan 01"
        limits:
          - period: month
            value: 300
            metricMethodRef:
              systemName: hits
              backend: backendA
          - period: week
            value: 100
            metricMethodRef:
              systemName: hits

• from, to, pricePerUnit 和 metricMethodRef 是必填字段。
• from 和 to 将被验证。对于任何规则，from 的值小于 to，对同一个规则有相互重叠的范围不被允许。
• metricMethodRef 引用可以是产品，也可以是后端引用。使用可选的 backend 字段来引用 backend 指标的所有者。

流程

• 为 3scale 产品的应用计划定义定价规则，如下例所示：

  apiVersion: capabilities.3scale.net/v1beta1
  kind: Product
  metadata:
    name: product1
  spec:
    name: "OperatedProduct 1"
    metrics:
      hits:
        description: Number of API hits
        friendlyName: Hits
        unit: "hit"
    applicationPlans:
      plan01:
        name: "My Plan 01"
        pricingRules:
          - from: 1
            to: 100
            pricePerUnit: "15.45"
            metricMethodRef:
              systemName: hits
          - from: 1
            to: 300
            pricePerUnit: "15.45"
            metricMethodRef:
              systemName: hits
              backend: backendA

• issuerType：在与第三方 IdP 集成时，使用红帽单点登录 (RH-SSO) 以及 rest 值时，会使用 keycloak 值。
• issuerEndpoint ：其中包含所需凭证的 URL。

前提条件

• 您必须配置 RH-SSO。请参阅 配置红帽单点登录。
• 您必须 配置 HTTP 与第三方身份提供程序的集成。

其他资源

• 产品 CRD 参考。

• metrics 映射键名称将用作 system_name。在以下示例中： metric01 和 hits。
• 在所有指标和方法中，指标 metrics 键名称都必须是唯一的。
• unit 和 friendlyName 是必填字段。
• 如果没有添加 hits 指标，它将由操作器创建。

流程

• 在新的 3scale 后端中添加产品指标，如下例所示：

  apiVersion: capabilities.3scale.net/v1beta1
  kind: Product
  metadata:
    name: product1
  spec:
    name: "OperatedProduct 1"
    metrics:
      metric01:
        friendlyName: Metric01
        unit: "1"
      hits:
        description: Number of API hits
        friendlyName: Hits
        unit: "hit"

• 映射键名称的methods 将用作 system_name。在以下示例中： Method01 和 Method02。
• 在所有指标和方法中，methods 映射键名称必须是唯一的。
• friendlyName 是一个必填字段。

流程

• 在新的 3scale 产品中添加方法，如下例所示：

  apiVersion: capabilities.3scale.net/v1beta1
  kind: Product
  metadata:
    name: product1
  spec:
    name: "OperatedProduct 1"
    methods:
      method01:
        friendlyName: Method01
      method02:
        friendlyName: Method02

• httpMethod, pattern, increment 和 metricMethodRef 是必填字段。
• metricMethodRef 包含对现有指标或方法映射键名称 system_name 的引用。在以下示例中，hits。

流程

• 将产品映射规则添加到新的 3scale 后端，如下例所示：

  apiVersion: capabilities.3scale.net/v1beta1
  kind: Product
  metadata:
    name: product1
  spec:
    name: "OperatedProduct 1"
    metrics:
      hits:
        description: Number of API hits
        friendlyName: Hits
        unit: "hit"
    methods:
      method01:
        friendlyName: Method01
    mappingRules:
      - httpMethod: GET
        pattern: "/pets"
        increment: 1
        metricMethodRef: hits
      - httpMethod: GET
        pattern: "/cars"
        increment: 1
        metricMethodRef: method01

• path 是必填字段。
• backendUsages 映射密钥名称引用后端的 system_name。在以下示例中：backendA 和 backendB。

流程

• 在产品中添加后端以声明性地定义其使用情况，如下例所示：

  apiVersion: capabilities.3scale.net/v1beta1
  kind: Product
  metadata:
    name: product1
  spec:
    name: "OperatedProduct 1"
    backendUsages:
      backendA:
        path: /A
      backendB:
        path: /B

• productId ：3scale 产品的内部标识符。

• Conditions ：代表 status.Conditions Kubernetes 通用模式。它有这些类型或状态：

  • Failed ：同步过程中发生了错误。操作将重试。
  • 同步 ：产品已成功同步。
  • 无效 ：无效对象。这不是临时错误，但它报告无效规格，应该进行更改。Operator 不会重试。
  • Orphan: 规格引用不存在的资源。操作器将重试。
• observedGeneration：确认状态信息已使用最新的资源规格更新。
• State ：从 3scale API 读取的 3scale 产品内部状态。
• providerAccountHost ：与后端同步的 3scale 供应商帐户 URL。

前提条件

• 3scale 管理员权限或具有删除命名空间中具有删除权限的 OpenShift 角色，其中包含您要删除的自定义资源。要识别可以删除特定 产品 自定义资源的人员，请运行 oc policy who-can delete 命令。例如，如果 CR 中的名称是 myproduct，则运行这个命令：

  oc policy who-can delete product.capabilities.3scale.net/myproduct

• 要删除到有效租户的链接的 Product CR。

流程

• 运行 oc delete 命令删除 产品 自定义资源。例如，如果您部署了 myproduct.yaml 文件中定义的 产品，则可运行以下命令：

  oc delete -f myproduct.yaml

  或者，您可以运行 oc delete 命令并指定其定义中指定的产品名称。例如：

  oc delete product.capabilities.3scale.net/myproduct