Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Implementation Overview

...

  • Template module

    Panel
    borderColor#71CFF5
    borderWidth2

    The template module configures the product in runtime, with a set of key value pairs known as the configuration parameters.

    The template module provides a set of templates that is used to configure the specific product with the Configurator.

  • Cartridge agent plugin

    Panel
    borderColor#71CFF5
    borderWidth2

    The cartridge agent plugin, sets the runtime configuration parameters such as hostnames, IP addresses of dependent clusters, dynamic proxy ports and many more.

    The plugin configures the following and many more:

    • server hostname
    • cluster discovery parameters
    • proxy ports
  • Docker image

    Panel
    borderColor#71CFF5
    borderWidth2

    The Docker image is built by packaging the following components:

    • Cartridge agent

    • Product distribution

    • Template module

    • Configurator

    • Java runtime

  • Puppet module

    Panel
    borderColor#71CFF5
    borderWidth2

    The puppet module includes the same set of component as in the Docker image. In the puppet image the template module is used to configure automation.

Deploying WSO2 API Manager as a Service

Deploy WSO2 API Manager as a service using one of the following methods. 

  1. Deploy the application on Private PaaS when running on a Virtual Machine.
  2. Deploy the application on Private PaaS when running on Docker.

Deployment Architecture

The deployment architecture is designed to support different deployment patterns of API manager, within the the API manager application. It consists of two cartridge groups as shown below:

...

In the above deployment, five different Private PaaS clusters are created for the gateway manager, gateway worker, key manager, store and publisher. These clusters can be scaled independently. However there will be Carbon clusters created across different Private PaaS clusters. The gateway manager and gateway worker will connect to one Carbon cluster, the store and publisher will connect to another Carbon cluster and the key manager will have a separate Carbon cluster.

Template Module

The WSO2 AM 1.9.0 and 1.9.1 template module provides a set of templates that is used to configure the API Manager with the Configurator.

Info

You can find the WSO2 AM template module in the <wso2am-x.x.x-cartridge-4.1.0>/template-module directory (e.g., <wso2am-1.9.1-cartridge-4.1.0>/template-module), where <wso2am-x.x.x-cartridge-4.1.0> refers to the binary distribution of the respective WSO2 API Manager cartridge.

 

Cartridge Agent Plugin

The Server configurations are automated through the cartridge agent plugin, which was implemented for WSO2 AM 1.9.0.

The plugin configures the following and many more:

  • server hostname
  • cluster discovery parameters
  • proxy ports
Info

You can find the WSO2 AM 1.9.0 cartridge agent plugin here and the 1.9.1 cartridge agent plugin here.