Versions Compared

Key

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

When a WSO2 product server starts, it starts all features and related artifacts bundled in the product. 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.

Execute one of the following commands to start a product on a preferred profile.

OSCommand
Windows
<PRODUCT_HOME>/bin/wso2server.bat -Dprofile=<preferred-profile> --run
Linux/Solaris

sh <PRODUCT _HOME>/bin/wso2server.sh -Dprofile=<preferred-profile>

...

ProfileCommand Option with Profile NameDescription
Gateway manager
-Dprofile=gateway-manager
Used when the API Gateway acts as a manager node in a cluster. This profile starts front-end/UI features such as login as well as back-end services that allow the product instance to communicate with other nodes in the cluster.
Gateway worker
-Dprofile=gateway-worker
Used when API Gateway acts as a worker node in a cluster. This profile only starts the back-end features for data processing and communicating with the manager node.
Key Manager
-Dprofile=api-key-manager
Starts only the features relevant to the Key Manager component of API Manager.
API Publisher
-Dprofile=api-publisher
Starts only the front-end/back-end features relevant to the API Publisher Web interface.
API Store
-Dprofile=api-store
Starts only the front-end/back-end features relevant to the API Store Web interface.
Tip

Note that the WSO2 products platform currently doesn't block/allow Web applications depending on profiles. 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 will still be able to access the API Publisher Web application.

How multi-profiling works

...