Deploying all API management subsystems using CP4I (platform UI)

Deploy an instance with all API management subsystems using Cloud Pak for Integration platform UI so that you can create, manage, and share APIs. This procedure uses the platform UI.

Introduction

Deploy all API Connect subsystems using CP4I platform UI.

Attention: In IBM® Cloud Pak for Integration, you can deploy an instance of API management, or a separately purchased add-on called API calls. The instructions in this topic apply to both deployments.

Before you begin

Note: API Connect does not support changing endpoints after deployment.

About this task

Tip: For a list of possible errors and solutions when installing API Connect, see Troubleshooting installation on OpenShift in the API Connect documentation.

Prerequisites

If you have not already done so, review Installing and follow the installation procedures that are required for your cluster.

Deploying an instance of API Connect or API calls

Complete the following steps to deploy an instance of API management:

Attention: When you deploy the API Connect operator, the DataPower operator is also deployed. Enterprise gateway (provided by the DataPower operator) is a required component of API management. If you delete the DataPower operator, the API Connect installation fails.

Log in to the Platform UI. Use the authentication method and credentials set by your administrator.
On the instances section, click Create an instance.
Select the API management tile and click Next.
On the Create an instance for API management page, use one of the following deployment options:
- To deploy by using the default configuration, click the tile for the deployment option that you need, then click Next. You can modify the default configuration as needed.
- To deploy by using an existing template from Automation assets, click the Select a template tile. If you do not have Automation assets installed, a page 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.

On the Basic settings page, complete the configuration fields that are described in Table 1.

Note: You only need to complete the fields in Table 1. All other settings are preconfigured and can be accepted as-is. If you prefer to customize the configuration settings, click Advanced settings and complete the configuration fields as explained in API Connect cluster configuration settings in the API Connect documentation.

Table 1. Basic configuration settings for API Connect
Input	Value
Name	A name for your API Connect instance.
License acceptance	Click to accept the license. You must accept the license to install API Connect.
License use	Select production or nonproduction to match the type of license that you purchased.
License metric	Enter the unit of measure that is used for your program license: VIRTUAL_PROCESSOR_CORE - Default value. If you leave the field blank, this value is used.
License ID	The license ID for the API Connect program that you purchased: API Connect - Select L-DZZQ-MGVN8V (the license ID for program name IBM API Connect Enterprise V10.0.8.0).
Deployment profile	Select the type of API Connect installation profile that you want. The default corresponds to the tile that was selected in the previous screen: Small - Single replica (n1xc7.m48) best suited for light, noncritical workloads such as small team development and testing. Deploys 1 replica of the management, developer Portal, analytics, and gateway components with a minimal footprint. Medium - Single replica (n1xc16.m72) ideal for medium workloads such as organizational development, testing, and production when in alignment with business availability requirements. Deploys 1 replica of the management, developer Portal, analytics, and Gateway components. Large - Three replicas (n3xc16.m48) ideal for heavy workloads when business requires redundancy for greater availability and capacity. Deploys 3 replicas of the management, developer Portal, analytics, and Gateway components. Medium - Single replica - Remote Gateway (n1xc12.m64) ideal for medium workloads such as organizational development, testing, and production when in alignment with business availability requirements. Must be configured for use with existing or independently deployed gateways. Deploys 1 replica of the management, developer Portal, and analytics components. Large - Three replicas - Remote Gateway (n3xc12.m40) ideal for heavy workloads when business requires redundancy for greater availability and capacity. Must be configured for use with existing or independently deployed gateways. Deploys 3 replicas the management, developer Portal, and analytics components. For more information on the available profiles, see API Connect deployment profiles for OpenShift and Cloud Pak for Integration in the API Connect documentation. In the next step, you can optionally customize the deployment profile for each API Connect subsystem. In addition, you can switch to a different deployment profile after installation as explained in Changing the deployment profile on Cloud Pak for Integration in the API Connect documentation.
Product version	Select the API Connect product version or channel to be installed.
Storage class	Specify the RWO block storage class to use for persistence storage. This is used when creating a PVC. This setting is optional, but is highly recommended. If you omit this setting, it defaults to the default cluster storage class for API Connect. To review API Connect storage support, see the "Supported storage types" section in Deployment requirements, in the API Connect documentation.

API Connect 10.0.7.0 or later: Optionally override the default deployment profile for one or more API Connect subsystems.
If you want to customize the profile for an API Connect subsystem, add a template override to the apiconnectCluster CR:
1. Click the YAML tab.
2. Modify the sample template as appropriate for your deployment.
  The following example template includes overrides for all API Connect subsystems but you do not have to use them all. Delete the sections that you don't want to use, and modify the remaining sections as needed. For information on the available profiles for each subsystem, see the links to the topics in this section of the API Connect documentation:
  Component profiles, CPU limits, memory limits, and licensing
```
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-minimum
  name: <name_of_your_instance> 
  namespace: <APIC-namespace> 
spec:
  template:
  - name: management
    containers:
    - name: cr
      env:
      - name: PROFILE
        value: n1xc2.m16
  - name: portal
    containers:
    - name: cr
      env:
      - name: PROFILE
        value: n1xc2.m8
  - name: analytics
    containers:
    - name: cr
      env:
      - name: PROFILE
        value: n1xc2.m16
  - name: gateway
    containers:
    - name: cr
      env:
      - name: PROFILE
        value: n1xc1.m8
```
3. Add the customized template into the spec section of the CR and then return to the Basic settings page.

Optionally deploy with Cloud Pak endpoints.

The API Management component uses the typical default API Connect routes (or the custom endpoints configured in the CR). If you want to deploy with Cloud Pak endpoints, complete the following steps:

Click the YAML tab to manually edit the CR.

Insert the deprecatedCloudPakRoute object into the spec.management section as shown in the following 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-minimum
  name: <name_of_your_instance> 
  namespace: <APIC-namespace> 
spec:
  license:
    accept: true
    license: L-DZZQ-MGVN8V
    metric: PROCESSOR_VALUE_UNIT
    use: nonproduction
  profile: n1xc17.m48
  version: 10.0.8.0
  storageClassName: <default-storage-class>
  management:
    deprecatedCloudPakRoute:
      enabled: true
      cloudPakEndpoint:
        hosts:
        - name: cpd-apic.apps.admin-<domain>.com

Optional: If you want to add a custom certificate for the Cloud Pak route, complete the following steps:

Create a Cloud Pak certificate that was signed by a Cloud Pak CA as in the following example:

---
apiVersion: cert-manager.io/v1
kind: Issuer
metadata:
 name: custom-cpd-ca
 namespace: apic
spec:
 selfSigned: {}
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
  name: custom-cpd
  namespace: apic
spec:
  commonName: small-mgmt-cpd
  dnsNames:
  - cpd-apic.apps.admin-apickeycloak.cp.fyre.ibm.com
  duration: 17520h0m0s
  issuerRef:
    kind: Issuer
    name: custom-cpd-ca
  privateKey:
    algorithm: RSA
    rotationPolicy: Always
    size: 2048
  renewBefore: 720h0m0s
  secretName: custom-cpd
  usages:
  - key encipherment
  - digital signature
  - server auth

In the CR, provide the secret name within the cloudPakEndpoint property of the new deprecatedCloudPakRoute object, for example:


spec:
  deprecatedCloudPakRoute:
    enabled: true
    cloudPakEndpoint:
      hosts:
      - name: cpd-apic.apps.admin-<domain>.com
        secretName: custom-cpd

Click Create.

API Connect configures the API Connect Common Services user registry (CSUR), and then on-boards the OpenShift kubeadmin user into the CSUR as the API Connect administrator. When you invite users to join provider organizations based on the CSUR, the user must open a private (incognito) browser to accept the invitation and register with API Connect.

Configuring your API Connect instance

Complete basic configuration settings for your instance of API Connect.

Click the next to the API Connect instance name, and select Cloud Manager.
Log in to Cloud Manager with the Common Services user registry, that uses the same username and password that you used for logging in to the platform UI.
Users must log in to the Cloud Pak for Integration platform to access the Cloud Manager and API Manager user interfaces in API Connect.
Configure a mail server for sending invitations and notifications to users as explained in Configuring an email server for notifications in the API Connect documentation.

Note: The API Connect instance requires further configuration before you can begin creating APIs. For more information on what to do next with the API management features, which are provided by API Connect, see Managing your APIs.

What to do next

When you finish installing API Connect, Backing up and restoring the management subsystemt so that your data can be restored if of an emergency.