Deploying an instance of API Connect on IBM Z

Deploy the API Connect Management and Portal subsystems on the IBM Z cluster that you prepared.

1. Log in to the Platform UI. Use the authentication method and credentials set by your administrator.
2. Click IBM Cloud Pak | Automation > Administration > Integration instances.
3. On the Integration instances page, click Create an instance.
4. Select the API management tile and click Next.
5. On the Create an instance for API management page, select a deployment type and click Next:
   • Small - Single replica
   • Medium - Single replica
   • Large - Three replicas
6. On the next page, fill in the configuration fields 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 fill in the configuration fields as explained in API Connect cluster configuration settings in the API Connect documentation.

   Table 2. Basic configuration settings for API Connect on IBM Z (Management and Portal subsystems)

   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. MONTHLY_API_CALL - Applies only to the "IBM Cloud Pak for Integration - API Calls" program. For information on tracking monthly call volume, see Tracking API volume for auditing and compliance.
   License ID	The License ID for the API Connect program that you purchased: API Connect - Select L-KZXM-S7SNCU (the license ID for Program Name "IBM API Connect Enterprise V10.0.6.0"). If you purchased Cloud Pak for Integration, accept the API Connect Enterprise license when you purchase your VPCs (virtual processor cores). API Calls add-on - Select L-NRHE-WFD7EY (the license ID for Program Name "IBM Cloud Pak for Integration - API Calls 2023.2.1"). If you purchased Cloud Pak for Integration - API Calls (which is an add-on product), select the CP4I API Calls license, which entitles you to track usage by the monthly number of API calls instead of the number of installed VPCs (virtual processor cores). To view the available License IDs, see API Connect licenses in the API Connect documentation.
   Deployment profile	Select the type of API Connect installation profile 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 & capacity. Deploys 3 replicas of the Management, Developer Portal, Analytics, and Gateway components. In the next step you can optionally customize the deployment profile for each API Connect subsystem (version 10.0.5.2 and later). 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 will be 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. For guidance on Cloud Pak for Integration Storage class selection, see Storage considerations in this documentation. To review API Connect storage support, see the "Supported storage types" section in Deployment requirements, in the API Connect documentation.

7. API Connect 10.0.6.0 or later: Optionally override the 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.

      spec:
        template:
        - name: management
          containers:
          - name: cr
            env:
            - name: PROFILE
              value: n1xc2.m16
        - name: portal
          containers:
          - name: cr
            env:
            - name: PROFILE
              value: n1xc2.m8

   3. Add the customized template into the spec section of the CR.
8. Click Create.

   Wait for the API Connect cluster to be successfully installed before proceeding to the next task.