On-Premises Installation


Clusterpoint v4 installation packages download is available on our homepage. You need to fill small data form before download, thus accepting our licence agreement.

We have prepared packages for following Linux distributions: Debian 8, Debian 7, Ubuntu 14.04, Ubuntu 12.04, Centos 7, Centos 6. All packages are available in 64 bit versions.


Overall description

Clusterpoint is clustered, cloud style NoSQL database, which uses approach of multiple server system to spread load and increase performance. This cloud is managed by process called cps-manager. This manager manages hubs and nodes. Hubs are points where you can access database, and nodes are data storages which are responsible for retrieving and storing data. Databases can have multiple shards and replicas - shards indicate on how many nodes the database is split up, replicas are additional copies of the database on the same machine.

There are two types of packages:

  • 'clusterpoint' package contains Clusterpoint manager, node, hub and http service. It has everything you need to start your personal Clusterpoint database cloud;

  • 'clusterpoint-node-hub' package contains additional node and hub. If you want add new machine with additional node and hub for increased performance and data storage size, install 'clusterpoint-node-hub' package and modify /etc/default/clusterpoint configuration file to point to first machine (please, refer to description below);

  • 'clusterpoint-http' package contains additional Clusterpoint http service. It provides REST v4 and v3 access, and you need to configure manager IP address and port at /var/lib/cps-http/http_config. It doesn't replace default http service which comes with 'clusterpoint' package.

    Note, additional HTTP service can be used for v4 databases. But we plan to improve it and implement for v3 usage as well.

First, you need to install 'clusterpoint' package, which provide you core of Clusterpoint database, providing manager managing your database cloud, first instances of hub and node, and http service providing access to REST API access and Web Console of your database cloud, so you can create/update/delete databases and users. Second package 'clusterpoint-node-hub' will provide additional node and hub to add to your private Clusterpoint database cloud.

Notes about Firewall. Clusterpoint manager (cps-manager) process uses 25001 TCP port, node (cps-node) process uses 25006 TCP port and hub (cps-hub) process uses 25007 TCP port to communicate. Additionally, Clusterpoint HTTP service (cps-http) used to access REST API and Clusterpoint On-Premises Console uses 5580 TCP port. Centos 7 / Red Hat Enterprise Linux 7 installation detects and install firewall rules automatically for you, if firewall is detected running. For other operational systems, please consult vendor documentation to open proper ports for successful Clusterpoint installation.

Notes about additional nodes and hubs. When installing additional hubs - you MUST sychronize time between the hubs (we recommend using NTP). Failure to do so will result in errors during DB operations.

Connection to Clusterpoint On-Premises console:
Connection to console: http://localhost:5580 (5580 is default port and it could be changed)
Username: cps_admin
Password: cps_admin_password
Account ID: 11

Connection to REST API v4: http://local_host:5580/v4/account_id/database.collection/
Connection to REST API v3: http://local_host:5580/v3/account_id/database/


Installation instructions

Installation on Debian 8 / Debian 7 / Ubuntu 14.04 LTS / Ubuntu 12.04 LTS


1) To install core package
, download it for your corresponding version of Linux distribution and install using commandline command:

sudo dpkg -i package_name

(*example of package name "clusterpoint-4.1.3.amd64.deb")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

2) To install additional node and hub package (on different machine), download it and install using commandline command:

sudo dpkg -i package_name

(*example of package name "clusterpoint-node-hub-4.1.3.amd64.deb")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

Additionally, you have to provide manager IP address in /etc/default/clusterpoint configuration file. Use editor of your choice in superuser mode (we recommend to use nano) to edit file to look like this:

MANAGER_HOST=ip_address_of_your_clusterpoint_manager_machine
NODE_ID=1

Note, it is necessary to link additional server with the main, because of manager that is running on main server and controls database cloud.

After that restart Clusterpoint services to apply new manager IP address:

service cps-node-hub restart

Or for Debian 8:

service cps-node restart && service cps-hub restart


3) To install additional HTTP service
(this package must be on different machine than 'clusterpoint' package, but can be installed together with 'clusterpoint-node-hub' package), download it and install using commandline command:

sudo dpkg -i package_name

(*example of package name "clusterpoint-http-4.1.3.amd64.deb")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

Additionally, you have to provide manager IP address in /var/lib/cps-http/http_config configuration file. Use editor of your choice in superuser mode (we recommend to use nano) to edit first two lines of configuration file to look like this:

manager_host: "ip_address_of_your_clusterpoint_manager_machine"
manager_port: 25001

This manager IP adress and port will be used to connect to manager to acquire list of hubs, so REST v4 service can connect to those hubs and do queries to your databases.

After that restart Clusterpoint HTTP service to apply new manager IP address:

service cps-http restart

Or for Debian 8:

service cps-node restart && service cps-hub restart

Installation on Centos 7 / RedHat Enterprise Linux 7


1) To install core package
, download it for your corresponding version of Linux distribution and install using commandline command:

sudo rpm -i package_name

(*example of package name "clusterpoint-4.1.3.el7.centos.x86_64.rpm")

Or if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

2) To install additional node and hub package (on different machine), download it and install using commandline command:

sudo rpm -i package_name

(*example of package name "clusterpoint-node-hub-4.1.3.el7.centos.x86_64.rpm")

Or if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

Additionally, you have to provide manager IP address in /etc/default/clusterpoint configuration file. Use editor of your choice in superuser mode (we recommend to use nano) to edit file to look like this:

MANAGER_HOST=ip_address_of_your_clusterpoint_manager_machine
NODE_ID=1

Note, it is necessary to link additional server with the main, because of manager that is running on main server and controls database cloud.

After that restart Clusterpoint services to apply new manager IP address:

service cps-node restart


3) To install additional HTTP service
(this package must be on different machine than 'clusterpoint' package, but can be installed together with 'clusterpoint-node-hub' package), download it and install using commandline command:

sudo rpm -i package_name

(*example of package name "clusterpoint-http-4.1.3.el7.centos.x86_64.rpm")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

Additionally, you have to provide manager IP address in /var/lib/cps-http/http_config configuration file. Use editor of your choice in superuser mode (we recommend to use nano) to edit first two lines of configuration file to look like this:

manager_host: "ip_address_of_your_clusterpoint_manager_machine"
manager_port: 25001

This manager IP adress and port will be used to connect to manager to acquire list of hubs, so REST v4 service can connect to those hubs and do queries to your databases.

After that restart Clusterpoint HTTP service to apply new manager IP address:

service cps-http restart


Installation on Centos 6 / RedHat Enterprise Linux 6


1) To install core package
, download it for your corresponding version of Linux distribution and install using commandline command:

sudo rpm -i package_name

(*example of package name "clusterpoint-4.1.3.el6.x86_64.rpm")

Or if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

2) To install additional node and hub package (on different machine), download it and install using commandline command:

sudo rpm -i package_name

(*example of package name "clusterpoint-node-hub-4.1.3.el6.x86_64.rpm")

Or if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

Additionally, you have to provide manager IP address in /etc/default/clusterpoint configuration file. Use editor of your choice in superuser mode (we recommend to use nano) to edit file to look like this:

MANAGER_HOST=ip_address_of_your_clusterpoint_manager_machine
NODE_ID=1

Note, it is necessary to link additional server with the main, because of manager that is running on main server and controls database cloud.

After that restart Clusterpoint services to apply new manager IP address:

service cps-node-hub restart


3) To install additional HTTP service
(this package must be on different machine than 'clusterpoint' package, but can be installed together with 'clusterpoint-node-hub' package), download it and install using commandline command:

sudo rpm -i package_name

(*example of package name "clusterpoint-http-4.1.3.el6.x86_64.rpm")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

Additionally, you have to provide manager IP address in /var/lib/cps-http/http_config configuration file. Use editor of your choice in superuser mode (we recommend to use nano) to edit first two lines of configuration file to look like this:

manager_host: "ip_address_of_your_clusterpoint_manager_machine"
manager_port: 25001

This manager IP adress and port will be used to connect to manager to acquire list of hubs, so REST v4 service can connect to those hubs and do queries to your databases.

After that restart Clusterpoint HTTP service to apply new manager IP address:

service cps-http restart


Upgrade instructions

Upgrade on Debian 8 / Debian 7 / Ubuntu 14.04 LTS / Ubuntu 12.04 LTS

Note: upgrade process automatically checks services and stops them before update, if they are active. Services are automatically launched again after upgrading process is finished. Beware that if you have stopped Clusterpoint database before update manually, it will be launched automatically after upgrade will be complete.

Database backup copies. If you want to make backup copies of your database content and configuration files, make copies of such files or directories:
- /etc/default/clusterpoint - contains extra options and unique generated root password for your Clusterpoint system;
- /usr/share/cps/htdocs/api/config.php - contains generated 'gui' user password which is required to access GUI for your Clusterpoint system;
- /var/lib/cps-manager - contains general information about your Clusterpoint system, databases, users, nodes and hubs;
- /var/lib/cps-node - contains database information for initial node. Be aware this directory also is found on separate node machines;
- /var/lib/cps-hub and /var/lib/cps-http - backup those if you want to feel sure, cps-http might contain your custom configuration/tweaks for REST API system.
 
1) To upgrade core package, download it for your corresponding version of Linux distribution and upgrade using commandline command:

sudo dpkg -i package_name

(*example of package name "clusterpoint-4.1.3.amd64.deb")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

2) To upgrade additional node and hub package (on different machine), download it and upgrade using commandline command:

sudo dpkg -i package_name

(*example of package name "clusterpoint-node-hub-4.1.3.amd64.deb")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

3) To upgrade additional HTTP service, download it and upgrade using commandline command:

sudo dpkg -i package_name

(*example of package name "clusterpoint-http-4.1.3.amd64.deb")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

Upgrade on Centos 7 / RedHat Enterprise Linux 7


1) To upgrade core package, download it for your corresponding version of Linux distribution and upgrade using commandline command:

sudo rpm -Uvh package_name

(*example of package name "clusterpoint-4.1.3.el7.centos.x86_64.rpm")

Or if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

2) To upgrade additional node and hub package (on different machine), download it and upgrade using commandline command:

sudo rpm -Uvh package_name

(*example of package name "clusterpoint-node-hub-4.1.3.el7.centos.x86_64.rpm")

Or if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

3) To upgrade additional HTTP service, download it and upgrade using commandline command:

sudo rpm -Uvh package_name

(*example of package name "clusterpoint-http-4.1.3.el7.centos.x86_64.rpm")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

Upgrade on Centos 6 / RedHat Enterprise Linux 6


1) To upgrade core package, download it for your corresponding version of Linux distribution and upgrade using commandline command:

sudo rpm -Uvh package_name

(*example of package name "clusterpoint-4.1.3.el6.x86_64.rpm")

Or if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

2) To upgrade additional node and hub package (on different machine), download it and upgrade using commandline command:

sudo rpm -Uvh package_name

(*example of package name "clusterpoint-node-hub-4.1.3.el6.x86_64.rpm")

Or if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.

3) To upgrade additional HTTP service, download it and upgrade using commandline command:

sudo rpm -Uvh package_name

(*example of package name "clusterpoint-http-4.1.3.el6.x86_64.rpm")

Or, if you use graphical environment find it in Home folder -> Downloads folder, double click it and provide your password.