This documentation is for WSO2 API Manager 1.8.0 View documentation for the latest release.
Product Profiles - API Manager 1.8.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

When a WSO2 product starts, it starts all features and related artifacts bundled with it. Multi-profile support allows you to run the product on a selected profile so that only features specific to that profile along with common features start up with the server. This enables better resource utilization.

Given below are the different profiles available in WSO2 API Manager.

Note the following:

  • You can start only one profile at a time.
  • Starting a product on a preferred profile only blocks/allows the relevant OSGI bundles. As a result, even if you start the server on a profile such as the api-store for example, you can still access the API Publisher web application.
ProfileCommand Option with Profile NameDescription
Gateway manager
Used when the API Gateway acts as a manager node in a cluster. This profile starts frontend/UI features such as login as well as backend services that allow the product instance to communicate with other nodes in the cluster.
Gateway worker
Used when API Gateway acts as a worker node in a cluster. This profile only starts the backend features for data processing and communicating with the manager node.
Key Manager
Starts only the features relevant to the Key Manager component of API Manager.
API Publisher
Starts only the front end/backend features relevant to the API Publisher Web interface.
API Store
Starts only the front end/backend features relevant to the API Store Web interface.

Execute the following commands to start a product on any profile:

<PRODUCT_HOME>/bin/wso2server.bat -Dprofile=<preferred-profile> --run
Linux/Solarissh <PRODUCT _HOME>/bin/ -Dprofile=<preferred-profile>

How multi-profiling works

Starting a product on a preferred profile starts only a subset of features bundled in the product. In order to identify what feature bundles apply to which profile, each product maintains a set of files in <PRODUCT_HOME>/repository/components/<profile-name>/configuration/org.eclipse.equinox.simpleconfigurator directories. The files contain references to the actual bundles. Note that <profile-name> in the directory path refers to the name of the profile. For example, when there's a product profile named webapp, references to all the feature bundles required for webapp profile to function are in a file saved in <PRODUCT_HOME>/repository/components/webapp/configuration/org.eclipse.equinox.simpleconfigurator directory.

Note that when you start the server without using a preferred profile, the server refers to <PRODUCT_HOME>/repository/components/default/configuration/org.eclipse.equinox.simpleconfigurator/ file by default. This file contains references to all bundles in <PRODUCT_HOME>/repository/components/plugins directory, which is where all components/bundles of a product are saved.

  • No labels