Jump to: navigation, search

Configuring CMS Cluster

Overview

The Knowledge CMS can work in cluster mode (for example, several nodes of the CMS servers can use one data repository). Such configuration is only possible while storing the data in the Data Base (like Cassandra (http://cassandra.apache.org/) or JDBC/JNDI data bases like MS SQL, PostgreSQL, My SQL .etc (http://www.oracle.com/technetwork/java/javase/jdbc/index.html , http://www.oracle.com/technetwork/java/jndi/index.html).

Important
You cannot perform this configuration with a persistent repository file.

How to Configure the Cluster

Start

  1. Configure all applications and install several Knowledge CMS servers. Each server works as a node in the Knowledge CMS cluster.
  2. Configure Load Balancer on top of the configured nodes to access the CMS cluster.
  3. Each configured Knowledge CMS application must be connected to the Knowledge Application Cluster.
    Connections
  4. Add port with name "jgroups" to each CMS application.
    Ports
  5. Configure Knowledge CMS servers to work with appropriate DB.
    1. Configure Knowledge CMS servers to work with MS SQL.
      1. Create MS SQL Data Base to store CMS data
      2. Add appropriate driver for JNDI database connection to <CMS installation folder>/lib/ext folder:
      3. Configure next options in Knowledge Application Cluster in cms.cluster section:
        1. type set to jdbc
        2. repositoryName - appropriate name for you storage, any string
        3. dbJndiName - set to string "java:comp/env/jdbc/knowledge"
        4. dbConnectionUrl - correct connection string for connection to MS SQL, for example: jdbc:jtds:sqlserver://<host of MS SQL server; 1433 by default>:<port of MS SQL server>;databaseName=<CMS DB name>;user=<username for access CMS DB>;password for access DB
        5. dbDriverClass - driver name for MS SQL connector, for example for jTDS 1.2.7 for MS SQL - net.sourceforge.jtds.jdbc.Driver
        6. dbDataColumnType set to VARBINARY(MAX)
        7. dbIdColumnType set to NVARCHAR(255)
        8. dbTimestampColumnType set to BIGINT
        9. jgroupsConfiguration set to TCP by default, could be reconfigured due recommendations in options description
        10. Other options could be set as default
    2. Configure Knowledge CMS servers to work with PostgreSQL
      1. Create PostgreSQL Data Base to store CMS data
      2. To connect to PostgreSQL change jetty.xml in each CMS node (<CMS installation folder>/etc/jetty.xml). Change section "datasource for Genesys Knowledge Center CMS" to support particular DB type. For example: 
        <New id="jdbc/knowledge" class="org.eclipse.jetty.plus.jndi.Resource">
    <Arg></Arg>
    <Arg>jdbc/knowledge</Arg>
    <Arg>
        <New class="org.postgresql.ds.PGPoolingDataSource">
            <Set name="User"><username for access CMS DB></Set>
            <Set name="Password"><password for access DB></Set>
            <Set name="DatabaseName"><CMS DB name></Set>
            <Set name="ServerName"><host for access DB></Set>
            <Set name="PortNumber"><post for access DB></Set>
            <Set name="DataSourceName">knowledge</Set>
            <Set name="InitialConnections">5</Set>
            <Set name="MaxConnections">15</Set>
        </New>
    </Arg>
</New>
      3. Add appropriate driver for JNDI database connection to <CMS installation folder>/lib/ext folder. For example:
      4. Configure next options in Knowledge Application Cluster in cms.cluster section:
        1. type set to jdbc
        2. repositoryName - appropriate name for you storage, any string
        3. dbJndiName - set to string "java:comp/env/jdbc/knowledge"
        4. dbDataColumnType set to BYTEA
        5. dbIdColumnType set to VARCHAR(255)
        6. dbTimestampColumnType set to BIGINT
        7. jgroupsConfiguration set to TCP by default, could be reconfigured due recommendations in options description
        8. Other options could be set as default
    3. Configure Knowledge CMS servers to work with My SQL
      1. Create My SQL Data Base to store CMS data
      2. To connect to My SQL change jetty.xml in each CMS node (<CMS installation folder>/etc/jetty.xml). Change section "datasource for Genesys Knowledge Center CMS" to support particular DB type. For example: 
        <New id="jdbc/knowledge" class="org.eclipse.jetty.plus.jndi.Resource">
    <Arg></Arg>
    <Arg>jdbc/knowledge</Arg>
    <Arg>
            <New class="com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource">
            <Set name="Url">jdbc:mysql://<host and port for access DB>/<CMS DB name></Set>
            <Set name="User"><username for access CMS DB></Set>
            <Set name="Password"><password for access DB></Set>
        </New>
    </Arg>
</New>
      3. Add appropriate driver for JNDI database connection to <CMS installation folder>/lib/ext folder. For example:
      4. Configure next options in Knowledge Application Cluster in cms.cluster section:
        1. type set to jdbc
        2. repositoryName - appropriate name for you storage, any string
        3. dbJndiName - set to string "java:comp/env/jdbc/knowledge"
        4. dbDataColumnType set to BLOB
        5. dbIdColumnType set to VARCHAR(255)
        6. dbTimestampColumnType set to BIGINT
        7. jgroupsConfiguration set to TCP by default, could be reconfigured due recommendations in options description
        8. Other options could be set as default
    4. Configure Knowledge CMS servers to work with Cassandra
      1. Installed and properly configured Cassandra cluster should be available
      2. Configure next options in Knowledge Application Cluster in cms.cluster section:
        1. type set to cassandra
        2. host - host for access Cassandra cluster
        3. port - port for access Cassandra cluster
        4. dbUsername - name of user for access Cassandra cluster
        5. dbPassword - password for user for access Cassandra cluster
        6. Other options could be set as default
  6. Configure the Application Options in Knowledge Application Cluster:
    Application Options

    Options

    Name Description Value
    Section:cms.cluster
    cmsPathStorage Path for store repository. Default: ./knowledge/store

    Valid Values: valid path to folder to store persistent repository file
    Effective: After restart
    Use this option for single-node CMS in case of using persistent repository file instead of DB.

    type Type of repository used Default: file

    Valid Values: file, jdbc, cassandra
    Effective: After restart
    To enable CMS cluster and work with DB set this option to true.

    repositoryName JNDI database name Default: Genesys Knowledge Repository

    Valid Values: Any string (should not be changed after database creation)
    Effective: After restart

    dbJndiName Name of JNDI class in Jetty Default: java:comp/env/jdbc/knowledge

    Valid Values: String "java:comp/env/jdbc/knowledge" or "comp/env/jdbc/knowledge" for running under Jetty8
    Effective: After restart

    dbDataColumnType Database type for DATA_COLUMN. Default: BINARY

    Valid Values: valid type for DATA_COLUMN, BLOB for My SQL, BYTEA for PostgreSQL etc (http://infinispan.org/docs/7.1.x/user_guide/user_guide.html#_jdbc_based_cache_loaders)
    Effective: After restart

    dbIdColumnType Database type for ID_COLUMN. Default: VARCHAR(255)

    Valid Values: valid type for ID_COLUMN, VARCHAR(255) for PostgreSQL and My SQL, NVARCHAR(255) for MS SQL (http://infinispan.org/docs/7.1.x/user_guide/user_guide.html#_jdbc_based_cache_loaders)
    Effective: After restart

    dbTimestampColumnType Database type for TIMESTAMP_COLUMN. Default: BIGINT

    Valid Values: valid type for TIMESTAMP_COLUMN (http://infinispan.org/docs/7.1.x/user_guide/user_guide.html#_jdbc_based_cache_loaders)
    Effective: After restart

    dbConnectionUrl Correct connection string for connection to MS SQL, this options should be configured to work with MS SQL as storage Default: n/a

    Valid Values: correct connection string for connection to MS SQL; for example: jdbc:jtds:sqlserver://<host of MS SQL server; 1433 by default>:<port of MS SQL server>;databaseName=<CMS DB name>;user=<username for access CMS DB>;password for access DB
    Effective: After restart

    dbDriverClass Driver name for MS SQL connector, this options should be configured to work with MS SQL as storage Default: none

    Valid Values: correct driver name for MS SQL connector; for example for jTDS 1.2.7 for MS SQL - net.sourceforge.jtds.jdbc.Driver
    Effective: After restart

    host Host for access Cassandra cluster, this options should be configured to work with Cassandra as storage Default: 127.0.0.1

    Valid Values: correct host name or IP for access Cassandra cluster
    Effective: After restart

    port Port for access Cassandra cluster, this options should be configured to work with Cassandra as storage Default: 9160

    Valid Values: correct port number for access Cassandra cluster
    Effective: After restart

    dbUsername Name of user for access Cassandra cluster, this options should be configured to work with Cassandra as storage Default: n/a

    Valid Values: correct username for access Cassandra cluster
    Effective: After restart

    dbPassword Password for user for access Cassandra cluster, this options should be configured to work with Cassandra as storage Default: n/a

    Valid Values: correct password for access Cassandra cluster
    Effective: After restart

    jgroupsConfiguration Determine the interaction between a server. Default: TCP

    Valid Values: JGROUPS_UPD - Uses UDP as a transport, and UDP multicast for discovery. Usually suitable for larger (over 100 nodes) clusters or if you are using replication or invalidation . Minimises opening too many sockets.
    JGROUPS_TCP - Uses TCP as a transport and UDP multicast for discovery. Better for smaller clusters (under 100 nodes) only if you are using distribution , as TCP is more efficient as a point-to-point protocol.
    JGROUPS_EC2 - Uses TCP as a transport and S3_PING for discovery. Suitable on Amazon EC2 nodes where UDP multicast isn’t available.
    TCP - Uses TCP, and define nodes from Configuration server. Used standard port 7800
    TCP_NIO - Uses TCP NIO, and define nodes from Configuration server. Used standard port 7800
    TCP_GOSSIP - see http://www.jgroups.org/manual/html/user-advanced.html#TCPGOSSIP
    TUNNEL - see http://www.jgroups.org/manual/html/user-advanced.html#d0e2494
    UDP_LARGECLUSTER - see http://www.jgroups.org/manual/html/user-advanced.html#d0e2447
    Effective: After restart

    Section:cms.general
    * Optional

    externalURL

    		URL to access CMS cluster via Load balance. Default: None

    Valid Values: valid URL
    Effective: After restart
    To work with attached document if the CMS cluster is configured. Option should no be empty.

  7. A repository in the provided database is created after this configuration is complete and upon start of the first CMS node. All nodes can then work with this repository as a cluster.

End

This page was last edited on March 11, 2016, at 23:04.
Comments or questions about this documentation? Contact us for support!