Product Profiles

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.

Tip

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-devportal for example, you can still access the API Publisher web application.

Osgi

OSGI bundle is a tightly coupled, dynamically loadable collection of classes, jars, and configuration files that explicitly declare their external dependencies (if any). In OSGi, a bundle is the primary deployment format. Bundles are applications that are packaged in JARs, and can be installed, started, stopped, updated, and removed.

API-M Profiles

The following are the different profiles available in WSO2 API Manager.

Profile Command Option with Profile Name Description
Gateway worker
-Dprofile=gateway-worker   

Only starts the components related to the API Gateway.

You use this when the API Gateway acts as a worker node in a cluster. This profile starts the backend features for data processing and communicates with the management node.

Key Manager
-Dprofile=api-key-manager

Only starts the features relevant to the Key Manager component of the API Manager.

Traffic Manager
-Dprofile=traffic-manager


Only starts the features relevant to the Traffic Manager component of the API Manager.

The Traffic Manager helps users to regulate API traffic, make APIs and applications available to consumers at different service levels, and secure APIs against security attacks. The Traffic Manager features a dynamic throttling engine to process throttling policies in real-time, including rate limiting of API requests.

API Publisher
-Dprofile=api-publisher

Only starts the front end/backend features relevant to the API Publisher.


Developer Portal
-Dprofile=api-devportal

Only starts the front end/backend features relevant to the Developer Portal.


Starting an API-M profile

You can start an API Manager profile in the following methods, based on your requirement

Note

It is recommended to start the components in the following order: 

  1. Traffic Manager
  2. Key Manager
  3. Publisher
  4. Developer Portal
  5. Gateway

Method 1- Optimizing before starting the server

Create an optimized distribution for a particular API-M profile.

  1. Run the <API-M_HOME>/bin/profileSetup.sh script or <API-M_HOME>/bin/profileSetup.bat script based on your operating system, with the profile flag.

    sh <API-M_HOME>/bin/profileSetup.sh  -Dprofile=<preferred-profile>
    sh <API-M_HOME>/bin/profileSetup.sh  -Dprofile=api-publisher
    <PRODUCT_HOME>/bin/profileSetup.bat -Dprofile=api-publisher
  2. Start the server with the specified profile.

    sh <API-M_HOME>/bin/wso2server.sh -Dprofile=<preferred-profile>
    sh <API-M_HOME>/bin/wso2server.sh -Dprofile=api-publisher
    <PRODUCT_HOME>/bin/wso2server.bat -Dprofile=api-publisher

Method 2 - Optimizing while starting the server

  1. Start the server using the script based on your operating system, using the command given below.

    sh <PRODUCT_HOME>/bin/wso2server.sh --optimize -Dprofile=<preferred-profile>
    sh <PRODUCT_HOME>/bin/wso2server.sh --optimize -Dprofile=api-publisher
    <PRODUCT_HOME>/bin/wso2server.bat --optimize -Dprofile=api-publisher
    Click here to see the sample output when you optimize the server for Publisher profile while starting in Publisher profile.
    [2020-02-26 11:50:39] INFO - Starting to optimize API Manager for the API Publisher profile
    [2020-02-26 11:50:39] INFO - Starting to optimize configs in deployment.toml
    [2020-02-26 11:50:39] INFO - Renamed the existing ../repository/conf/deployment.toml file as deployment.toml
                .backup
    [2020-02-26 11:50:39] INFO - Renamed the existing ../repository/resources/conf/deployment-templates/api-publisher.toml file as deployment.toml
    [2020-02-26 11:50:39] INFO - Removed the WebSocketInboundEndpoint.xml file from ../repository/deployment/server/synapse-configs/default/inbound-endpoints/
    [2020-02-26 11:50:39] INFO - Removed the SecureWebSocketInboundEndpoint.xml file from ../repository/deployment/server/synapse-configs/default/inbound-endpoints/
    [2020-02-26 11:50:39] INFO - Removed the api#identity#consent-mgt#v1.0.war file from ../repository/deployment/server/webapps
    [2020-02-26 11:50:39] INFO - Removed the throttle#data#v1.war file from ../repository/deployment/server/webapps
    [2020-02-26 11:50:39] INFO - Removed the am#sample#pizzashack#v1.war file from ../repository/deployment/server/webapps
    [2020-02-26 11:50:39] INFO - Removed the api#am#store#v0.16.war file from ../repository/deployment/server/webapps
    [2020-02-26 11:50:39] INFO - Removed the api#am#store.war file from ../repository/deployment/server/webapps
    [2020-02-26 11:50:39] INFO - Removed the api#identity#recovery#v0.9.war file from ../repository/deployment/server/webapps
    [2020-02-26 11:50:39] INFO - Removed the api#identity#user#v1.0.war file from ../repository/deployment/server/webapps
    [2020-02-26 11:50:39] INFO - Removed the api#identity#oauth2#dcr#v1.1.war file from ../repository/deployment/server/webapps
    [2020-02-26 11:50:39] INFO - Removed the am#sample#calculator#v1.war file from ../repository/deployment/server/webapps
    [2020-02-26 11:50:39] INFO - Removed devportal directory from ../repository/deployment/server/jaggeryapps
    Finished the optimizations
    Starting the server...
    JAVA_HOME environment variable is set to /Library/Java/JavaVirtualMachines/jdk1.8.0_152.jdk/Contents/Home
    CARBON_HOME environment variable is set to /Users/samithac/WSO2/RND-Projects/16-profile-optimization-fix/setup/wso2am-3.1.0-beta
    Using Java memory options: -Xms256m -Xmx1024m
    [2020-02-26 11:50:41,936]  INFO {org.wso2.config.mapper.ConfigParser} - Applying Configurations upon new Templates
    [2020-02-26 11:50:41,938]  WARN {org.wso2.config.mapper.ConfigParser} - Overriding files in configuration directory /Users/samithac/WSO2/RND-Projects/16-profile-optimization-fix/setup/wso2am-3.1.0-beta
    [2020-02-26 11:50:42,759]  INFO {org.wso2.config.mapper.ConfigParser} - Writing Metadata Entries...
    [2020-02-26 11:50:47,604]  INFO - CarbonCoreActivator Starting WSO2 Carbon...
    [2020-02-26 11:50:47,612]  INFO - CarbonCoreActivator Operating System : Mac OS X 10.14.6, x86_64
    [2020-02-26 11:50:47,613]  INFO - CarbonCoreActivator Java Home        : /Library/Java/JavaVirtualMachines/jdk1.8.0_152.jdk/Contents/Home/jre
    [2020-02-26 11:50:47,613]  INFO - CarbonCoreActivator Java Version     : 1.8.0_152

    Configuration optimization is one step occurred in profile optimization process. This is occurred by replacing the deployment.toml file with a pre-configured profile-specific toml file existing in the pack. If required, we can skip this step from the profile optimization process, via passing additional option '--skipConfigOptimization', so that the existing deployment.toml file in the pack will not be overridden.

Warning

This option '--skipConfigOptimization' is supported by default only from WSO2 API Manager 3.1.0 onwards. It is available for WSO2 APIM 3.0.0 only as a WUM update and is effective from 29th March 2020 (2020-03-29). For more information on how to update using WUM, see Getting WSO2 Updates documentation.

sh <PRODUCT_HOME>/bin/wso2server.sh --optimize -Dprofile=<preferred-profile> --skipConfigOptimization
sh <PRODUCT_HOME>/bin/wso2server.sh --optimize -Dprofile=api-publisher --skipConfigOptimization    
<PRODUCT_HOME>/bin/wso2server.bat --optimize -Dprofile=api-publisher --skipConfigOptimization

So, before running this command (with --skipConfigOptimization option) you are expected to do the configuration changes in deployment.toml manually in the pack. So passing this option allows you to preserve the already manually applied configurations, when doing the profile optimization via the commands.

Note

Doing the profile optimization using the scripts, is the recommended approach and manually doing the optimization including the usage of option --skipConfigOptimization, should be done only in the cases where it can't be avoided.

Top