Chapter 3. Installing APIcast

Procedure

1. Create an OpenShift secret that contains 3scale System Admin Portal endpoint information:

   oc create secret generic ${SOME_SECRET_NAME} --from-literal=AdminPortalURL=${MY_3SCALE_URL}

   • ${SOME_SECRET_NAME} is the name of the secret and can be any name you want as long as it does not conflict with an existing secret.

   • ${MY_3SCALE_URL} is the URI that includes your 3scale access token and 3scale System portal endpoint. For more details, see THREESCALE_PORTAL_ENDPOINT

     Example

     oc create secret generic 3scaleportal --from-literal=AdminPortalURL=https://access-token@account-admin.3scale.net

     For more information about the contents of the secret see the Admin portal configuration secret reference.

2. Create the OpenShift object for APIcast

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: example-apicast
   spec:
     adminPortalCredentialsRef:
       name: SOME_SECRET_NAME

   The spec.adminPortalCredentialsRef.name must be the name of the existing OpenShift secret that contains the 3scale system Admin Portal endpoint information.

3. Verify the APIcast pod is running and ready, by confirming that the readyReplicas field of the OpenShift Deployment associated with the APIcast object is 1. Alternatively, wait until the field is set with:

   $ echo $(oc get deployment apicast-example-apicast -o jsonpath='{.status.readyReplicas}')
   1

Procedure

1. Create a secret with the configuration file:

   $ curl https://raw.githubusercontent.com/3scale/APIcast/master/examples/configuration/echo.json -o $PWD/config.json
   
   oc create secret generic apicast-echo-api-conf-secret --from-file=$PWD/config.json

   The configuration file must be called config.json. This is an APIcast CRD reference requirement.

   For more information about the contents of the secret see the Admin portal configuration secret reference.

2. Create an APIcast custom resource:

   $ cat my-echo-apicast.yaml
   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: my-echo-apicast
   spec:
     exposedHost:
       host: YOUR DOMAIN
     embeddedConfigurationSecretRef:
       name: apicast-echo-api-conf-secret
   
   $ oc apply -f my-echo-apicast.yaml

   1. The following is an example of an embedded configuration secret:

      apiVersion: v1
      kind: Secret
      metadata:
        name: SOME_SECRET_NAME
      type: Opaque
      stringData:
        config.json: |
          {
            "services": [
              {
                "proxy": {
                  "policy_chain": [
                    { "name": "apicast.policy.upstream",
                      "configuration": {
                        "rules": [{
                          "regex": "/",
                          "url": "http://echo-api.3scale.net"
                        }]
                      }
                    }
                  ]
                }
              }
            ]
          }

3. Set the following content when creating the APIcast object:

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: example-apicast
   spec:
     embeddedConfigurationSecretRef:
       name: SOME_SECRET_NAME

   The spec.embeddedConfigurationSecretRef.name must be the name of the existing OpenShift secret that contains the configuration of the gateway.

4. Verify the APIcast pod is running and ready, by confirming that the readyReplicas field of the OpenShift Deployment associated with the APIcast object is 1. Alternatively, wait until the field is set with:

   $ echo $(oc get deployment apicast-example-apicast -o jsonpath='{.status.readyReplicas}')
   1