8.8. capabilities に関連するバックエンドカスタムリソース

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

手順

• 以下の例に示すように、新しい 3scale バックエンドにバックエンドメトリクスを追加します。

  apiVersion: capabilities.3scale.net/v1beta1
  kind: Backend
  metadata:
    name: backend-1
  spec:
    name: "My Backend Name"
    privateBaseURL: "https://api.example.com"
    metrics:
      metric01:
        friendlyName: Metric01
        unit: "1"
      metric02:
        friendlyName: Metric02
        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: Backend
  metadata:
    name: backend-1
  spec:
    name: "My Backend Name"
    privateBaseURL: "https://api.example.com"
    methods:
      method01:
        friendlyName: Method01
      method02:
        friendlyName: Method02

• httpMethod、pattern、increment、および metricMethodRef は必須フィールドです。
• metricMethodRef は、既存のメトリクスまたはメソッドマップキー名 system_name への参照を保持します。以下の例では、hits です。

手順

• 以下の例に示すように、新しい 3scale バックエンドにバックエンドマッピングルールを追加します。

  apiVersion: capabilities.3scale.net/v1beta1
  kind: Backend
  metadata:
    name: backend-1
  spec:
    name: "My Backend Name"
    privateBaseURL: "https://api.example.com"
    mappingRules:
      - httpMethod: GET
        pattern: "/pets"
        increment: 1
        metricMethodRef: hits
      - httpMethod: GET
        pattern: "/pets/id"
        increment: 1
        metricMethodRef: hits
    metrics:
      hits:
        description: Number of API hits
        friendlyName: Hits
        unit: "hit"

• backendId: 3scale バックエンドの内部 ID。

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

  • Invalid: BackendSpec の設定の組み合わせはサポート対象外です。これは一時的なエラーではなく、進捗するには修正する必要がある状態を示します。
  • Synced: バックエンドは正常に同期されています。
  • Failed: 同期中にエラーが発生しています。
• observedGeneration: ステータス情報が最新のリソース仕様で更新されていることを確認するヘルパーフィールドです。