Click the application launcher in OpenShift Dedicated.

Click API Managed Dashboards in the OpenShift Managed Services drop-down menu.

You are prompted to log in. Click Log in with OpenShift.

Enter the login credentials.

Click Allow selected permissions to authorize monitoring access.

In the Grafana console, click the Dashboards dropdown menu from the main menu to access the available dashboards and folders.

Click Manage.

Click redhat-rhoam-customer-monitoring-operator to open the folder.

Click Rate Limiting to access the monitoring data.

Enter the following URL in a browser:

https://cloud.redhat.com

Log in to your Red Hat account.

Click OpenShift in the main menu. The OpenShift Cluster Manager console opens.

In the OpenShift Cluster Manager, click Clusters in the menu. A list of clusters in the console is displayed.

Select the cluster that you want to modify from the list of clusters.

In the selected cluster, click the Add-ons tab.

In the Red Hat OpenShift API Management add-on option, click the three dots in the top corner of the option.

Click Configure in the drop-down menu. The Configure API Management service dialog box is displayed.

In the Quota field, select a daily rate limit quota from the drop-down menu.

Click Update.

Click the application launcher in the OpenShift Dedicated console.

Click API Managed Dashboards in the OpenShift Managed Services drop-down menu.

You are prompted to log in. Click Log in with OpenShift.

Enter the login credentials.

Click Allow selected permissions to authorize monitoring access.

In the Grafana console, click Home to access the available dashboards and folders.

Click redhat-rhoam-customer-monitoring-operator to open the folder.

Click Rate Limiting to access the monitoring data. Your active daily rate limit quota is displayed below the usage graph.

Create a new APIcast instance:

1. Log in to OpenShift using the oc login command from the OpenShift client tools.

   oc login https://<OPENSHIFT-SERVER-IP>

   You should see Login successful. in the output.

2. Create a new namespace for the self-managed APIcast.

   oc new-project selfmanaged-apicast

Import the image.

oc import-image 3scale-amp2/apicast-gateway-rhel8:<tag> --from=registry.redhat.io/3scale-amp2/apicast-gateway-rhel8:<tag> --confirm

1. Navigate to the catalog.

2. Find the image and view the available tags.

   An example <tag> name is 3scale<version>. Use the <tag> name that corresponds with the 3scale version installed on the cluster.

3. (Optional) If you receive an error message after attempting to import the image, troubleshoot with the following steps:

   1. Create a secret with credentials to registry.redhat.io. Use the following command to create a new secret to reference your project:

      oc create secret docker-registry redhatio --docker-server=registry.redhat.io --docker-username=<username> --docker-password=<password>  --docker-email=<email>

      • Replace <username> with your Docker username.

      • Replace <password> with your Docker password.

      • Replace <email> with the email associated with your Docker account.

   2. Use the following command to list active secrets and credentials:

      oc get secrets

   3. Use the following command to configure the pull secret:

      oc secrets link default redhatio --for=pull

In the terminal, clone the Example custom policy from the GitHub repository and navigate to the directory.

git clone git@github.com:3scale/apicast-example-policy.git
cd apicast-example-policy

Configure the openshift.yaml file

apiVersion: v1
kind: Template
metadata:
  name: "apicast-example-policy"
message: "APIcast Example Policy"
objects:

- apiVersion: v1
  kind: ImageStream
  metadata:
    annotations:
    labels:
      app: apicast
    name: apicast-policy

- apiVersion: v1
  kind: BuildConfig
  metadata:
    annotations:
    labels:
      app: apicast
    name: apicast-example-policy
  spec:
    output:
      to:
        kind: ImageStreamTag
        name: apicast-policy:example
    source:
      git:
        uri: https://github.com/3scale/apicast-example-policy.git
        ref: 'master'
      type: Git
    strategy:
      type: Source
      sourceStrategy:
        from:
          kind: ImageStreamTag
          namespace: selfmanaged-apicast
          name: apicast-gateway-rhel8:<tag>

- apiVersion: v1
  kind: BuildConfig
  metadata:
    annotations:
    labels:
      app: apicast
    name: apicast-custom-policies
  spec:
    nodeSelector: null
    output:
      to:
        kind: ImageStreamTag
        namespace: selfmanaged-apicast
        name: apicast-gateway-rhel8:<tag>
    postCommit:
      args:
        - '--test'
        - '--lazy'
      command:
        - bin/apicast
    resources: {}
    runPolicy: Serial
    source:
      images:
        - from:
            kind: ImageStreamTag
            name: 'apicast-policy:example'
          paths:
            # copy policy source code into the new image
            - destinationDir: policies
              sourcePath: /opt/app-root/policies/example
            # copy also installed dependencies to the policy folder, so they are vendored
            # - destinationDir: policies/example/0.1/resty/
            #   sourcePath: /opt/app-root/src/lua_modules/share/lua/5.1/resty/iputils.lua
      type: Dockerfile
      dockerfile: |
        FROM scratch
        COPY . src
        USER root
    strategy:
      dockerStrategy:
        from:
          kind: ImageStreamTag
          namespace: selfmanaged-apicast
          name: apicast-gateway-rhel8:<tag>
      type: Docker
    triggers:
      - type: ConfigChange
      - type: ImageChange

parameters:
- name: AMP_RELEASE
  required: false
  description: AMP Version (eg. 2.2.0-GA)

Create a new application for your APIcast gateway and start the deployment:

oc new-app -f openshift.yml --param AMP_RELEASE=2.8

You should see the following message in the output:

--> Deploying template "sm-apicast/apicast-example-policy" for "openshift.yml" to project sm-apicast

     apicast-example-policy
     ---------
     APIcast Example Policy

     * With parameters:
        * AMP_RELEASE=

--> Creating resources ...
    imagestream.image.openshift.io "apicast-policy" created
    buildconfig.build.openshift.io "apicast-example-policy" created
    buildconfig.build.openshift.io "apicast-custom-policies" created
--> Success
    Use 'oc start-build apicast-example-policy' to start a build.
    Build scheduled, use 'oc logs -f bc/apicast-custom-policies' to track its progress.
    Run 'oc status' to view your app.

Execute the custom policy builds.

oc start-build apicast-example-policy

Navigate to the OpenShift Dedicated console.

Use Operator Hub to install the Red Hat Integration - 3scale APIcast gateway operator for the namespace.

Generate the 3scale Admin Portal token.

1. Log in to the Red Hat 3scale API Management console.

2. Click Personal in 3scale console menu.

3. Click Tokens in the menu.

4. Click Add Access Token.

5. On the New Access Token page, enter the required information in the fields.

6. Click Create Access token.

Create an adminportal-credentials secret.

oc create secret generic adminportal-credentials --from-literal=AdminPortalURL=https://<access-token>@<url-to-3scale-admin-portal>

Configure the service to use the self-managed APIcast instead of the built-in APIcast for API.

1. Navigate to the Products section of the 3scale Admin Portal. You can use the following command to navigate to Admin Portal route:

   oc get routes --namespace redhat-rhoam-3scale | grep admin

2. In the Products section, click API → Integration → Settings → APIcast Self Managed.

3. Change the Staging Public Base URL. Replace api-3scale-apicast- with selfmanaged-.

4. Click Update Product.

5. Click API → Configuration → Promote to Staging and to Production.

Create a self-managed APIcast.

1. Navigate to the self-managed APIcast operator page.

2. Click Create an APIcast.

3. Use Edit Form to configure the APIcast.

4. Change Admin Portal Credentials Ref secret name to adminportal-credentials.

5. Set Configuration Load Mode to boot.

6. Set Image to image-registry.openshift-image-registry.svc:5000/selfmanaged-apicast/apicast-policy:example

   The image registry URL depends on the namespace.

7. Click Create.

Create a new route to use with the application you plan to create.

1. Navigate to the namespace of the self-managed APIcast in the OpenShift Dedicated web console.

2. Click Networking → Routes → Create Route.

3. Enter the requested information in the text fields:

   1. The Hostname must match the Staging Public Base URL (without protocol, without port).

   2. For Service, select the service of your APIcast.

   3. The target port is 8080 → 8080.

   4. Select the secure route, TLS termination: Edge.

   5. Click Create.

Navigate to the apicast-example-policy GitHub repository to make custom-policy available in the 3scale Admin Portal.

Execute the following command:

cat policies/example/0.1/apicast-policy.json

Navigate to the 3scale console.

Click Integration → Configuration to promote the APIcast.

1. Click ? to access the help feature.

2. Click 3scale API docs → APIcast Policy Registry Create

Enter the required information:

1. Enter the access token.

2. Use the name from the apicast-policy.json.

3. Use the version from the apicast-policy.json.

4. In the schema field, enter the apicast-policy.json content.

Click Send Request.

Navigate to the 3scale Admin Portal.

In the console menu, click API → Integration → Policies → Add Policy. The APIcast Example Policy is listed.

Navigate to 3scale Admin Portal.

Click API → Configuration.

Execute the command for the Staging Public Base URL with the user key.

1. You can access the command for the Staging Public Base URL with the user key in the 3scale Admin Portal:

   1. In the console menu, click Integration.

   2. Click Configuration.

   3. Use the command in the Example curl for testing in the Staging APIcast section.

The Example curl for testing output should include the following, if the APIcast proxy set up is successful:

"HTTP HOST": https://echo-api.3scale.net