Using declarative API Products

Create a secret containing the credentials for the API manager you want the declarative Product to use.

You can have multiple secrets in the same namespace, and have different Products reference different secrets.

Create the secret:

cat <<EOF | oc apply -f -
apiVersion: v1
kind: Secret
metadata:
  name: apim-credentials
type: Opaque
stringData:
  base_url: https://<api-connect-base-url>
  username: <username>
  password: <password>
  trusted_cert: |-
    <certificate>
EOF

1. To get the values you need to use within the secret, run the following command in the namespace where the API manager is installed, replacing <instance-name> with the name of the API manager instance:

   oc get ManagementCluster <instance-name>-mgmt -o json | jq -r '.status.endpoints[] | select(.name=="platformApi")'

   This returns a JSON object with the following structure, where <api-secret-name>, and <api-connect-base-url>, are values that change depending on the name of your APIC manager instance.

   {
     "name": "platformApi",
     "type": "API",
     "secretName: "<api-secret-name>",
     "uri": "<api-connect-base-url>"
   }

2. Replace the values in the secret with the previously returned values, as follows:

   • Replace <api-connect-base-url> with the values that were generated in the previous command.

   • Replace <certificate> with the certificate content for a cert that the API manager trusts. On OpenShift, get this content by running the following command in the namespace where the API manager is installed, replacing <api-secret-name>, with the value that was generated in the previous step:

     oc get secret <api-secret-name> -o json | jq -r '.data["ca.crt"]' | base64 --decode

   • Replace <username> with the username you want to use.

   • Replace <password> with the password for that username.

1. Log into your cluster, using your OpenShift user credentials:

   oc login

2. Create a Product YAML file. For example, you could create a file called product.yaml with the following example configuration. Update the values as indicated:

   • For metadata.namespace, enter your project (namespace) name.

   • For spec.state, specify the desired lifecycle state. For more information, see The Product lifecycle.

   • For spec.apis, specify a list of apis and integration runtimes you want to be part of this product.

     • For spec.apis.apis, you can specify an array with the names of declarative apis you want this product to consume. For more information, see Using declarative APIs.

     • For spec.apis.integrationRuntimes, you can specify an array with the names of IntegrationRuntime resources you want this product to consume. For more information, see the "Custom resource values" section.

   • For spec.share.apim:

     • For credentialsSecret, specify the name created in the Create a secret with your API manager credentials section.

     • For providerOrg, specify the name of the API Connect provider organisation to add this product to.

     • For catalog, specify the name of the API Connect catalog to add this product to.

   • Set any other configuration values as required, such as defining the properties of the product under spec.definition.

     apiVersion: apiconnect.ibm.com/v1beta1
     kind: Product
     metadata:
       name: example-product
       namespace: <namespace>
     spec:
       state: Published
       definition:
         product: 1.0.0
         info:
           title: Example
           name: test-https-routes-noauth
           version: '1.0'
         plans:
           default-plan:
             rate-limits:
               default:
                 value: 100/1hour
             title: Default Plan
             description: Default Plan
             approval: false
       apis:
         integrationRuntimes:
           - name: test-https-routes-noauth
         apis:
           - name: example-api-resource
       share:
         apim:
           credentialsSecret: apim-credentials
           providerOrg: main-demo
           catalog: main-demo-catalog

3. Apply the YAML file to the cluster:

   oc apply -f product.yaml

4. Check the status of the Product by running the following command in the project (namespace) where it was deployed:

   oc get product