Deploying an instance by using the Platform UI

Complete these prerequisites before you create an instance as an integration administrator. For more information, see Cloud Pak roles and permissions.

• Ensure that the operator for your instance is installed. For more information, see Installing the operators by using the Red Hat OpenShift console.

• Confirm that you have appropriate storage for your instance type. For more information, see Storage considerations.

• Have a pull secret configured where the instance will be created, either "global" (in all namespaces) or in a particular namespace. For more information, see "Applying the pull secret" in Finding and applying your entitlement key by using the UI (online installation).

• Configure the correct storage class for IBM Cloud Pak® foundational services by following the guidance in the "Storage option" section in Keycloak configuration.

1. Log in to the Platform UI.

2. Click Create an instance.

3. Click the tile for the instance that you want to deploy, then click Next to show the templates that are available for that instance type.

4. Choose the instance template that you want. Most instance types have one or more standard template tiles and a Select a template from Automation assets tile.

   • To use a standard template, click the tile for it, then click Next. You can customize the template in the next step.

   • To use a template from Automation assets, click the Select a template from Automation assets tile. If you do not have Automation assets installed, a panel opens. Click the link to open a guided installation for Automation assets.

     1. Select a template and preview its contents.

     2. Click Create from asset.

5. Select values for the following fields to configure your instance. The UI form perspective is selected by default; it opens a form for reviewing and modifying the instance configuration. Edit the default configuration as needed.

   1. In the Name field, enter a name for your instance.

   2. From the Namespace list, select the namespace in which to deploy the instance.

   3. For License, read the license agreement and select the License acceptance checkbox if you agree.

   4. For License LI, a default license is selected. For details about specific licenses, see the "Table of license versions" section in Licensing.

   5. If applicable, select a compatible storage class.

   6. For Version (if applicable), the optimal version is selected by default. For more information about operator and resource version compatibility, see Operator and instance versions for this release.

   7. Other fields are specific to the instance type. For more information about the configuration values for these fields, see the list at the end of this procedure.

6. (Optional) If you're not ready to deploy your instance, save a draft version of it. Click the overflow menu (three-dot icon), then click Save as draft. The configuration for the instance is stored in the Platform UI. You can continue editing the draft version until you are ready to create the instance from it.

7. Click Create to initiate deployment. You are redirected to the home page. The instance begins installing and is initially in the Pending state. Click Pending to get status details. When the deployment completes, the status changes to Ready (you can click the refresh button next to Create to refresh the status column).

Configuration options by instance type

For more information about configuration values that are specific to your selected template, see one of the following topics:

• API Connect cluster - API Connect configuration settings *

• Integration dashboard - Custom resource values

• Integration design - Custom resource values

• Integration runtime - Custom resource values

• Event Manager and Event Gateway - Configuring

• Event Processing - Configuring Event Processing

• Kafka cluster - Configuring

• Kafka topic - Creating a Kafka topic

• Kafka user - Managing access

• Kafka Connect runtime - Using Kafka Connect

• Kafka connector - Add connectors you want to use

• Enterprise gateway - DataPowerService spec

• High-speed transfer server - Deploying High Speed Transfer Server

• Automation assets - Configuring Automation assets

* An API Connect cluster instance consists of four subsystems: API Manager, API Portal, API Gateway, and API Analytics. When you deploy an API Connect cluster instance, you get only one instance of each subsystem. The API Connect cluster instance also enables the following features:

• Single sign-on and identity and access management that is integrated with other instances in your Cloud Pak for Integration installation.

• A navigation experience and UI that is consistent with all other instances in your Cloud Pak for Integration installation.

• Integration with Automation assets for asset sharing and re-use.

• Integration with Integration design for co-authoring between App Connect flows and API Connect APIs.

• Ability to generate an upgrade plan, which helps you manage all aspects of the Cloud Pak for Integration upgrade.

To learn about advanced configuration options and how you can start using your new instance in integrations, see Building integrations.

For information about known issues and workarounds, see Known limitations.