WSO2 Data Services Server (WSO2 DSS) is shipped with default configurations that will allow you to download, install and get started with your product instantly. However, when you go into production, it is recommended to change some of the default settings to ensure that you have a robust system that is suitable for your operational needs. Also, you may have specific use cases that require specific configurations to the server.
If you are a product administrator, the follow content will provide an overview of the administration tasks that you need to perform when working with WSO2 Data Services Server (WSO2 DSS).
Upgrading from a previous release
If you are upgrading from WSO2 DSS 3.5.0 to WSO2 DSS 3.5.1 version, see the upgrading instructions for DSS.
If you want to migrate the data in your DSS from one environment to another, see Migrating DSS.
Changing the default database
By default, WSO2 DSS is shipped with an embedded H2 database (Carbon database), which is used for storing user management and registry data. We recommend that you use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, MS SQL, etc. when you set up your production environment. You can change the default database configuration by simply setting up a new physical database and updating the configurations in the product server to connect to that database.
For information on setting up a new database for WSO2 DSS, see Setting up the Physical Database in the WSO2 Administration Guide.
- Once you set up a new database, you need to update the configurations in WSO2 DSS. See Changing the Carbon Database for instructions.
Configuring users, roles and permissions
The user management feature in your product allows you to create new users and define the permissions granted to each user. You can also configure the user stores that are used for storing data related to user management.
- For instructions on how to configure user management, see Working with Users, Roles and Permissions in the WSO2 Product Administration Guide.
- For descriptions of permissions that apply to WSO2 DSS users, see Role-Based Permissions for WSO2 Data Services Server.
After you install WSO2 DSS, it is recommended to change the default security settings according to the requirements of your production environment. As DSS 3.5.1 is built on top of the WSO2 Carbon Kernel (version 4.4.7), the main security configurations applicable to DSS are inherited from the Carbon kernel.
For instructions on configuring security in your server, see the following topics in the WSO2 Product Administration Guide.
- Configuring Transport-Level Security
- Using Asymmetric Encryption
- Using Symmetric Encryption
- Enabling Java Security Manager
- Securing Passwords in Configuration Files
- Resolving Hostname Verification
The transport management capability in WSO2 products allows a particular server to send and receive messages over several transport and application protocols. The following transports are supported in WSO2 DSS: HTTP, HTTPS, JMS, and Local.
For instructions on configuring these transport for WSO2 DSS, see the following topics in the WSO2 Product Administration Guide:
You can create multiple tenants in your product server, which will allow you to maintain tenant isolation in a single server/cluster. For instructions on configuring multiple tenants for your server, see Working with Multiple Tenants in the WSO2 Product Administration Guide.
Configuring the registry
A registry is a content store and a metadata repository for various artifacts such as services, WSDLs and configuration files. In WSO2 products, all configurations pertaining to modules, logging, security, data sources and other service groups are stored in the registry by default.
For instructions on setting up and configuring the registry for your server, see Working with the Registry in the WSO2 Product Administration Guide.
You can optimize the performance of your product server by configuring the appropriate OS settings, JVM settings etc. Most of these are server-level settings that will improve the performance of any WSO2 product. For instructions, see Performance Tuning in the WSO2 Product Administration Guide.
Changing the default ports
When you run multiple WSO2 products, multiple instances of the same product, or multiple WSO2 product clusters on the same server or virtual machines (VMs), you must change their default ports with an offset value to avoid port conflicts.
For instructions on configuring posts, see Changing the Default Ports in the WSO2 Product Administration Guide
Configuring custom proxy paths
This feature is particularly useful when multiple WSO2 products (fronted by a proxy server) are hosted under the same domain name. By adding a custom proxy path you can host all products under a single domain and assign proxy paths for each product separately .
For instructions on configuring custom proxy paths, see Adding a Custom Proxy Path in the WSO2 Product Administration Guide.
Customizing error pages
You can make sure that sensitive information about the server is not revealed in error messages, by customizing the error pages in your product. For instructions, see Customizing Error Pages in the WSO2 Product Administration Guide.
Customizing the management console
Some of the WSO2 products, such as WSO2 DSS consist of a web user interface named the management console. This allows administrators to configure, monitor, tune, and maintain the product using a simple interface. You can customize the look and feel of the management console for your product.
For instructions, see Customizing the Management Console in the WSO2 Product Administration Guide.
For instructions on applying patches (issued by WSO2), see WSO2 Patch Application Process in the WSO2 Product Administration Guide.
Error handling in DSS
See Error Handling in DSS for a list of the error messages that you may come across while working with WSO2 DSS.
Timestamp conversion for RDBMS
See Timestamp conversion for RDBMSs for instructions on configuring timestamp conversion.
Enabling CORS for data services
See Enabling CORS for data services for instructions.
Monitoring the server
Monitoring is an important part of maintaining a product server. Listed below are the monitoring capabilities that are available for WSO2 DSS.
- Monitoring server logs: A properly configured logging system is vital for identifying errors, security threats and usage patterns in your product server. For instructions on monitoring the server logs, see Monitoring Logs in the WSO2 Product Administration Guide.
- JMX-based monitoring: For information on monitoring your server using JMX, see JMX-based monitoring in the WSO2 Product Administration Guide.