top of page

API Connect V2018.4.x – Kubernetes Deployment on Google Cloud Platform (GCP)

With IBM API Connect v2018.x, IBM had provided deployment options for API Cloud components (Management Server, Analytics, Developer Portal and Gateway servers) as either Appliance-based (OVA) or Container-based (Kubernetes).

I have been trying to have the API Connect V2018.4.x on Google Cloud Platform, container-based deployment for the following 3 components –

  1. Management Server

  2. Analytics Server

  3. Developer Portal Server

and the other Gateway server also on Google Cloud Platform, but using linux deployment option.

Have provided the process below which I had followed for the API Cloud V2018.4.x setup on Google Cloud Platform. Hope this will guide you in setting up your own environment.

Requirements:

  1. API Connect V2018.4.x container based images and the install assist utility (apicup) for windows downloaded from IBM Fix Pack central

  2. Docker installed on the local machine / laptop

  3. For Windows 10 Pro / Enterprise Edition that comes with Hyper-V enabled, follow the following link to setup docker on your local machine https://docs.docker.com/docker-for-windows/install/

  4. For Older Windows version or Windows 10 Home edition, without Hyper-V, following the following link to setup docker on local machine https://docs.docker.com/toolbox/toolbox_install_windows/

  5. Google Cloud SDK setup on local machine / laptop ( Follow the steps are per the link https://cloud.google.com/sdk/docs/quickstarts , to setup Google Cloud SDK on your local machine, as per your OS )

  6. Helm (kubernetes Package Manager) installed and added to Environment Variable Path of the window machine. Refer to https://helm.sh/docs/using_helm/#installing-helm. Use the “From the Binary Releases” option for installing Helm.

  7. SMTP Server –> We will subscribe to fake SMTP service offered by MailTrap. Create a free account in mailtrap.io and access the Demo Inbox setup for SMTP server access details.VariablePurpose / ObjectiveYOUR-DNSrefers to domain name registered in your Google DomainsNAMESPACErefers to the kubernetes namespace created for API Connect components deploymentIMAGE-PATHrefers to the path on local machine where the API Connect component’s container images are placed. Its assumed the softwares / images have been already downloaded from IBM Fix Central and placed in this directoryPROJECT-IDrefers to the id of the Google Cloud project created in GCP for the purpose of API Connect deployment and in which Kubernetes cluster will be createdPROJECT-NAMErefers to the name of the Google Cloud project created in GCP for the purpose of API Connect deployment and in which Kubernetes cluster will be createdGCP-HOSTspecifies the region of the registry’s storage (in our case same as the zone / region of our kubernetes cluster deployment. The valid options are (refer https://cloud.google.com/container-registry/docs/pushing-and-pulling?hl=en_US) :

a) gcr.io hosts the images in the United States, but the location may change in the future b) us.gcr.io hosts the image in the United States, in a separate storage bucket from images hosted by gcr.io c) eu.gcr.io hosts the images in the European Union d) asia.gcr.io hosts the images in AsiaMGMT-IMAGErefers to image file name of API Connect Management Server image downloaded from IBM site, with absolute pathANALYTICS-IMAGErefers to image file name of API Connect Analytics Server image downloaded from IBM site, with absolute pathPORTAL-IMAGErefers to image file name of API Connect Portal Server image downloaded from IBM site, with absolute pathCLUSTER-IPrefers to external IP address assigned to ingress load balance after ingress deployment to the clusterMGMT-SUBSYSTEM-NAMErefers to Management subsystem name for deployment. e.g. mgmtANALYTICS-SUBSYSTEM-NAMErefers to Analytics subsystem name for deployment. e.g. analytPORTAL-SUBSYSTEM-NAMErefers to Portal subsystem name for deployment. e.g. ptl

Extract the APIC Install Assist Utiltiy

  1. Extract the apicup install assist utility to a desired directory on the local machine

  2. Add the directory into which apicup utility is extracted to the PATH environment variables on windows

  3. Open a command window and type apicup version to confirm the file is being recognized

apicup version

Creating & Setting up Google Cloud Platform account:

  1. Access Google Cloud Platform link [https://cloud.google.com]

  2. Login using existing google account to subscribe to Google Cloud Platform using that account, otherwise create new a new account

Sign-in / Create Google Account
  1. Once logged in either using existing Google account or the newly created one, click on the option “Get started for free”

  2. Select the country and accept the Terms of Service for continuing the subscription to Google Cloud Platform.

Google Cloud Platform Subscription - Step 1
  1. In the next step, provide your details and the credit card information to complete subscription and get $300 credit for max 1 year usage.

  2. Once logged in the Google Cloud Console, create a new project (lets say apic-project , and will be using the same project reference through out this blog as [PROJECT-ID]) for our API Connect deployment

Google Cloud - Creating new project

Initializing Google Cloud SDK on Local Machine

  1. Open the installed Google Cloud SDK shell from the desktop or Program Menu option on Windows

Google Cloud SDK Shell
  1. Initialize Google Cloud SDK environment from the Google Cloud SDK shell using gcloud init command and follow the instructions to complete the process.

Google Cloud SDK Initialization
Google Cloud SDK Initialization
  1. If required, relogin to the google cloud account from google cloud command window, using “gcloud auth login” and following the steps

  2. Set the GCP Project ID using the command

gcloud config set project [PROJECT-ID]

Creating Kubernetes Cluster on Google Cloud Platform

  1. If not logged in already, log into the Google Cloud Account.

  2. From the left navigation pane, navigate to (Compute section) Kubernetes Engine > Clusters

Create Kubernetes Cluster
  1. Wait till, the Kubernetes Engine API gets enabled. Once its enabled, click on “Create Cluster” option to start defining cluster in GCP

Create new Kubernetes Cluster
  1. Configure the Standard Cluster template as per our requirement. ( For our deployment scenarion, we will be creating cluster with 1 node with 8 CPU and 32 GB RAM )

  2. Cluster Name: apic-cluster

  3. Location type: Zonal (default)

  4. Zone: us-central-a (default)

Kubernetes cluster zonal configuration

Click on “More options” under default-pool section for following configuration

Node Pool Configuration
  1. Number of Nodes: 1

  2. Image Type: Ubuntu

Default Pool Configuration - nodes & image type
  1. Machine Type: Custom

  2. cores: 8 vCPU

  3. memory: 32 GB

Default Pool Configuration - Machine Type configuration
  1. Boot disk size: 600 GB

  2. Management: Uncheck the options “Enable auto-upgrade” & “Enable auto-repair

  3. Under Security, select Access scopes as “Allow full access to all Cloud APIs” and click Save.

Default Pool Configuration - Boot disk and security

Expand Availability, networking, security and additional features option to configure the following options

Kubernetes Cluster - Availability & networking configuration
  1. Uncheck Enable HTTP load balancing option under Load Balancing section

Kubernetes Cluster - Load Balancing configuration
  1. Enable Stackdriver Kubernetes Engine Monitoring option under Stackdriver section

  2. Click on Create to create a new Kubernetes cluster as per our configuration

Kubernetes Cluster - Stackdriver configuration
Kubernetes Cluster Created

Load API Connect Container Images to GCP Container Registry

As part of this section, we will be uploading the API Connect container images for Management Server, Analytics & Developer Portal into the Container Registry on GCP

  1. Using GCP Navigation Menu, navigate to Container Registry > Images page

Container Registry Page
  1. Wait till Container Registry gets enabled

  2. Open command window on the local windows machine

  3. Upload the API Connect Management server container image to the container registry using the apic install assist utility

apicup registry-upload management [MGMT-IMAGE] [GCP-HOST]/[PROJECT-ID]

e.g:

apicup registry-upload management D:\Installation\management-images-kubernetes_lts_v2018.4.1.6-ifix3.0.tgz gcr.io/apic-project-257306

Upload Management Server Image
  1. Upload the API Connect Analytics server container image to the container registry using the apic install assist utility

apicup registry-upload management [ANALYTICS-IMAGE] [GCP-HOST]/[PROJECT-ID]

e.g:

apicup registry-upload analytics D:\Installation\analytics-images-kubernetes_lts_v2018.4.1.6-ifix3.0.tgz gcr.io/apic-project-257306

Upload Analytics Server Image
  1. Upload the API Connect Portal server container image to the container registry using the apic install assist utility

apicup registry-upload management [PORTAL-IMAGE] [GCP-HOST]/[PROJECT-ID]

e.g:

apicup registry-upload portal D:\Installation\portal-images-kubernetes_lts_v2018.4.1.6-ifix3.0.tgz gcr.io/apic-project-257306

Upload Portal  Server Image

Configuring Kubernetes Cluster for API Connect Deployment

  1. Open Google Cloud SDK shell, if not opened already and if reuqired, login to the Google Cloud using gcloud auth login.

  2. From the Google Cloud Console, navigate to the earlier created Kubernete cluster and click on “connect” to get the connection details for the cluster

Kubernetes Cluster Connection Details
  1. In the Connect to the Cluster window, copy the command-line access command and run it from the google cloud sdk shell on the local machine to have cluster configuration stored locally

Kubernetes Cluster Configuration
Kubernetes Cluster Configuration - SDK Shell
  1. Create namespace “apiconnect” for our API Connect components within Kubernetes Cluster using the below command. Am using namespace “apiconnect”, but we can specify any namespace name we would like to have.

 kubectl create namespace apiconnect
Kubernetes Cluster - Namespace creation
  1. To deploy tiller component into the Kubernetes cluster, we would need to create service account and cluster role binding using the following command

 kubectl create serviceaccount --namespace kube-system tiller
 kubectl create clusterrolebinding tiller-cluster-rule --clusterrole=cluster-admin --serviceaccount=kube-system:tiller
Kubernetes Cluster - Service Account
  1. Initiliaze helm (package manager for kubernetes) and to deploy the tiller component to the kubernetes cluster

 helm init --service-account=tiller
Kubernetes Cluster - Helm Init
  1. Deploy the ingress to the cluster using the following command. Download the nginx-ingress-values.yaml and save to the local machine in [IMAGE-PATH]

 helm install stable/nginx-ingress --name ingress --values [IMAGE-PATH]\nginx-ingress-values.yaml --namespace apiconnect
Kubernetes Cluster - Ingress Deployment
  1. Get the details of the deployed ingress service using the command. Re-run the command multiple times, until external IP address is assigned to the ingress load balancer. Note down the IP address shown for External-IP column. Henceforth this value will be referred as [CLUSTER-IP]

 kubectl get service -l app=nginx-ingress --namespace apiconnect
Kubernetes Cluster - Ingress Status
  1. In the Google Cloud Console, navigate to Compute Engine > VM Instances under Compute section.

Compute Engine - VM
  1. Click on SSH next to the VM instances corresponding to our kubernetes cluster. In the SSH window execute the following commands to configure vm.max_map_count system propertly, required for Analytics service component. Close the window once executed these commands.

sudo sysctl -w vm.max_map_count=262144
sudo sysctl -p
sudo sysctl vm.max_map_count
Compute Engine - VM SSH
Compute Engine - VM SSH

Configuring DNS for API Connect

We will now create Cloud DNS service in our GCP and add record sets for the API Connect End points host name pointing to our [CLUSTER-IP] of ingress load balancer, that had been deployed into the kubernetes cluster.

  1. From Google Cloud Console, navigate to Network Services > Cloud DNS under Networking section

Cloud DNS
  1. Create a zone (e.g. apic-dns) for the DNS (to be the same as your domain name created in Google Domain earlier) in the Cloud DNS and click Create. I have named my DNS name “nebula-training”, the domian that I have registered for me in Google Domain

Cloud DNS - Zone
Cloud DNS - DNS
  1. Create DNS entry for our API Connect Endpoints mapping to the [CLUSTER-IP], by adding record sets to the zone we just created in Cloud DNSAPI Connect SubsystemAPI Connect EndpointHost NameIP AddressManagementplatform-apiapi.[YOUR-DNS][CLUSTER-IP]Managementapi-manager-uiapim.[YOUR-DNS][CLUSTER-IP]Managementcloud-admin-uicmc.[YOUR-DNS][CLUSTER-IP]Managementconsumer-apicns-api.[YOUR-DNS][CLUSTER-IP]Analyticsanalytics-ingestionai.[YOUR-DNS][CLUSTER-IP]Analyticsanalytics-clientac.[YOUR-DNS][CLUSTER-IP]Portalportal-adminpa.[YOUR-DNS][CLUSTER-IP]Portalportal-wwwptl.[YOUR-DNS][CLUSTER-IP]

Cloud DNS - Record Set 1
Cloud DNS - Record Set 2
Cloud DNS - Record Set 3
  1. Copy / Note down the Nameserver details from the GCP Cloud DNS for configuring the DNS setting in the google domain

Cloud DNS - Nameserver
  1. Update the DNS in Google Domain with the Nameservers of Cloud DNS. Access your domain in google domains (https://domains.google.com) from “My Domains” section.

  2. Click Manage next to your domain name

Cloud DNS - DNS Manage
  1. Click on DNS in the navigation menu on left

Cloud DNS - DNS Config
  1. Add the Nameserver details from the GCP Cloud DNS in the Name servers section by selecting “Use custom name server” option

Cloud DNS - Nameserver

Creating API Connect Deployment Configuration using Install Assist

Now that we have setup the Kubernetes cluster and have required endpoints information of API Connect components / subsystem, lets use the apicup install utility to create deployment / installation configuration

  1. Create Installation Project directory, e.g. D:\apic2018

  2. Open command window and change the current directory to the newly created Installation Project directory.

  3. Initialize the Installation directory by running the command

 apicup init
  1. Create Management subsystem for K8 (kubernetes) deployment and its configuration

 apicup init
 apicup subsys create mgmt management --k8s
 apicup subsys set mgmt namespace [KUBE-NAMESPACE]
 apicup subsys set mgmt mode dev
 apicup subsys set mgmt ingress-type ingress
 apicup subsys set mgmt registry [GCP-HOST]/[PROJECT-ID] 
 apicup subsys set mgmt platform-api api.[YOUR-DNS]
 apicup subsys set mgmt api-manager-ui apim.[YOUR-DNS]
 apicup subsys set mgmt cloud-admin-ui cmc.[YOUR-DNS]
 apicup subsys set mgmt consumer-api cns-api.[YOUR-DNS]
 apicup subsys set mgmt cassandra-cluster-size 1
APICUP - Management Server
  1. Create Analytics subsystem for K8 (kubernetes) deployment and its configuration

 apicup subsys create analyt analytics --k8s
 apicup subsys set analyt analytics-ingestion ai.[YOUR-DNS]
 apicup subsys set analyt analytics-client ac.[YOUR-DNS]
 apicup subsys set analyt registry [GCP-HOST]/[PROJECT-ID]
 apicup subsys set analyt namespace [KUBE-NAMESPACE]
 apicup subsys set analyt coordinating-max-memory-gb 6
 apicup subsys set analyt data-max-memory-gb 6
 apicup subsys set analyt data-storage-size-gb 200
 apicup subsys set analyt master-max-memory-gb 6
 apicup subsys set analyt master-storage-size-gb 5
 apicup subsys set analyt mode dev
APICUP - Analytics Server
  1. Create Portal subsystem for K8 (kubernetes) deployment and its configuration

 apicup subsys create ptl portal --k8s
 apicup subsys set ptl portal-admin pa.[YOUR-DNS]
 apicup subsys set ptl portal-www ptl.[YOUR-DNS]
 apicup subsys set ptl registry [GCP-HOST]/[PROJECT-ID]
 apicup subsys set ptl namespace [KUBE-NAMESPACE]
 apicup subsys set ptl mode dev
APICUP - Analytics Server
  1. All the configurations are stored in the “apiconnect.yaml” create in our Installation direction.

Installing / Deploying API Connect Subsytems using APICUP

With the apiconnect.yaml configured as per our deployment requirement, we could now install each of these subsystems into our kubernetes cluster, again using apicup install assist.

  1. Open the command window and navigate to Intallation project directory that we setup earlier, if not opened already.

  2. Install API Connect Management server subsystem into our Kubernetes cluster on GCP using apicup. This command would be deploying various pods and will be taking few minutes.

apicup subsys install mgmt
APICUP - Installing Management Server
  1. Verify the installation of Management server by using helm

 helm ls
APICUP - Verify Management Server
  1. Install API Connect Analytics server subsystem into our Kubernetes cluster on GCP using apicup. This command would be deploying various pods and will be taking few minutes.

 apicup subsys install analyt
APICUP - Installing Analytics Server
  1. Install API Connect Portal server subsystem into our Kubernetes cluster on GCP using apicup. This command would be deploying various pods and will be taking few minutes.

 apicup subsys install ptl
APICUP - Installing Portal Server
  1. To get the details of the node and pods created & their statuses as part of this deployment for all the subsystems, execute the following commands from the local Google SDK Shell.

 kubectl get nodes -n apiconnect
 kubectl get pods -n apiconnect
APICUP - Verify status

Installing DataPower Gateway on Linux for API Gateway

For API Gateway, we can use any DataPower deployment. I will be setting up DataPower on Linux on GCP for the purpose of this article / blog.

  1. Create a new VM on GCP with CentOS linux OS for the purpose of installing DataPower Gateway, by navigating to Compute Engine > VM Instances from Google Cloud Console. Click on “CREATE INSTANCE” to create a new VM.

APICUP - Create VM
  1. Configure the new VM

  2. Provide following details for the VM

 Name: [VM Name] e.g: apic-dp-vm
 Region: default
 Machine type: n1-standard-4
APICUP - Configure VM
  1. Change the OS for the VM to CentOS 7 and boot disk size

APICUP - Configure VM
APICUP - Configure VM
  1. Specify Access Scopes and firewall rules and click on Create.

APICUP - Configure VM
  1. New VM is created and shown

APICUP - Configure VM
  1. Reserve the External IP addresses for the new VM as well as the [CLUSTER-IP] of Kubernetes cluster by navigating to the VPC Network > External IP addresses in the Google Cloud Console

APICUP - Configure VM
APICUP - Configure VM
  1. Click the arrow mark next to Ephemeral value corresponding to the external ip address of our newly created VM and change the value to Static to reserve the External IP address. Perform the step for the [CLUSTER-IP] of Kubernetes cluster too.

APICUP - Reserve IP
APICUP - Reserve IP
  1. Configure Cloud DNS to add new record set for our DataPower VM Host Name (say, apigw.cloud-nebula.com) and corresponding external IP address mapping.

APICUP - DP Host Name
  1. Upload the DataPower linux installation image to the DataPower VM on the GCP, by clicking SSH for the VM and right clicking to select Upload File option

APICUP - Upload DP Image
APICUP - Upload DP Image
  1. Install the Datapower images using YUM command with root privileges

APICUP - DP Installation
APICUP - DP Installation
  1. Start the Datapower service and enable web-mgmt on default port 9090 and configure admin credentials. Credentials for initial login to datapower is admin / admin.

     sudo systemctl start datapower
     sudo yum install telnet
     telnet 0 2200
  1. Open firewall for port 9090 on Google Cloud Platform to able to access DP web user interface externally. Also open ports 3000 – 3010 for enabling communicatin between DP and API Connect Management Server and port 587 for communication with SMTP server

  2. Navigate to VPC Network > Firewall rules from Google Cloud Console

APICUP - GCP FW Rule
  1. Click on Create Firewall Rule to create a new ingress rule

APICUP - GCP FW Rule
  1. Configure the Firewall rule with appropirate name and following properties and click Create.

 Targets: All instances in the network
 Source IP ranges: 0.0.0.0/0
 Protocols & Ports: 9090,3000-3010,587
APICUP - GCP FW Rule

Configuring DataPower for API Gateway Mode

  1. Login to Datapower from browser using url https://apigw.%5BYOUR-DNS%5D:9090 and using the admin credentials you configured during installing DataPower. [For SSL Certificate Warning, accept and continue]. When logging in for first time, you will have to accept the software license for IBM DataPower. Post that, relogin to the DataPower using admin credentials and in default domain

APICUP - DP Login
  1. Create a new domain apic-dev for API Connect by navigating to Administration > Configuration > Application Domain and click on Add

APICUP - DP Application Domain
  1. Specify domain name as apic-dev and click Apply

APICUP - DP Application Domain
  1. Click Save Configuration on top bar and once saved, switch to newly created domain apic-dev

APICUP - DP Crypto Key
  1. Configuring SSL Server and SSL Client Profile in apic-dev domain of DataPower

  2. In the navigation window, search for Crypto and click on Crypto Tools from the search result.

  3. Specify the properties in Crypto Tools window and click on Generate Key. In the pop-up when asked to confirm, click on Confirm and then close.

APICUP - DP Crypto Tools
  1. Create new Crypto Key Object (search for Crypto Key in navigation menu) referring to the Private Key file generated earlier.

APICUP - DP Crypto Key
  1. Create new Crypto Certification object (search for Crypto Object in navigation menu) referring to the self-signed certificate file generated earlier.

APICUP - DP Crypto Certificate
  1. Create new Crypto Identification Credential object (search for Crypto Identification in navigation menu) referring to the Crypto Key & Crypto Certificate object generated earlier.

APICUP - DP Crypto Id Credential
  1. Create new Crypto Validation object (search for Crypto Validation in navigation menu) referring to the Crypto Certificate object generated earlier.

APICUP - DP Crypto Validation Credential
  1. Create new SSL Server object (search for SSL Server in navigation menu) referring to the Crypto Identification Object generated earlier.

APICUP - DP SSL Server
  1. Create new SSL Client object (search for SSL Client in navigation menu) referring to the Crypto Identification Object generated earlier.

APICUP - DP SSL Client
  1. Create new Gateway Peering object (search for Peering in navigation menu).

APICUP - Gateway Peering
  1. Create new Access Profile object (search for Access Profile in navigation menu).

APICUP - DP Access Profile
  1. Create new Configuration Sequence Object (search for Configuration Sequence in navigation menu) referring to the Access Profile Object generated earlier.

APICUP - DP Configuration Sequence
  1. Configure existing API Connect Gateway Service Object (search for API Connect in navigation menu) referring to the SSL Server, SSL Client & Gateway Peering Object generated earlier.

APICUP - DP API Connect Gateway Service
  1. Click Save configuration to persist the changes permenantly.

Configuring API Cloud using Cloud Management Console

With all pre-requisite taken care of, its time to setup API Cloud and topology using the Cloud Management Interface

  1. Access our API Connect Cloud Management Console from browser using the url https://cmc.%5BYOUR-DNS%5D/admin. Initial credential for login is admin / 7iron-hide.

Accessing Cloud Management UI
  1. Change the Password from default to the one of your own preference, along with email id (any value in valid email format, as we are using fake smtp server) for cloud administrator.

Cloud Management UI Changing Password
  1. Cloud Management Home Page is displayed, for further configurations

Cloud Management UI Home Page
  1. From the CMC Home Page, navigate to Settings > Notifications page to configure Sender Email address. Configure Sender Name and Email as per your requirement and click Save.

Cloud Management UI - Configuring Sender Email
Cloud Management UI - Configuring Sender Email
  1. To configure SMTP server that is to be used for sending emails from API Connect Platform, from the left navigation menu, navigate to Resources > Notifications and click Create to add new SMTP Server configuration

Cloud Management UI - Step 1 of Adding SMTP Server
  1. Provide the details as per the SMTP connection details of your inbox configured in your mailtrap.io account. Cick on Test email button to test your SMTP server configuration and once sucessfully tested, click Save to complete adding the Email Server.

Cloud Management UI - Step 2 of Adding SMTP Server
  1. Associate the newly added Email Server configuration to our API Cloud, by navigating to Settings > Notifications and clicking Edit in Sender & Email Server. Select the newly added Email Server and click on Save.

Cloud Management UI - Associating Email Server
  1. To confiure API Cloud topology for adding the Gateway Server, Portal and Analytics server, from the left navigation menu, navigate to Topology section.

  2. By default, a Default Availability Zone will be created. Availability Zone represents physical or logical data centers hosting our API Connect Subsystem servers. Only the Management component should span across Availability Zones, and all the other components shoud be confined to a particular Availability Zone only.

Step 1 of Topology Configuration
  1. To register a new Gateway service to our API Cloud, click on Register Service in Default Availability Zone. From the type of service shown, select the Service Type as DataPower API Gateway (in this article, we will be running DataPower Gateway in API mode).

Step 2 of Toplogy Configuration - Gateway Service Registration
  1. Provide the following details of the API Gateway Service and click Save

  2. Name: Any name for your service (e.g. dev-api-gtwy)

  3. Management Endpoint: https://apigw.%5BYOUR-DNS%5D:3000 (provide your DataPower Gateway hostname and for Port specify the value configured in Local Port property of API Gateway Service object in DataPower)

  4. TLS Client Profile: Select Default TLS client profile

Step 2a of Toplogy Configuration - Gateway Service Registration
  1. API Endpoint Base: https://apigw.%5BYOUR-DNS%5D (provide your DataPower Gateway hostname, and for Port specify the value configured in API Gateway Port propertye of API Gateway Service object in DataPower)

Step 2b of Toplogy Configuration - Gateway Service Registration
  1. API Gateway Service registration confirmation message would be displayed

Step 2c of Toplogy Configuration - Gateway Service Registration
  1. To register a new Analytics service to our API Cloud, click on Register Service in Default Availability Zone. From the type of service shown, select the Service Type as Analytics.

Step 3 of Toplogy Configuration - Analytics Service Registration
  1. Provide the following details of the Analytics Service and click Save

  2. Name: Any name for your service (e.g. dev-analytics-service)

  3. Management Endpoint: https://ac.%5BYOUR-DNS%5D (Corresponds to endpoint hostname configured for analytics-client while using apicup)

  4. TLS Client Profile: Select Analytics Client TLS client profile

Step 3a of Toplogy Configuration - Analytics Service Registration
  1. Analytics Service registration confirmation message would be displayed

Step 3b of Toplogy Configuration - Analytics Service Registration
  1. To associate the Analytics Service created with the API Gateway service, in the Topology screen, click Associate Analytics Service corresponding to the API Gateway service we had created earlier.

Step 4 of Toplogy Configuration - Portal Service Registration
  1. In the Associate Analytics Service window, select the newly added Analytics service and click Associate.

Step 4a of Toplogy Configuration - Portal Service Registration
  1. To register a new Portal service to our API Cloud, click on Register Service in Default Availability Zone. From the type of service shown, select the Service Type as Portal.

Step 5 of Toplogy Configuration - Portal Service Registration
  1. Provide the following details of the Portal Service and click Save

  2. Name: Any name for your service (e.g. dev-analytics-service)

  3. Management Endpoint: https://pa.%5BYOUR-DNS%5D (Corresponds to endpoint hostname configured for portal-admin while using apicup)

  4. TLS Client Profile: Select Portal Director TLS client profile

Step 5a of Toplogy Configuration - Portal Service Registration
  1. Portal Website URL: https://ptl.%5BYOUR-DNS%5D (Corresponds to endpoint hostname configured for portal-www while using apicup)

Step 5b of Toplogy Configuration - Portal Service Registration
  1. With this step we have created our API Cloud Topology with all API Connect subsystems / components

Step 6 of Toplogy Configuration - Portal Service Registration
  1. Next step is to create a Provider Organization (P.Org). There should be atleast 1 P.Org to be able to offer APIs for consumption. For the purpose of creating P.Org, navigate to Provider Organizations from the left-side navigation menu option. And click on Add to create a new P.Org. From the option shown, select Create Organization.

Step 1 of P.Org creation
  1. Provide the details for creating P.Org and click Create

- Title: Name for your P.Org
- Type of user: New User