Deploying instances
Deploy instances to use in your IBM Cloud Pak® for Integration installation.
Requirements
- Before an instance can be deployed, its operator must already be installed. For more information, see Installing the operators by using the Red Hat OpenShift console.
- Deploying instances from the Platform UI requires a user with a minimum role of admin. For more information, see Cloud Pak roles and permissions.
- You must install IBM Cloud Pak for Integration operators in the same installation mode (either in all namespaces on the cluster or in a specific namespace).
- Configure the correct storage class for IBM Cloud Pak foundational services by following the guidance in the "Storage option" section in Keycloak configuration.
Overview
The following instances are available for deployment.
| Instance type | Description |
|---|---|
| Platform UI | Deploy and manage instances from a central location. Access features such as applying labels to filter instances and using the canvas to create instances and integrations. |
| Assembly | Easily author, deploy, and manage multiple instances and components from a single YAML file. The YAML file simplifies deployment by supplying default configurations for complex elements, such as certificates. |
| Automation assets | Store, manage, retrieve, and search integration assets quickly from a centralized hub. |
| API Connect cluster | Expose, manage, share and monetize APIs securely across clouds. Deploys one of each subsystem (API Manager, API Analytics, API CMS Portal, API Gateway). |
| API Manager | Describe, manage, and share event sources securely across clouds |
| API Analytics | Filter, sort, and aggregate your API event data, then visualize this data to perform key actions like setting rate limits and analyzing trends. |
| API CMS Portal | Get a comprehensive platform for sharing and socializing your APIs with application developers. |
| API Developer Portal | Configuration-based self-service portal for developers to explore, discover, and subscribe to APIs. |
| API Gateway | Handle incoming requests from applications to consume and produce events. |
| API | Create API Connect APIs with the API Kubernetes resource. |
| API Product | Create API Products in API Connect with the API Product Kubernetes resource. |
| Federated API management | Connect, manage, and monitor multiple distributed API runtimes and data planes from a single interface. |
| End-to-end monitoring | Get visibility into integration flows and API operations. Monitor, trace, and analyze integration transactions across multiple components including API Connect, App Connect, and other integration runtimes. |
| API Nano Gateway | Get a Cloud-native gateway that uses a componentized architecture with a small footprint. |
| Enterprise gateway | Create an encrypted connection between environments and applications. |
| Event Manager | Describe, manage, and share event sources securely across clouds. |
| Event Gateway | Handle the incoming requests from applications to consume and produce events. |
| Event Processing * | Transform event streaming data in real time, to help you turn events into insights. |
| Kafka cluster | Analyze data and react to events in real time with Apache Kafka. |
| Kafka Connect runtime | Create a Kafka Connect runtime environment to host your connectors, then add connectors to your runtime to move data between your Kafka cluster and external systems. |
| Kafka connector | Connect Kafka to external systems by configuring and adding connectors to your Kafka Connect runtime environment. |
| Kafka topic | Access a named stream of messages. Applications produce messages for topics and consume messages from topics. |
| Kafka user | Connect an application or tool to a Kafka cluster using a listener and set of credentials. |
| Integration dashboard | Create and manage instances of App Connect runtimes. |
| Integration design | Develop integration flows with prebuilt connectors and no-code templates. |
| Integration runtime | Run integrations that were created in Integration designer or IBM App Connect Enterprise Toolkit. |
| Messaging server | Deploy and configures a Queue manager instance to use with the Messaging instance. Once you deploy a Messaging server, you can also deploy a Messaging channel, Messaging queue, and Messaging user. Designed for specific integration use cases; for a complete set of options and MQ use cases, use a Queue manager instance, instead. |
| Messaging channel | Create a channel in a Messaging server. Designed for specific integration use cases; to get all MQ options, use a Queue manager instance. |
| Messaging queue | Create a queue in a Messaging server. Designed for specific integration use cases; to get all MQ options, use a Queue manager instance.. |
| Messaging user | Create a user in a Messaging server, assign permissions for queue access, and generate connection details for apps. Designed for specific integration use cases; to get all MQ options, use a Queue manager instance. |
| Queue manager | Carry data between applications, systems and services with a scalable messaging hub. |
| Binding | Bind two instances together to allow communication between them and facilitate cross-component integrations. |
| Policy | Create policies to define rules and constraints for creating instances and integrations. |
| Policy binding | Apply policy rules in different contexts, such as in your development or production namespaces. |
* Further entitlement, such as the "IBM Cloud Pak for Integration Event Processing Add-on", is required. For more information, see "Event Processing Add-on" in Licensing.
After an instance is deployed, it is added to a table of available instances in the Platform UI. To access, log in to the Platform UI. On the home page, you get a list of instances:
