IBM API CONNECT 10.0.5.X_LTS & IDG 10.5.
X
INSTALLATION AND CONFIGURATION
POC Environment
Version 2.0
Prepared by: IBM Vietnam Company Limited
Author: IBM Specialist
Date: Aug 6nd, 2023
1. DEPLOYMENT ARCHITECTURE
Page 2 of 12
2. DEPLOYMENT IBM DATAPOWER GATEWAY
For deploy IBM Datapower Gateway VM Edition, administrator need to peform the initialization
follows by the below process:
Open connections:
- Datapower, Management, Portal, Analytic -> dns server
- Datapower, Management, Portal, Analytic -> backend, destop - mail server (client)
- Management, Portal -> mail server (client)
- Need to prepare NTP server if there are multiple Gateway.
Page 3 of 12
3. DEPLOYMENT API CONNECT
3.1 Deployment API Management OVA
3.1.1 Preparing
Add A records to dns configuration:
o Provider Manager: manager.api.devtest.bca
o Cloud Manager: cloud-admin.api.devtest.bca
o Platform API: platform-api.api.devtest.bca
o Consumer Manager: consumer-api.api.devtest.bca
o Datapower Gateway Service: gateway-service.api.devtest.bca
o Datapower Gateway: gateway.api.devtest.bca
Generate ssh public key
Generate ssh public key and get public key.
Example: id_rsa.pub
Reference: https://www.ssh.com/academy/ssh/keygen
Hash password
mkpasswd --method=sha-512 --rounds=4096 Admin@1234
Sample hash password:
$6$rounds=4096$vG/2.8R5EPSrUKXj$XuORjk7Vd93KMnOIDNvuMX9IEeBhgHoVxt09GB9
zwojlioVLrZUZRUSPgp1hLI/a7cdgQsmZezVeDaLqDsCZm
3.1.2 Create API Management ISO
1. Init project
apicup init myProject
2. change to management project folder
cd myProject
3. Apply license
apicup licenses accept L-RJON-CEBLEH
4. Create management microservice
apicup subsys create mgmt management
5. Specify profile type
apicup subsys set mgmt deployment-profile=n1xc4.m16
Page 4 of 12
6. Set search domain
apicup subsys set mgmt search-domain=api.devtest.bca
7. set dns server
apicup subsys set mgmt dns-servers=172.119.3.1
8. set ssh public key
apicup subsys set mgmt ssh-keyfiles= C:\temp\management\openssl\
id_rsa.pub
9. set default login password for user apicadm
apicup subsys set mgmt default-
password='$6$n.yVUo1QiWzxX6Tp$2m3hOzkfkj61JMlKm2W5Hvr0waBnsAYqaP7Lnzn9M
6TxEH3gTCDL05HC8luhOF.wWBMM54nmW1mVeEgjlpTmr.'
note: pass: Admin@1234
10. set host and storage encryption key
apicup hosts create mgmt manager.api.devtest.bca hd_password
11. set IP for eth0 interface
apicup iface create mgmt manager.api.devtest.bca eth0
192.168.101.121/255.255.255.0 192.168.101.254
12. Configure enpoints
apicup subsys set mgmt platform-api=platform-api.api.devtest.bca
apicup subsys set mgmt consumer-api=consumer-api.api.devtest.bca
apicup subsys set mgmt cloud-admin-ui=cloud-admin.api.devtest.bca
apicup subsys set mgmt api-manager-ui= manager.api.devtest.bca
12. Verify configuration
apicup subsys get mgmt --validate
13. generate iso file
apicup subsys install mgmt --out mgmtplan
Reference: https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?
topic=appliance-configuring-management-subsystem
3.1.3 Deploy API Management OVA
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=appliance-deploying-management-
subsystem-ova-file
3.1.3 Verify Deploy API Management
https://www.ibm.com/docs/en/SSMNED_10.0.5/com.ibm.apic.install.doc/
vm_mgmt_install_verify.html
Page 5 of 12
3.2 Deployment API Developer Portal
3.2.1 Preparing
Add A records to dns configuration:
o Provider Manager: portal-admin.api.devtest.bca
o Cloud Manager: portal.api.devtest.bca
3.2.2 Create API Developer Portal ISO
1. change to management project folder
cd myProject
2. Create a portal subsystem
apicup subsys create port portal
3. Specify deployment-profile
apicup subsys set port deployment-profile=n1xc2.m8
4. specify license
apicup subsys set port license-use=nonproduction
5. specify environment variables
apicup subsys set port portal-admin=portal-admin.api.devtest.bca
apicup subsys set port portal-www=portal.api.devtest.bca
apicup subsys set port search-domain=devtest.bca
apicup subsys set port dns-servers=192.128.81.129
apicup subsys set port ssh-keyfiles=C:\temp\management\openssl\
id_rsa.pub
6. certificates from the Management subsystem
apicup subsys set port
default-password=$6$rounds=4096$vG/2.8R5EPSrUKXj$XuORjk7Vd93KMnOIDNvuMX
9IEeBhgHoVxt09GB9zwojlioVLrZUZRUSPgp1hLI/a7cdgQsmZezVeDaLqDsCZm
pass: Admin@1234
7. your hosts
apicup hosts create port portal.api.devtest.bca hd_password
8. Create your interfaces
apicup iface create port portal.api.devtest.bca eth0
192.168.81.131/255.255.255.0 192.168.81.2
9. validate configuration
apicup subsys get port --validate
10. create iso file
apicup subsys install port --out portplan-out
ssh 192.168.81.131 -l apicadm
11. register portal
Page 6 of 12
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=topology-registering-portal-service
Reference: https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?
topic=appliance-configuring-developer-portal-subsystem
3.2.3 Deploy API Developer Portal OVA
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=appliance-deploying-management-
subsystem-ova-file
3.2.4 Verify deploy API Developer
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=appliance-verifying-deployment-
developer-portal-subsystem
3.3 Deployment API Analytic
3.3.1 Preparing
Add A records to dns configuration:
o Analytics ingestion: analytic.api.devtest.bca
3.3.2 Create API Analytic ISO
1. Change to the project directory
cd myProject
2. Create an analytics subsystem
apicup subsys create analyt analytics
3. Specify your deployment-profile
apicup subsys set analyt deployment-profile=n1xc2.m16
4. Specify the license use that you purchased
apicup subsys set analyt license-use=nonproduction
5. Set your ingestion endpoint
apicup subsys set analyt analytics-ingestion=analytic.api.devtest.bca
6. Set your search domain. Multiple search domains should be separated by commas.
apicup subsys set analyt search-domain=devtest.bca
7. Set your domain name servers (DNS)
apicup subsys set analyt dns-servers=192.168.81.129
8. Set a Public key
apicup subsys set analyt ssh-keyfiles=C:\temp\management\openssl\
id_rsa.pub
Page 7 of 12
9. You can set the password that you enter to log into your Analytics server for the first time
apicup subsys set analyt
default-password=$6$rounds=4096$vG/2.8R5EPSrUKXj$XuORjk7Vd93KMnOIDNvuMX
9IEeBhgHoVxt09GB9zwojlioVLrZUZRUSPgp1hLI/a7cdgQsmZezVeDaLqDsCZm
10. Define the hostname for each subsystem node you are deploying
apicup hosts create analyt analytic.api.devtest.bca hd_password
11. Define the network interface for each subsystem node you are deploying
apicup iface create analyt analytic.api.devtest.bca eth0
192.168.81.132/255.255.255.0 192.168.81.2
12. Verify that the configuration settings are valid
apicup subsys get analyt --validate
13. Create your ISO files
apicup subsys install analyt --out analytplan
14. Verify the installation
ssh 192.168.81.132 -l apicadm
sudo apic status
14. Enable analytic cloud manager of management
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=topology-registering-analytics-
service
15. Associating an analytics service with a gateway service
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=topology-associating-analytics-
service-gateway-service
3.3.3 Deploy API Analytic OVA
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=subsystem-deploying-analytics-
ova-file
3.3.4 Verify deploy API Analytic
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=subsystem-verifying-deployment-
analytics
Page 8 of 12
3.4 Deployment API Gateway - Datapower
3.4.1 Datapower Initialization
https://www.ibm.com/docs/en/datapower-gateway/10.5.0?topic=virtual-initializing-datapower-
gateway
3.4.2 Configuring Datapower API Gateway
You can skip optional steps and turn of peering group at each step (follow the guide)
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=connect-configuring-datapower-
api-gateway
Note: for step f at “13. Define a configuration sequence”, you need to create new access proflile
and key in permission string: */*/*?Access=a+w+r+d+x
Original
Click add to create new profile
Select location “local:///”
Click to create new access profile
Page 9 of 12
You need to fill the access profile name “access-profile” and access policies “*/*/*?
Access=a+w+r+d+x”
Then click add to apply access policies
Page 10 of 12
Then click apply to create access profile and pick up it for configuration sequence.
Click apply to finish.
Page 11 of 12
Reference
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=connect-deploying-developer-
portal-virtual-appliance
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=connect-deploying-management-
virtual-appliance
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=connect-deploying-analytics-
virtual-appliance
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=vmware-installing-api-connect
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=connect-configuring-datapower-
api-gateway
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=mac-disabling-re-enabling-
analytics-subsystem-openshift-cloud-pak-integration
https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=topology-registering-portal-service
Page 12 of 12
