Event Endpoint Management deployment

Event Endpoint Management provides the capability to describe and catalog your Kafka topics as event sources, and to share the details of the topics with application developers.

You can deploy an instance of Event Endpoint Management as part of Cloud Pak for Integration by using the Platform UI as described later in this section.

You can also install a stand-alone instance of Event Endpoint Management and one or more instances of an associated Event Gateway as described in the Event Automation documentation.

Before you begin

For information about the Event Endpoint Management releases included in this version of Cloud Pak for Integration, see the version information for the included capabilities.

  • If you have not already done so, review Overview: Installation and follow the installation procedures required for your cluster.

  • Event Endpoint Management uses the default restricted Security Context Constraint (SCC) that comes with the OpenShift Container Platform.

Installing an instance of Event Endpoint Management

You can create an instance of Event Endpoint Management as part of Cloud Pak for Integration by using the Platform UI or the command line.

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

Ensure you have the Event Endpoint Management operator installed. Event Endpoint Management is installed and configured by the operator through the EventEndpointManagement custom resource type. When you install the operator, you can choose whether to install it to all namespaces in the cluster, or to a single namespace. Event Endpoint Management deploys one instance of each subsystem into a particular namespace.

  • All namespaces in the cluster (default): If selected, the operator can manage instances of Event Endpoint Management in any namespace. The operator is deployed into the system namespace openshift-operators. In this case, you can specify the namespace to install the instance into as described later (see the Namespace field).

  • A specific namespace on the cluster: If selected, the operator can only manage instances of Event Endpoint Management in the same namespace. The operator is deployed into the specified namespace. In this case, you do not specify a namespace later.

Installing by using the Platform UI

  1. Log in to the IBM Cloud Pak for Integration Platform UI 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 instances.

  4. Click Create an instance.

  5. Select the Event endpoint management tile and click Next.

  6. Select a deployment type and click Next:

    • Select Quick start for a starter deployment intended for development and testing purposes. It is not suitable for production environments, and uses ephemeral storage and local authentication.

    • Select Production for a deployment with support for persistent storage and local authentication to improve capacity and availability.

    • Select Usage-based pricing for a production deployment that is based on the production sample, but with additional fields to point to an installed License Service server to record usage-based metrics.

  7. Fill in the fields as follows. By using the UI form view, update the following fields:

    In the Metadata section:

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

    • Namespace: Select the namespace where this instance will be created.

      Note: You can only edit this field if you selected All namespaces in the cluster (default) when you installed the operator. If the Event Endpoint Management 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. You can only deploy one instance of Event Endpoint Management in a single namespace.

    In the License section:

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

    • License ID: Select the license ID for the Event Endpoint Management program that you purchased. The following are the license options for Event Endpoint Management.

      • Select L-YBXJ-ADJNSM for program name "IBM Cloud Pak for Integration Standard ".

      • Select L-NRHE-WFD7EY for program name "IBM Cloud Pak for Integration - API Calls".

      Note: You can deploy Event Endpoint Management with a usage-based license, where usage is tracked and charged by the number of API calls handled by Event Endpoint Management. Usage is reported automatically to the IBM License Service, where usage can be tracked, monitored, and audited. Setting License metric (spec.license.metric) to MONTHLY_API_CALL and License ID (spec.license.license) to L-NRHE-WFD7EY configures any Event Gateway to automatically track API usage.

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

    • License metric: To enable a usage-based Event Endpoint Management deployment, select MONTHLY_API_CALL. Otherwise, select VIRTUAL_PROCESSOR_CORE.

    In the Manager section:

    • Storage:: Choose ephemeral or persistent-claim based on your requirements, and provide the required settings.

    • Auth config: Set the type of authentication you want and provide the required settings.

    • Extension services: Optional: if using usage-based pricing, set the properties for the License Service to connect to.

    • Apic: Optional: If you are integrating with IBM API Connect, provide the required settings.

Alternatively, you can also configure the instance by using the the YAML editor in the YAML tab.

  1. Click Create.

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

  3. (Optional) For usage-based deployments, you can verify usage tracking after the installation completes, as described in the Event Endpoint Management documentation.

Installing by using the command line

You can also use the EventEndpointManagement 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 samples mentioned earlier which you can view in the YAML editor).

  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 EventEndpointManagement custom resource to create an Event Endpoint Management instance:

    oc apply -f <custom-resource-file-path>

    For example:

    oc apply -f eventapi.yaml

Next steps

Install one or more instances of the Event Gateway on the same cluster or as a stand-alone deployment, as described in the Event Endpoint Management documentation.

Verify that your installation completed successfully, and consider other post-installation tasks such as validating a usage-based deployment, as described in the Event Endpoint Management documentation

Start using Event Endpoint Management to create and publish definitions of your Kafka topic content as described in socializing Kafka events.