This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
Production Deployment Guidelines
The requirements for deploying WSO2 products can change based on the deployment scenario and pattern. The recommendations in this topic are for general production use, assuming moderate load conditions. For situations where a high volume of traffic is expected and if there are large deployments, these guidelines may not be sufficient. See Troubleshooting in Production Environments for information on how to obtain and analyze information to solve production issues. The following are the topics addressed in this section.
Installation prerequisites
Prior to installing any WSO2 Carbon-based product, it is necessary to have the appropriate hardware and software for running the product.
System requirements
Physical |
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) |
Three WSO2 product instances running would require VM of 4 compute units, 8 GB RAM, and 30 GBfree space. |
EC2 |
|
Cassandra data nodes |
For more information, see the Cassandra documentation on hardware recommendations for enterprise implementations. |
Environment compatibility
By default, WSO2 products are installed with OpenJDK, which allows you to run the product as soon as it is installed.
All WSO2 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, we recommend you use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, MS SQL, etc. For more information, see Working with Databases in the Administration Guide. Also, we do 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 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, contact us.
Installing the WSO2 product
Given below is how to install a WSO2 product:
Download and install the product
If the installation prerequisites are satisfied, follow the steps below:
Go to the product page and download the product installer (click Installer pkg).
Double-click to open the installation wizard, which will guide you through the installation. When you finish, the product will be installed and ready for use.
Access the HOME directory
Let's call the installation location of your product as the <PRODUCT_HOME> directory. This is located in a place specific to your OS as shown below:
OS | Home directory |
|---|---|
Mac OS |
|
Windows |
|
Ubuntu |
|
CentOS |
|
Uninstalling the product
To remove an already installed product, follow the instructions below:
OS | Instructions |
|---|---|
Mac OS | Open a terminal and run the following command as the root user: sudo bash /Library/WSO2/<PRODUCT_NAME>/<VERSION>/uninstall.sh |
Windows | Go to the Start Menu -> Programs -> WSO2 -> Uninstall <PRODUCT_NAME_VERSION> or search Uninstall <PRODUCT_NAME_VERSION> and click the shortcut icon. This will uninstall the product from your computer. |
Ubuntu | Open a terminal and run the following command: sudo apt-get purge <PRODUCT_DISTRIBUTION_NAME> |
CentOS | Open a terminal and run the following command: sudo yum remove <PRODUCT_DISTRIBUTION_NAME>-x86_64 |