This documentation is for WSO2 Identity Server 5.6.0 . View documentation for the latest release.

All docs This doc

Versions Compared

Key

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

WSO2 Identity Server includes two main deployment patterns. These patterns take high availability into consideration and are recommended for production deployment environments. The following sections provide high level information on the recommended patterns available and point off to instructions on how to set up and configure the deployment pattern. 


Table of Contents


Deployment prerequisites

As a first step in planning your deployment, ensure that you have the necessary system requirements and a compatible environment.

System requirements

Memory

4GB: 2 GB for the Java Virtual Machine (JVM) and 2 GB for the Operating System (OS)

Disk10 GB minimum

Environment compatibility

Operating systems

For information on tested operating systems, see Tested Operating Systems and JDKs.

RDBMS

For information on tested DBMSs, see Tested DBMSs.

Directory services

Supports Directory Services implementing following LDAP Protocols:

  • LDAP v2
  • LDAP v3

For information on tested LDAPs, see Tested LDAPs.

Java Oracle JDK 1.8 (There’s a known issue with JDK1.8.0_151)
Web browsers

For more information on tested web browsers, see Tested Web Browsers.

Load balancers

For more information about load balancers, see Configuring the load balancer.

Deployment Patterns

Table of Contents
maxLevel4
minLevel4
excludeSystem requirements|Environment compatibility

Note
titleNotes

Note the following before you begin:

  1. Ensure high availability for the respective RDBMS and Directory Services used for each of the deployment patterns given below.

  2. In each production deployment, share the runtime deployment artifacts among nodes using a shared file system. In the deployment patterns defined below, this process is referred to as 'Artifact synchronization’.

    The Runtime deployment artifacts are:

      1. Email output event publisher
        /repository/deployment/server/eventpublishers/

      2. Secondary user stores
        /repository/deployment/server/userstores/

      3. Analytics data publishers and event streams
        /repository/deployment/server/eventpublishers/
        /repository/deployment/server/eventstreams/

      4. Workflow engine related artifacts
        /repository/deployment/server/humantasks/
        /repository/deployment/server/bpel/

Pattern 1 - HA clustered deployment of WSO2 Identity Server

This deployment can be scaled from two to N nodes based on capacity requirements. 

  • Load balancer should be configured to use sticky sessions

  • All WSO2 Identity Server nodes should participate in a cluster. Clustering is used to invalidate local caches of nodes, by notifying over cluster messages, as cache updates happen.


Tip
titleSet Up Deployment Pattern 1

To set up and configure clustered deployment of WSO2 Identity Server according to clustering pattern 1, see Setting Up Deployment Pattern 1-copy.

Open ports

ProductPortUsage

WSO2 Identity Server
9763 HTTP servlet port
9443 HTTPS servlet port
4000 Ports to be opened with respect to clustering membership scheme used

Pattern 2 - HA clustered deployment of WSO2 Identity Server with WSO2 Identity Analytics

  • Load balancers should be configured to use sticky sessions.

  • All WSO2 Identity Server nodes should participate in a cluster. Clustering is used to invalidate local caches of nodes, by notifying over cluster messages, as cache updates happen.

  • Since WSO2 Identity Server Analytics is not mission critical, a two node cluster is recommended where only one will receive events over TCP failover, as configured in WSO2 Identity Server nodes to publish events. The other node will keep its state synced with the active node.



The Analytics dashboards are to be used by administrators to analyze login events and sessions. Therefore, the IS analytics deployment can be isolated from the IS server deployment without sharing the full user base, permission and governance data. However, if you prefer to do so, the same user base can be shared among the IS cluster and the IS Analytics cluster as well.

Tip
titleSet Up Deployment Pattern 2

To set up and configure clustered deployment of WSO2 Identity Server according to clustering pattern 2, see Setting Up Deployment Pattern 2.

Open ports

ProductPortUsage
WSO2 Identity Server9763HTTP servlet port
9443HTTPS servlet port
WSO2 Analytics9763HTTP servlet port
9443HTTPS servlet port
7611 Thrift port for event receiver
7711 SSL port for authentication to publish events