Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

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

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

ProfileCommand Option with Profile NameDescription
Gateway manager
-Dprofile=gateway-manager

Starts only the components related to the API Gateway.

You use this 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
-Dprofile=gateway-worker

Starts only the components related to the API Gateway.

 You use this when the 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 ManagerValidator
-Dprofile=api-key-managervalidator
Starts only the features relevant to the Key Manager Validator component of the API Manager.
API Publisher
-Dprofile=api-publisher
Starts only the front end/backend features relevant to the API Publisher.
API Store
-Dprofile=api-store
Starts only the front end/backend features relevant to the API Store.

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.

If the profile that you prefer doesn't exist, you can manually remove the unwanted components. For example, if you want to have the Key Manager Validator and Gateway components together, as we don't have a product profile for that combination, you can take the API Manager and manually remove the API Store and Publisher from it. That will start the Gateway and the Key Manager Validator in one VM.

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

...