Event Endpoint Management deployment

Note: Install an instance of the Event Endpoint management capability in a single namespace. If you want to deploy additional instances, you must deploy them into different namespaces.

1. Log in to the IBM Cloud Pak for Integration Platform Navigator as a Cluster Administrator. Use the authentication method and credentials set by your administrator.

2. Click the Navigation Menu in the top left.

3. Expand Administration and click Integration capabilities.

4. Click Create capability.

5. Select the API Management tile and click Next.

6. On the Create an instance for API management page, select the Event Endpoints - One Node - Minimum tile and click Next.

7. Fill in the fields as described in the following table: By using the form view, update the following fields:

   • Name: Add a name for your Event Endpoint Management instance.

   • Namespace: Select the namespace where this instance will be created. This is the namespace where you installed the API Connect operator.

     Note: This field only displays if you selected All namespaces in the cluster (default) when you installed the operator. If the API Connect operator was installed for a single namespace, this field will not be displayed. It is only applicable when the operator is installed for all namespaces, which means you have to select the namespace where you want to create the instance.

   • License acceptance: To install the instance, you must accept the license agreement.

   • License use: Select production or nonproduction to match the license that you purchased. Default is nonproduction.

   • License metric: Leave blank for default value VIRTUAL_PROCESSOR_CORE.

   • License ID: Select the license ID for Program Name "IBM API Connect Enterprise PVU". To view License IDs, see API Connect licenses.

   • Deployment profile: Select the type of API Connect installation profile you want. Default is n1xc10.m48, which corresponds to Event Endpoints - One Node - Minimum.

     • Development profile is n1xc10.m48, which deploys 1 replica of each pod, so this profile is most suitable for a small, non-HA system. Recommended use of this profile is for development and testing.

     • Production profile is n3xc14.m48, which deploys 3 or more replicas of each pod, so this profile is most suitable for larger systems and for production environments. This profile is supported for installation on a cluster with three or more nodes. It is not supported on a cluster with fewer than three nodes.

   • Product version: Select the product version or channel to be installed in the system. This is the API Connect application version for the subsystems. Use 10.0.2.0 for Event Endpoint Management.

   • Storage class: Specify the RWO block storage class to use for persistence storage. This will be used when creating a PVC. Specification of the storage class is highly recommended. If not specified, the default cluster storage class for API Connect is used.

     See storage requirements for more information about storage considerations.

   • Supported endpoint types: Select Events to manage event streaming sources that use Kafka. You can also select APIs if you want to manage interfaces such as REST APIs and GraphQL with the same instance.

   Alternatively, you can also configure the instance by using the the YAML editor, for example:

   apiVersion: apiconnect.ibm.com/v1beta1
   kind: APIConnectCluster
   metadata:
     labels:
       app.kubernetes.io/instance: apiconnect
       app.kubernetes.io/managed-by: ibm-apiconnect
       app.kubernetes.io/name: apiconnect-events-minimum
     name: events-minimum
     namespace: apic
   spec:
     endpointTypes:
       - Events
     license:
       accept: false
       use: nonproduction
     profile: n1xc10.m48
     version: 10.0.2.0

8. Click Create.

9. After the installation completes, check the status of your release and verify that your instance deployed successfully.

You can also use the APIConnectCluster custom resource to install the Event Endpoint Management capability by using the command line.

1. Ensure you have a YAML file saved locally with the custom resource configuration (see the YAML editor example earlier).

2. Log in to your OpenShift Container Platform as a cluster administrator by using oc login.

3. Set the project (namespace) to where you will install the instance by using oc project <namespace>

4. Apply the APIConnectCluster custom resource to create an Event Endpoint Management instance:

   oc apply -f <custom-resource-file-path> For example: oc apply -f eventapi.yaml

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

2. Expand the Operators dropdown and select Installed Operators to open the Installed Operators page.

3. Expand the Project dropdown and select the project the instance is installed in (this is the namespace you set earlier). Click the operator called IBM API Connect managing the project.

4. Select the Event Endpoint Management tab and search the Name column for the installed instance and click it.

5. The Phase field in the APIConnectCluster custom resource will display the current state of the Event Endpoint Management instance. When the Event Endpoint Management instance is ready, the phase will display Ready, meaning the deployment has completed.

After all the components of an Event Endpoint Management instance are active and ready, the APIConnectCluster custom resource for the Event Endpoint Management instance will have a Ready phase in the status. To verify the status:

1. Log in to your OpenShift Container Platform as a cluster administrator by using oc login.

2. Run the oc get command as follows: oc get apiconnectcluster <cr_name> -ojsonpath={.status.phase}

For example, the installation of the instance called development is complete when the STATUS returned by the oc get command displays Ready:

$ oc get apiconnectcluster development -ojsonpath={.status.phase}
>
NAME             STATUS
development      Ready