Chapter 5. Capabilities: Provisioning 3scale services and configurations via the operator

Procedure

1. Click Catalog > Installed Operators.

   1. From the list of Installed Operators, click 3scale Operator.
2. Click the API tab.
3. Click Create API.

4. Clear the sample content and add the following YAML definitions to the editor, then click Create.

   apiVersion: capabilities.3scale.net/v1alpha1
   kind: API
   metadata:
     creationTimestamp: 2019-01-25T13:28:41Z
     generation: 1
     labels:
       environment: testing
     name: api01
   spec:
     planSelector:
       matchLabels:
         api: api01
     description: api01
     integrationMethod:
       apicastHosted:
         apiTestGetRequest: /
         authenticationSettings:
           credentials:
             apiKey:
               authParameterName: user-key
               credentialsLocation: headers
           errors:
             authenticationFailed:
               contentType: text/plain; charset=us-ascii
               responseBody: Authentication failed
               responseCode: 403
             authenticationMissing:
               contentType: text/plain; charset=us-ascii
               responseBody: Authentication Missing
               responseCode: 403
           hostHeader: ""
           secretToken: Shared_secret_sent_from_proxy_to_API_backend_9603f637ca51ccfe
         mappingRulesSelector:
           matchLabels:
             api: api01
         privateBaseURL: https://echo-api.3scale.net:443
     metricSelector:
       matchLabels:
         api: api01

   Copy to Clipboard Toggle word wrap
   Note

   All the selectors, (metric, plan, mappingrules) use a specific label api: api01. You can change this by adding more labels and configuring the selectors to cover complex scenarios.

Procedure

1. Click Catalog > Installed Operators.

   1. From the list of Installed Operators, click 3scale Operator.
2. Click the Plan tab.
3. Click Create Plan.

4. Clear the sample content and add the following YAML definitions to the editor, then click Create.

   apiVersion: capabilities.3scale.net/v1alpha1
   kind: Plan
   metadata:
     labels:
       api: api01
     name: plan01
   spec:
     approvalRequired: false
     default: true
     costs:
       costMonth: 0
       setupFee: 0
     limitSelector:
       matchLabels:
         api: api01
     trialPeriod: 0

   Copy to Clipboard Toggle word wrap

Procedure

1. Click Catalog > Installed Operators.

   1. From the list of Installed Operators, click 3scale Operator.
2. Click the Metric tab.
3. Click Create Metric.

4. Clear the sample content and add the following YAML definitions to the editor, then click Create.

   apiVersion: capabilities.3scale.net/v1alpha1
   kind: Metric
   metadata:
     labels:
       api: api01
     name: metric01
   spec:
     description: metric01
     unit: hit
     incrementHits: false

   Copy to Clipboard Toggle word wrap

Procedure

1. Click Catalog > Installed Operators.

   1. From the list of Installed Operators, click 3scale Operator.
2. Click the Limit tab.
3. Click Create Limit.

4. Clear the sample content and add the following YAML definitions to the editor, then click Create.

   apiVersion: capabilities.3scale.net/v1alpha1
   kind: Limit
   metadata:
     labels:
       api: api01
     name: plan01-metric01-day-10
   spec:
     description: Limit for metric01 in plan01
     maxValue: 10
     metricRef:
       name: metric01
     period: day

   Copy to Clipboard Toggle word wrap

Procedure

1. Click Catalog > Installed Operators.

   1. From the list of Installed Operators, click 3scale Operator.
2. Click the MappingRule tab.
3. Click Create Mapping Rule.

4. Clear the sample content and add the following YAML definitions to the editor, then click Create.

   apiVersion: capabilities.3scale.net/v1alpha1
   kind: MappingRule
   metadata:
     labels:
       api: api01
     name: metric01-get-path01
   spec:
     increment: 1
     method: GET
     metricRef:
       name: metric01
     path: /path01

   Copy to Clipboard Toggle word wrap

Procedure

1. Click Catalog > Installed Operators.

   1. From the list of Installed Operators, click 3scale Operator.
2. Click the Binding tab.
3. Click Create Binding.

4. Clear the sample content and add the following YAML definitions to the editor, then click Create.

   apiVersion: capabilities.3scale.net/v1alpha1
   kind: Binding
   metadata:
     name: mytestingbinding
   spec:
     credentialsRef:
       name: ecorp-tenant-secret
     APISelector:
       matchLabels:
         environment: testing

   Copy to Clipboard Toggle word wrap

   The binding object references the ecorp-tenant-secret and creates the API objects that are labeled as environment: staging.

5. Navigate to your new 3scale tenant to check that all you carried out in the preceding steps has been created.

   Note

   For more information, check the reference documentation: Capabilities CRD Reference.