Deploying all API management subsystems on Linux x86_64 (Platform UI)
Deploy an instance with all API management subsystems on a Linux x86_64 cluster so that you can create, manage, and share APIs. This procedure uses the Platform UI.
Deploy all API Connect subsystems on a Linux x86_64 cluster.
Before you begin
- The API Connect operator and instances must be from the same release and fix pack level of API
Connect to ensure a successful installation. Table 1 lists the current version of the operator and
instance for API Connect.
Table 1. API Connect version and operator for Cloud Pak for Integration API Connect (instance) Operator channel version Highest operator version 10.0.6.0 v5.0 5.0.0
- API Connect supports only the
restrictedSCC (security context constraint) in OpenShift.
- API Connect requires the use of block storage.
About this task
If you have not already done so, review Overview – Installation 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 the API Connect capability:
- Log in to the Platform UI. Use the authentication method and credentials set by your administrator.
- Click .
- On the Integration instances page, click Create an instance.
- Select the API management tile and click Next.
- On the Create an instance for API management page, select a deployment type and click Next.
- On the next page, fill in the configuration fields that are described
in Table 2.Note: You only need to complete the fields in Table 2. 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 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"
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 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 & 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 & capacity. Must be configured for use with existing or independently deployed Gateways. Deploys 3 replicas the Management, Developer Portal, and Analytics 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.
- API Connect 10.0.6.0 or later: Optionally override the deployment profile for one or more API
If you want to customize the profile for an API Connect subsystem, add a template override to the
- Click the YAML tab.
- 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 - name: analytics containers: - name: cr env: - name: PROFILE value: n1xc2.m16 - name: gateway containers: - name: cr env: - name: PROFILE value: n1xc1.m8
- Add the customized template into the
specsection of the CR.
- Click Create.
API Connect configures Cloud Pak for Integration IAM (Identity and Access Management) as 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.
- In the navigation UI, click .
- Click the next to the API Connect instance name, and select Cloud Manager.
- Log in to Cloud Manager with the Common Services user registry, using 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 in order 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.
What to do next
When you finish installing API Connect, Prepare your deployment for disaster recovery so that your data can be restored in the event of an emergency.