8.9. capabilities に関連するプロダクトカスタムリソース

• applicationPlans マップキー名は 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 フィールドを使用して、バックエンドメトリックの所有者を参照します。

手順

• 以下の例に示すように、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 フィールドを使用して、バックエンドメトリックの所有者を参照します。

手順

• 以下の例に示すように、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: Red Hat Single Sign-On (RH-SSO) 使用時の keycloak の値およびサードパーティー IdP との統合時の rest の値。
• issuerEndpoint: 必要なクレデンシャルを持つ URL。

前提条件

• RH-SSO を設定しておく。Red Hat Single Sign-On の設定 を参照してください。
• サードパーティーアイデンティティープロバイダーとの HTTP インテグレーションを設定している。

関連情報

• Product CRD Reference

• metrics マップキー名は system_name として使用されます。以下の例では、metric01 および hits です。
• metrics マップキー名は、すべてのメトリックおよびメソッド間で一意である必要があります。
• unit および friendlyName は必須フィールドです。
• hits メトリックを追加しない場合は、operator によって作成されます。

手順

• 以下の例に示すように、新しい 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 プロダクトの内部 ID

• conditions: status.Conditions Kubernetes 共通パターンを表します。これには、以下のタイプまたは状態があります。

  • Failed: 同期中にエラーが発生しています。操作はリトライされます。
  • Synced: プロダクトは正常に同期されています。
  • Invalid: オブジェクトが無効です。これは一時的なエラーではなく、無効な使用が報告され、それを変更する必要があります。操作はリトライされません。
  • Orphan: 仕様は存在しないリソースを参照しています。operator はリトライします。
• observedGeneration: ステータス情報が最新のリソース仕様で更新されていることを確認します。
• state: 3scale API から読み取られた 3scale プロダクトの内部状態。
• providerAccountHost: バックエンドが同期される 3scale プロバイダーアカウントの URL。

前提条件

• 削除するカスタムリソースが含まれる namespace の削除パーミッションが指定された 3scale 管理者権限または OpenShift ロール。特定の Product カスタムリソースを削除できるユーザーを特定するには、oc policy who-can delete コマンドを実行します。たとえば、CR の名前が myproduct の場合には、以下のコマンドを実行します。

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

• 有効なテナントへのリンクを削除する Product CR。

手順

• oc delete コマンドを実行して、Product カスタムリソースを削除します。たとえば、myproduct.yaml ファイルで定義した Product をデプロイした場合は、以下のコマンドを実行します。

  oc delete -f myproduct.yaml

  または、oc delete コマンドを実行して、定義で指定した製品の名前を指定します。以下に例を示します。

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