

Configuring a Distributed API-M Deployment with Gateway and Control Plane

The WSO2 API-M server can be deployed as an all-in-one deployment or as a distributed deployment. In the distributed setup, the API-M server profiles are deployed as separate API-M nodes.

Given below are the API-M nodes you can have in a distributed deployment by default.

Tip

To enable high availability, you need a minimum of two nodes running each profile.

API-M Node (Profile)	Description
Gateway Worker Node	API-M nodes running the Gateway profile.
Control Plane Node	API-M nodes running the Control Plane profile. The Control Plane includes the Traffic Manager, Key Manager, Publisher, and Developer Portal components.

Step 1 - Install WSO2 API-M

To install and set up the API-M servers:

1. Download the WSO2 API Manager.
2. Create copies of the API-M distribution for the individual profiles.

Step 2 - Install and configure the databases

You can create the required databases for the API-M deployment in a separate server and point to the databases from the respective nodes.

For information, see Installing and Configuring the Databases.

Step 3 - Configure your deployment with production hardening

Ensure that you have taken into account the respective security hardening factors (e.g., changing and encrypting the default passwords, configuring JVM security, etc.) before deploying WSO2 API-M.

For more information, see Production Deployment Guidelines.

Step 4 - Create and import SSL certificates

Create an SSL certificate for each of the WSO2 API-M nodes and import them to the keystore and the truststore. This ensures that hostname mismatch issues in the certificates will not occur.

Note

The same primary keystore should be used for all API Manager instances to decrypt the registry resources. For more information, see Configuring the Primary Keystore.

For more information, see Creating SSL Certificates.

Step 5 - Configure API-M Analytics

API Manager Analytics is delivered via the API Manager Analytics cloud solution. You need to configure the API Manager Gateway to publish analytics data to the cloud.

See the instructions on configuring the API Gateway with the cloud-based analytics solution.

Step 6 - Configure and start the profiles

Let's configure the API-M nodes in the deployment.

Configure the Gateway Nodes

Configure the Gateway to communicate with the Control Plane.

1. Open the <API-M_HOME>/repository/conf/deployment.toml file of the Gateway node.

2. Add the following configurations to the deployment.toml file.

   Connecting the Gateway to the Key Manager component in the Control Plane:

   Control Plane with HA

   
   [apim.key_manager]
   service_url = "https://[control-plane-LB-host]/services/"
   username = "$ref{super_admin.username}"
   password = "$ref{super_admin.password}"   

   Single Control Plane

   
   [apim.key_manager]
   service_url = "https://[control-plane-host]:${mgt.transport.https.port}/services/"
   username = "$ref{super_admin.username}"
   password = "$ref{super_admin.password}"

   Connecting the Gateway to the Traffic Manager component in the Control Plane:

   Control Plane with HA

   
   [apim.throttling]
   service_url = "https://[Traffic-Manager-LB-Host]/services/"
   throttle_decision_endpoints = ["tcp://control-plane-1-host:5672", "tcp://control-plane-2-host:5672"]
   
   [[apim.throttling.url_group]]
   traffic_manager_urls = ["tcp://control-plane-1-host:9611"]
   traffic_manager_auth_urls = ["ssl://control-plane-1-host:9711"]
   
   [[apim.throttling.url_group]]
   traffic_manager_urls = ["tcp://control-plane-2-host:9611"]
   traffic_manager_auth_urls = ["ssl://control-plane-2-host:9711"]

   Single Control Plane

   
   [[apim.throttling.url_group]]
   traffic_manager_urls = ["tcp://control-plane-host:9611"]
   traffic_manager_auth_urls = ["ssl://control-plane-host:9711"]
   
   [apim.throttling]
   service_url = "https://control-plane-host:${mgt.transport.https.port}/services/"
   throttle_decision_endpoints = ["tcp://control-plane-host:5672"]

3. Add the following configuration to the deployment.toml file to configure the Gateway environment. Change the gateway_labels property based on your Gateway environment.

   ```toml
   
   [apim.sync_runtime_artifacts.gateway]
   gateway_labels =["Default"]
   ```

4. Enable JSON Web Token (JWT) if required. For instructions, see Generating JSON Web Token.

5. Add the public certificate of the private key (that is used for signing the tokens) to the truststore under the "gateway_certificate_alias" alias. For instructions, see Create and import SSL certificates.

   Note

   This is not applicable if you use the default certificates, which are the certificates that are shipped with the product itself.

6. Follow the steps given below to configure High Availability (HA) for the API-M Gateway:

   1. Create a copy of the API-M Gateway node that you just configured. This is the second node of the API-M Gateway cluster.

   2. Configure a load balancer fronting the two Gateway nodes in your deployment. For instructions, see Configuring the Proxy Server and the Load Balancer.

      Note

      To keep custom runtime artifacts deployed in the Gateway, add the following configuration in the /repository/conf/deployment.toml file of the Gateway nodes.

      
      [apim.sync_runtime_artifacts.gateway.skip_list]
      apis = ["api1.xml","api2.xml"]
      endpoints = ["endpoint1.xml"]
      sequences = ["post_with_nobody.xml"]
      local-entries = ["file.xml"]

   3. Open the deployment.toml files of each Gateway node and add the cluster hostname. For example, if the hostname is gw.am.wso2.com:

      
      [server]
      hostname = "gw.wso2.com"

   4. Specify the following incoming connection configurations in the deployment.toml files of both nodes.

      
      [transport.http]
      properties.port = 9763
      properties.proxyPort = 80
      
      [transport.https]
      properties.port = 9443
      properties.proxyPort = 443

   5. Open the server's /etc/hosts file and map the hostnames to IPs.

      Format: <GATEWAY-IP> gw.wso2.com

      Example: xxx.xxx.xxx.xx4 gw.wso2.com

Sample configuration for the Gateway

[server]
hostname = "gw.wso2.com"
node_ip = "127.0.0.1"
server_role = "gateway-worker"
offset=0

[user_store]
type = "database_unique_id"

[super_admin]
username = "admin"
password = "admin"
create_admin_account = true

[database.shared_db]
type = "mysql"
hostname = "db.wso2.com"
name = "shared_db"
port = "3306"
username = "root"
password = "root"

[keystore.tls]
file_name =  "wso2carbon.jks"
type =  "JKS"
password =  "wso2carbon"
alias =  "wso2carbon"
key_password =  "wso2carbon"

[truststore]
file_name = "client-truststore.jks"
type = "JKS"
password = "wso2carbon"

[apim.key_manager]
service_url = "https://cp.wso2.com:9443/services/"

[apim.throttling]
service_url = "https://tm.wso2.com:9443/services/"
throttle_decision_endpoints = ["tcp://tm.wso2.com:5672"]

[[apim.throttling.url_group]]
traffic_manager_urls=["tcp://tm.wso2.com:9611"]
traffic_manager_auth_urls=["ssl://tm.wso2.com:9711"]

[apim.cors]
allow_origins = "*"
allow_methods = ["GET","PUT","POST","DELETE","PATCH","OPTIONS"]
allow_headers = ["authorization","Access-Control-Allow-Origin","Content-Type","SOAPAction"]
allow_credentials = false

[apim.sync_runtime_artifacts.gateway]
gateway_labels =["Default"]

Configure the Control Plane Nodes

Configure the Control Plane to communicate with the Gateway.

1. Open the <API-M_HOME>/repository/conf/deployment.toml file of the Control Plane node.

2. Add the following configurations to the deployment.toml file.

   Info

   This configuration is used for publishing APIs to the Gateway and for connecting the Developer Portal component to the Gateway.

   Gateway with HA

   
   [[apim.gateway.environment]]
   name = "Default"
   type = "hybrid"
   display_in_api_console = true
   description = "This is a hybrid gateway that handles both production and sandbox token traffic."
   show_as_token_endpoint_url = true
   service_url = "https://[api-gateway-LB-host]/services/"
   ws_endpoint = "ws://[api-gateway-LB-host-or-ip]:9099"
   wss_endpoint = "wss://[api-gateway-LB-host-or-ip]:8099"
   http_endpoint = "http://[api-gateway-LB-host]"
   https_endpoint = "https://[api-gateway-LB-host]"
   

   Single Gateway

   
   [[apim.gateway.environment]]
   name = "Default"
   type = "hybrid"
   display_in_api_console = true
   description = "This is a hybrid gateway that handles both production and sandbox token traffic."
   show_as_token_endpoint_url = true
   service_url = "https://[api-gateway-host]:9443/services/"
   ws_endpoint = "ws://[api-gateway-host]:9099"
   wss_endpoint = "wss://[api-gateway-host]:8099"
   http_endpoint = "http://[api-gateway-host]:${http.nio.port}"
   https_endpoint = "https://[api-gateway-host]:${https.nio.port}"
   

3. Optionally, add the following configuration to enable distributed cache invalidation within the nodes.

   
   [apim.cache_invalidation]
   enabled = true
   domain = "control-plane-domain"

4. Follow the steps given below to configure High Availability (HA) for the Control Plane:

   1. Create a copy of the API-M Control Plane node that you just configured. This is the second node of the API-M Control Plane cluster.

   2. Configure a load balancer fronting the two Control Plane nodes in your deployment. For instructions, see Configuring the Proxy Server and the Load Balancer.

Sample configuration for the Control Plane

[server]
hostname = "cp.wso2.com"
node_ip = "127.0.0.1"
server_role = "control-plane"
offset=0

[user_store]
type = "database_unique_id"

[super_admin]
username = "admin"
password = "admin"
create_admin_account = true

[database.apim_db]
type = "mysql"
hostname = "db.wso2.com"
name = "apim_db"
port = "3306"
username = "root"
password = "root"

[database.shared_db]
type = "mysql"
hostname = "db.wso2.com"
name = "shared_db"
port = "3306"
username = "root"
password = "root"

[keystore.tls]
file_name =  "wso2carbon.jks"
type =  "JKS"
password =  "wso2carbon"
alias =  "wso2carbon"
key_password =  "wso2carbon"

# Gateway configuration
[[apim.gateway.environment]]
name = "Default"
type = "hybrid"
display_in_api_console = true
description = "This is a hybrid gateway that handles both production and sandbox token traffic."
show_as_token_endpoint_url = true
service_url = "https://gw.wso2.com:9443/services/"
username= "${admin.username}"
password= "${admin.password}"
ws_endpoint = "ws://gw.wso2.com:9099"
wss_endpoint = "wss://gw.wso2.com:8099"
http_endpoint = "http://gw.wso2.com:8280"
https_endpoint = "https://gw.wso2.com:8243"

[apim.cors]
allow_origins = "*"
allow_methods = ["GET","PUT","POST","DELETE","PATCH","OPTIONS"]
allow_headers = ["authorization","Access-Control-Allow-Origin","Content-Type","SOAPAction"]
allow_credentials = false

Step 7 - Start the API-M nodes

Once you have successfully configured all the API-M nodes in the deployment, you can start the servers.

• Starting the Gateway nodes

  Open a terminal, navigate to the <API-M-GATEWAY-HOME>/bin folder, and execute the following command:

  Linux/Mac OS

  cd <API-M_HOME>/bin/
  sh api-manager.sh -Dprofile=gateway-worker

  Windows

  cd <API-M_HOME>\bin\
  api-manager.bat --run -Dprofile=gateway-worker

• Start the Control Plane nodes

  Open a terminal, navigate to the <API-M-CONTROL-PLANE-HOME>/bin folder, and execute the following command:

  Linux/Mac OS

  cd <API-M_HOME>/bin/
  sh api-manager.sh -Dprofile=control-plane

  Windows

  cd <API-M_HOME>\bin\
  api-manager.bat --run -Dprofile=control-plane

For more information on starting API-M profiles, see API-M Profiles.

Top