Chapter 6. Configuration and provision of 3scale via the operator

• metrics map key names will be used as system_name. In the example below: metric01, metric02 and hits.
• metrics map key names must be unique among all metrics and methods.
• unit and friendlyName are required fields.
• If you do not add a hits metric, this metric will be created by the operator.

Procedure

• Add backend metrics to the new 3scale backend, as in this example:

  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 map key names will be used as system_name. In the example below: Method01 and Method02.
• methods map key names must be unique among all metrics and methods.
• friendlyName is a required field.

Procedure

• Add backend methods to the new 3scale backend, as in this example:

  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 and metricMethodRef are required fields.
• metricMethodRef holds a reference to the existing metric or method map key name system_name. In the example below, hits.

Procedure

• Add backend mapping rules to the new 3scale backend, as in this example:

  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: The internal identifier of a 3scale backend.

• conditions: Represents the status.Conditions Kubernetes common pattern. It has these types, or states:

  • Invalid: The combination of configuration in the BackendSpec is not supported. This is not a transient error, but indicates a state that must be fixed before progress can be made.
  • Synced: The backend has been successfully synchronized.
  • Failed: An error occurred during synchronization.
• observedGeneration: It is a helper field to confirm that the status information is updated with the latest resource specification.

• applicationPlans map key names will be used as system_name. In the example below: plan01 and plan02.

Procedure

• Add application plans to the new 3scale product, as in this example:

  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 and metricMethodRef are required fields.
• The metricMethodRef reference can be either a product or a backend reference. Use the optional backend field to reference the owner of the backend metric.

Procedure

• Define limits for the application plans of an 3scale product, as in this example:

  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 and metricMethodRef are required fields.
• from and to will be validated. For any rule, values of from less than to and overlapping ranges for the same metric are not allowed.
• The metricMethodRef reference can be either a product or a backend reference. Use the optional backend field to reference the owner of the backend metric.

Procedure

• Define pricing rules for the application plans of an 3scale product, as in this example:

  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

• metrics map key names will be used as system_name. In the example below: metric01 and hits.
• metrics map key names must be unique among all metrics and methods.
• unit and friendlyName are required fields.
• If you do not add a hits metric, it will be created by the operator.

Procedure

• Add product metrics to the new 3scale backend, as in this example:

  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 map key names will be used as system_name. In the example below: Method01 and Method02.
• methods map key names must be unique among all metrics and methods.
• friendlyName is a required field.

Procedure

• Add methods to the new 3scale product, as in this example:

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

• httpMethod, pattern, increment and metricMethodRef are required fields.
• metricMethodRef holds a reference to the existing metric or method map key name system_name. In the example below, hits.

Procedure

• Add product mapping rules to the new 3scale backend, as in this example:

  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 is a required field.
• backendUsages map key names are references to the backend’s system_name. In the example below: backendA and backendB.

Procedure

• Add a backend to a product to define its usage declaratively, as in this example:

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

• productId: The internal identifier of a 3scale product.

• conditions: Represents the status.Conditions Kubernetes common pattern. It has these types, or states:

  • Failed: An error occurred during synchronization. The operation will retry.
  • Synced: The product has been successfully synchronized.
  • Invalid: Invalid object. This is not a transient error, but it reports about an invalid specification and it should be changed. The operator will not retry.
  • Orphan: The specification references a resource that does not exist. The operator will retry.
• observedGeneration: Confirms that the status information is updated with the latest resource specification.
• state: The 3scale product internal state read from the 3scale API.
• providerAccountHost: The 3scale provider account URL to which the backend is synchronized.