Installation Prerequisites

Before installing WSO2 API Manager, make sure that the appropriate prerequisites are available. Verify that the computer has a supported operating system and development platforms before starting the installation.

System requirements

Physical

  • 3 GHz Dual-core Xeon/Opteron (or latest)
  • 4 GB RAM (2 GB for JVM and 2 GB for the operating system)
  • 10 GB free disk space
  • ~ Recommended minimum - 2 Cores. For high concurrencies and better performances - 4 Cores.

    Disk space is based on the expected storage requirements that are calculated by considering the file uploads and the backup policies. For example, if three WSO2 product instances are running in a single machine, it requires a 4 GHz CPU, 8 GB RAM (2 GB for the operating system and 6 GB (2 GB for each WSO2 product instance)) and 30 GB of free space.

Virtual Machine (VM)

  • 2 compute units minimum (each unit having 1.0-1.2 GHz Opteron/Xeon processor)
  • 4 GB RAM
  • 10 GB free disk space
  • One CPU unit for the operating system and one for JVM.

Three WSO2 product instances running would require VM of 4 compute units, 8 GB RAM, and 30 GB free space.

~ 512 MB heap size. This is generally sufficient to process typical SOAP messages but the requirements vary with larger message sizes and the number of messages processed concurrently.

EC2

  • 1 c5.large instance to run one WSO2 product instance.

Three WSO2 product instances can be run in 1 EC2 Extra-Large instance. Based on the I/O performance of the c5.large instance, it is recommended to run multiple instances in a larger instance (c5.xlarge).

Environment compatibility

Operating systems\ Databases

  • If you are using the product installer to install the product, by default, WSO2 API-M is installed with OpenJDK, which allows you to run the product as soon as it is installed.

    Note

    To use a different JDK, point the JAVA_HOME environment variable to the new JDK. Make sure your JDK version is compatible with the WSO2 product.

  • If you are using the product's binary distribution to install the product (instead of the product installer), install JDK. Make sure your JDK version is compatible with the WSO2 product.

  • All WSO2 Carbon-based products are generally compatible with most common DBMSs. The embedded H2 database is suitable for development, testing, and some production environments. For most enterprise production environments. However, WSO2 recommends that you use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, MS SQL, etc. For more information, see Working with Databases. Additionally, WSO2 does not recommend the H2 database as a user store.

  • It is not recommended to use Apache DS in a production environment due to scalability issues. Instead, use an LDAP like OpenLDAP for user management.

  • On a production deployment, it is recommended that WSO2 products are installed on the latest releases of RedHat Enterprise Linux or Ubuntu Server LTS.

  • For environments that WSO2 products are tested with, see Compatibility of WSO2 Products.

  • If you have difficulty in setting up any WSO2 product in a specific platform or database, please contact us.

Database storage requirements

DB Type Minimum storage required for databases
AM Database Shared Database
MySQL 1 GB 1 GB
Oracle 1 GB 1 GB
MSSQL 1 GB 1 GB
Oracle RAC 1 GB 1 GB
PostgreSQL 1 GB 1 GB
IBM DB2 1 GB 1 GB
MariaDB 1 GB 1 GB

Required applications

The following applications are required for running WSO2 API Manager and its samples.

Application Purpose Version Download Links

Apache Ant

  • To compile and run the product samples in <API-M_HOME>/samples.

1.7.0 or later

Apache Ant

Web Browser

  • To access the Management Console. The Web browser must be JavaScript enabled to take full advantage of the Management console.

Note

On Windows Server 2003, you must not go below the medium security level in Internet Explorer 6.x.

Top