Skip to content

install

pwehrle edited this page Jul 8, 2014 · 1 revision

vost (and vostwui)

What is vost?

vost is the assembly composed of a VOLD and a REST server.

What is vostwui?

vostwui is the assembly composed of a VOLD, a REST server and a web user interface.

What about user and group creation?

The installation script shall be launched by a user in the sudoers. A non privileged user 'vost' will be created by the installation script to start the daemon.

How are the disks organized?

The system needs at least one fast volume to store:

  • The VVR persistence files: devices list, snapshots and their contents
  • A temporary space to store the data blocks called the IbpGen (for more information see: IBS).

The system also needs one ore more high capacity volumes to permanently store the data blocks. These storage spaces are defined by a list of 'Ibp' directories.

Note: both fast and high capacity storage volumes have to be formatted with filesystems that support extended filesystem attributes (xattr).

What are the required parameters for a node?

The file vost.cfg must be edited to configure the node.

Key Usage Default value
COM_OODRIVE_NUAGE_VOLD_OWNER The cluster owner is identified by an unique identifier (UUID, see RFC 4122).
The command 'uuid' enable to produce a valid random uuid.
Example: ad9fb5f4-3a12-11e2-bfaa-180373e17308
none
COM_OODRIVE_NUAGE_VOLD_NODE The node is identified by an unique identifier (UUID, see RFC 4122).
The command 'uuid' enable to produce a valid random uuid.
Example:
9d076da6-4906-11e2-b385-180373e17308
none
COM_OODRIVE_NUAGE_VOLD_PEERS
The other members of the cluster must be identified by their unique identifier and their IP address as:
UUID1@<address1>:<port1>,UUID2@<address2>:<port2> ...
For each node, 2 consecutive TCP ports must be reachable: if port1 equals 45564, the port 45565 must be reachable too.
Example: 406bc230-4867-11e2-a964-180373e17308@192.168.0.2:45564,37dae98e-4867-11e2-965c-180373e17308@192.168.0.3:55565
none
COM_OODRIVE_NUAGE_VOLD_SERVER_ADDRESS The node communicates with the other nodes to synchronize. The address on which the server is bind is here.
Example: 192.168.0.1
none
COM_OODRIVE_NUAGE_VOLD_SERVER_PORT The port of the synchronization server. The next port must reachable too, from the other cluster members.
Example: in the case of the default value, the TCP port 53670 and 53671 must be opened.
53670
COM_OODRIVE_NUAGE_VOLD_ISCSI_STARTED This parameter tells if the iSCSI server is automatically started.
true
COM_OODRIVE_NUAGE_ISCSISRV_ADDRESS Address on which the iSCSI server is bind.
Example: 192.168.0.1
none
COM_OODRIVE_NUAGE_ISCSISRV_PORT The iSCSI server port. It is not advisable to change the default value. 3260
COM_OODRIVE_NUAGE_VOLD_NBD_STARTED This parameter tells if the NBD server is automatically started. true
COM_OODRIVE_NUAGE_NBDSRV_ADDRESS
Address on which the NBD server is bind.
Example: 192.168.0.1
none
COM_OODRIVE_NUAGE_NBDSRV_PORT The NBD server port. It is not advisable to change the default value. 10809
COM_OODRIVE_NUAGE_VVR_IBS_IPB_PATH This parameter indicates the list of the directories which will contain the cold data, separated by coma.
Example: /data/ibsIbp1,/data/ibsIbp2
none
COM_OODRIVE_NUAGE_VVR_IBS_IBPGEN_PATH The directory which will contain the hot data.
Example: /data/ibsIbpGen
none
COM_OODRIVE_NUAGE_JETTY_SERVER_ADDRESS The REST server address.
Example: 192.168.0.1
none
COM_OODRIVE_NUAGE_JETTY_SERVER_PORT The REST server port. 8888
COM_OODRIVE_NUAGE_JETTY_SHUTDOWNONEXIT To indicate if the server is shutdown on exit. true
COM_OODRIVE_NUAGE_JETTY_REST_CONTEXTPATH The context path of the REST server. /storage
COM_OODRIVE_NUAGE_JETTY_WEBUI_CONTEXTPATH The context path of the WEBUI server (only for the vostwui assembly) /admin

Installation

How to install the application?

Extract the files from the archive vost-<version>.tar.bz2 :

$ tar xvf vost-<version>.tar.bz2

Edit the config file vost.cfg with the necessary parameters.

Launch the installation script with the path of the directory that will contain the VVR persistence. The user which launches the script shall have privileged access via sudo command

$ cd vost-<version>/
$ vi config/vost.cfg
$ ./bin/install -d /data/vold/

Note: the installation does not copy the binaries. They are used from the extracted location.

How to run the application?

Run the init script in the /etc/init.d. However the application will be launched automatically when the machine starts.

$ sudo /etc/init.d/vost start

How to stop the application?

$ sudo /etc/init.d/vost stop

How to uninstall the application?

$ cd vost-<version>/
$ ./bin/uninstall

Note: neither the binaries nor VVR data and block base are deleted during uninstallation process.

Log the application

To redirect the logs in /var/log/syslog. The UDP reception must be activated in /etc/rsyslog.conf:

# provides UDP syslog reception
$ModLoad imudp
$UDPServerRun 514

To avoid the display of #011 instead of tab in the stack traces, you need to set the option:

$EscapeControlCharactersOnReceive off

cinost (and cinostwui)

What is cinost?

cinost is the assembly composed of a VOLD, a REST server and Cinder.

What is cinostwui?

cinostwui is the assembly composed of a VOLD, a REST server, Cinder and a web user interface.

What about user and group creation?

The installation script shall be launched by a user in the sudoers. A non privileged user 'cinost' will be created by the installation script to start the daemon.

How are the disks organized?

The system needs at least one fast volume to store:

  • The VVR persistence files: devices list, snapshots and their contents
  • A temporary space to store the data blocks called the IbpGen (for more information see: IBS).

The system also needs one ore more high capacity volumes to permanently store the data blocks. These storage spaces are defined by a list of 'Ibp' directories.

Note: both fast and high capacity storage volumes have to be formatted with filesystems that support extended filesystem attributes (xattr).

What are the required parameters for a node?

The file cinost.cfg must be edited to parameter the node. As the REST server is only used by cinder, the REST server can not be configured. The address is localhost and the port 8080. The context path is /storage for the REST and /admin for the webui.

Key Usage Default value
COM_OODRIVE_NUAGE_VOLD_OWNER

The cluster owner is identified by an unique identifier (UUID, see RFC 4122).

This identifier must be the STR format of the Openstack project identifier of which the cinost stores the volumes.

The command 'uuid' enable to produce a valid random uuid

Example: ad9fb5f4-3a12-11e2-bfaa-180373e17308

none
COM_OODRIVE_NUAGE_VOLD_NODE

The node is identified by an unique identifier (UUID, see RFC 4122).

The command 'uuid' enable to produce a valid random uuid

Example: 9d076da6-4906-11e2-b385-180373e17308

none

COM_OODRIVE_NUAGE_VOLD_PEERS

The other members of the cluster must be identified by their unique identifier and their IP address as:

UUID1@<address1>:<port1>,UUID2@<address2>:<port2> ...

For each node, 2 consecutive TCP ports must be reachable: if port1 equals 45564, the port 45565 must be reachable too.

Example: 406bc230-4867-11e2-a964-180373e17308@192.168.0.2:45564,37dae98e-4867-11e2-965c-180373e17308@192.168.0.3:55565

none
COM_OODRIVE_NUAGE_VOLD_SERVER_ADDRESS

The node communicates with the other nodes to synchronize. The address on which the server is bind is here.

Example: 192.168.0.1

none
COM_OODRIVE_NUAGE_VOLD_SERVER_PORT

The port of the synchronization server. The next port must reachable too, from the other cluster members.

Example: in the case of the default value, the TCP port 53670 and 53671 must be opened.

53670
COM_OODRIVE_NUAGE_VOLD_ISCSI_STARTED

This parameter tells if the iSCSI server is automatically started.

true
COM_OODRIVE_NUAGE_ISCSISRV_ADDRESS

Address on which the iSCSI server is bind.

Example: 192.168.0.1

none
COM_OODRIVE_NUAGE_ISCSISRV_PORT

The iSCSI server port.

It is not advisable to change the default value.

3260
COM_OODRIVE_NUAGE_VOLD_NBD_STARTED This parameter tells if the NBD server is automatically started. true

COM_OODRIVE_NUAGE_NBDSRV_ADDRESS

Address on which the NBD server is bind.

Example: 192.168.0.1

none
COM_OODRIVE_NUAGE_NBDSRV_PORT

The NBD server port.

It is not advisable to change the default value.

10809
COM_OODRIVE_NUAGE_VVR_IBS_IPB_PATH

This parameter indicates the list of the directories which will contain the cold data, separated by coma.

Example: /data/ibsIbp1,/data/ibsIbp2

none
COM_OODRIVE_NUAGE_VVR_IBS_IBPGEN_PATH

The directory which will contain the hot data.

Example: /data/ibsIbpGen

none
CINDER_RABBIT_PASSWORD The AMQP server password. none
CINDER_RABBIT_HOST The AMQP server address. localhost
CINDER_SQL_CONNECTION

The cinder data base URL

Example: mysql://root:password@127.0.0.1/cinder?charset=utf8

none
CINDER_MY_IP

This parameter indicates the IP address where Cinder is installed.

Example: 10.0.0.1

none
CINDER_KEYSTONE_AUTH_URI

The URI of the authentication server Keystone

Example: http://10.0.0.1:5000

none
CINDER_KEYSTONE_ADMIN_PASSWORD

The password for the Keystone authentication.

none
CINDER_KEYSTONE_AUTH_PORT

The port of the authentication server Keystone.

none
CINDER_KEYSTONE_AUTH_HOST

The address of the authentication Keystone

Example: 10.0.0.1

none

Install the application

How to install openstack?

see OpenStack

How to install the application?

Extract the files from the archive cinost-<version>.tar.bz2:

$ tar xvf cinost-<version>.tar.bz2

Edit the config file vost.cfg with the necessary parameters.

Launch the installation script with the path of the directory that will contain the VVR persistence. The user which launches the script shall have privileged access via sudo command.

If it is the first node, the installation must be done with the parameter '--firstNode'.

$ cd cinost-<version>/
$ vi config/cinost.cfg
$ ./bin/install -d /data/vold/ --firstNode

For the following nodes, the option must not be set.

$ cd cinost-<version>/
$ vi config/cinost.cfg 
$ ./bin/install -d /data/vold/

Note: the installation does not copy the binaries. They are used from the extracted location.

How to run the application?

Run the init script in the /etc/init.d. However the application will be launched automatically when the machine starts.

$ sudo /etc/init.d/cinost start

How to stop the application?

$ sudo /etc/init.d/cinost stop

How to uninstall the application?

$ cd cinost-<version>/
$ ./bin/uninstall

Note: neither the binaries nor VVR data and block base are deleted during uninstallation process.

Log the application

To redirect the logs in /var/log/syslog. The UDP reception must be activated in /etc/rsyslog.conf:

# provides UDP syslog reception
$ModLoad imudp
$UDPServerRun 514

To avoid the display of #011 instead of tab in the stack traces, you need to set the option:

$EscapeControlCharactersOnReceive off

Clone this wiki locally