Configure Event Endpoint Management to integrate with IBM API Connect Developer Portal

The following sections provide instructions for configuring the integration of your Event Manager instance with IBM API Connect 12.1.1 or later.

Important:

• You can configure an integration with either API Connect 10.x.x or API Connect 12.1.1 or later, but not both simultaneously.
• Each Event Endpoint Management instance integrates with only one API Connect instance, and each API Connect instance integrates with only one Event Endpoint Management instance.

Before you begin

In API Connect, identify a Developer Portal user that has administrator privileges, or create a new user that has administrator privileges.

Create a secret that contains your Developer Portal credentials

In the Event Endpoint Management namespace, create a secret that contains the basic authentication credentials of your Developer Portal user. The user must have administrator privileges.

Run the following command to create a secret called devportal-api-secret that contains your Developer Portal user credentials:

kubectl -n <event endpoint management namespace> create secret generic devportal-api-secret \
  --from-literal="key"="<username>:<password>"

Substitute <username>:<password> with the authentication credentials or your Developer Portal user.

Enable TLS trust between Event Endpoint Management and the Developer Portal

Copy the devportal-admin-client secret to your Event Endpoint Management namespace so that your Event Manager instance and your Developer Portal instance trust each other.

1. Log in to your Developer Portal container environment.

2. Extract the devportal-admin-client secret to a file called devportal-admin-client.yaml:

   kubectl -n <api connect namespace> get secret devportal-admin-client -o yaml > devportal-admin-client.yaml
   

3. Edit the devportal-admin-client.yaml file. Set metadata.name=devportal-ca and delete all the other metadata fields. The resulting file contents look like this:

    apiVersion: v1
    kind: Secret
    metadata:
      name: devportal-ca
    type: kubernetes.io/tls
    data:
      ca.crt: ...
      tls.crt: ...
      tls.key: ...
   

4. Create the devportal-ca secret in your Event Endpoint Management namespace.

   • To create the secret by using the CLI, run the following command:

     kubectl -n <event endpoint management namespace> apply -f devportal-admin-client.yaml
     

   • To create the secret by using the OpenShift Container Platform web console, follow these steps:

     a. Log in to the OpenShift Container Platform web console using your login credentials.

     b. Expand the Project drop-down menu and select the project where your Event Endpoint Management instance is installed.

     c. Click the + (Quick create) icon on the upper-right corner of the window.

     d. Paste the contents of devportal-admin-client.yaml in the YAML editor.

     e. Click Create.

Configure Event Endpoint Management to integrate with API Connect Developer Portal

Update your Event Endpoint Management custom resource with the API Connect configuration details as follows:

Create or update the spec.manager.apic.developerPortal section as follows:

spec:
  manager:
   apic:
     developerPortal:
       - organization: eem
         endpoint: <devportal URL>
         authentication:
           secretName: devportal-ca
           key: key

Set <devportal URL> to the URL of the Developer Portal. For example, https://devportal.apps.example.com. Do not include the /devportal path in the URL.

In the spec.manager.tls.trustedCertificates property, add the devportal-ca certificate:

spec:
  manager:
    tls:
     trustedCertificates:
       - certificate: ca.crt 
         secretName: devportal-ca

By using the CLI

1. Edit the EventEndpointManagement custom resource:

    kubectl -n <event endpoint management namespace> edit eventendpointmanagement/<custom-resource-name>
   

2. Make the required updates to spec.manager.apic.developerPortal and trustedCertificates.

By using the OpenShift Container Platform web console

1. Log in to the OpenShift Container Platform web console using your login credentials.
2. Expand the Operators drop-down menu and select Installed Operators to open the Installed Operators page.
3. Expand the Project drop-down menu and select the project the instance is installed in. Click the operator called IBM Event Endpoint Management.
4. Click the Event Endpoint Management tab and search the Name column for the installed instance and click the name.
5. Click the YAML tab to edit the custom resource.
6. Make the required updates to spec.manager.apic.developerPortal and trustedCertificates.
7. Click Save to apply your changes.

Verify the configuration

To verify that the integration between Event Endpoint Management and IBM API Connect Developer Portal deployed successfully, complete the following steps:

1. Log in to the Event Manager UI with an account that has the Administrator role.
2. Navigate to Administration > External integrations.

A tile for API Connect is displayed with the URL that you specified when you configured the Event Endpoint Management Developer Portal integration.

If you do not see the tile for API Connect, then check the pod logs of the Event Manager instance and verify the contents of the devportal-api-secret and devportal-ca secrets that you created.

Post configuration tasks

Update your Event Endpoint Management backup so that you do not lose your Developer Portal integration configuration.