Documentation - Redise Pack

A guide to Redise Pack installation, operation and administration

open all | close all

Downloading and installing the setup package

Navigate to the Redis Labs download page and select one of the following options:

  • Installation package – Click the Download button for the OS you would like to use in order to download the .tar file installation package.
  • AMI – Click the AWS AMI button for the option you would like to use in order to launch an instance on Amazon Web Services (AWS).
  • Docker – Go here for the install guide and skip this page.

Info: If you are using the AMI option or installing the .tar file package on an AWS instance, review the guidelines in Configuration of AWS instances.

Prerequisites

  1. If you intend to use Redise Flash for your databases, be familiar with the specifics of that feature and its set of prerequisites, storage, and considerations.
  2. Disable Linux swap on all nodes to be part of the cluster.
  3. Ensure you have root level access to each node, either directly or via sudo.

Installation Procedure

If you downloaded the .tar file installation package, install the package on a machine that will serve as one of the nodes in the cluster by performing the following steps:

  1. In the operating system command-line-interface (CLI), also referred to as Terminal, run the cd command to change the location to the directory where you saved the .tar file.
  2. Extract the package by running the following command in the CLI: tar vxf <tarfile name>
  3. To initiate the installation in the CLI, run the following command:  $ sudo ./install.sh Note: You must either be the root user or have access to sudo to the root user to run the install process.
  4. During the installation process, enter the requested input each time you are prompted to do so.
  5. After installation has completed successfully
    1. The install finishes up with rlcheck make testing the installation out and confirming the installation passed.
      2017-04-24 10:54:12 [!] Installation is complete!
      2017-04-24 10:54:12 [?] Would you like to run rlcheck to verify proper configuration? [Y/N]? Y
      2017-04-24 10:54:15 [$] executing: '/opt/redislabs/bin/rlcheck --suppress-tests=verify_bootstrap_status,verify_processes'
      saving to file: /var/opt/redislabs/log/rlcheck.log
      ##### Welcome to RedisLabs Enterprise Cluster settings verification utility ####
      Skipping test: verify_bootstrap_status
      Skipping test: verify_processes
      Running test: verify_dmcproxy
      	Verifying dmcproxy process...
      		PASS
      Running test: verify_port_range
      	Verifying local port range...
      		PASS
      Summary:
      -------
      ALL TESTS PASSED.
      2017-04-24 10:54:15 [!] Please logout and login again to make sure all environment changes are applied.
      2017-04-24 10:54:15 [!] Point your browser at the following URL to continue:
      2017-04-24 10:54:15 [!] https://<your_ip_here>:8443
      

      Make sure to save this URL for when you go to configure the cluster.

    2. If you intend to create Redise Flash enabled databases, you must prepare and format the flash memory. You should run:
      $ sudo /opt/redislabs/sbin/prepare_flash.sh

      This command finds all the unformatted disks, RAIDs and mounts them under /var/opt/redislabs/flash
      You can verify the configuration by running:

      $ sudo lsblk
  6. Open a web browser and go to the Web UI to complete the cluster setup.

Silent Installations

If you would like to automate the installation script, use either of the following methods to perform a “silent” installation that speeds the process:

  1. Run the install script with “-y” as a parameter (i.e. ./install.sh -y), which will silently use “Y” as a default response to all questions.
    WARNING: By using the -y parameter you will fail to see any alerts from the installer to the possible presence of DBs in Sync state. These alerts when in normal mode allow you to stop the upgrade if they find a DB in that state. Check that your DBs are not in this state before possibly using this flag. Otherwise, do not use this feature.
  2. Run the install script with “-c” and an answers file path as parameters (i.e. ./install.sh –c <answers and=”” file=”” name=”” path=””>), thereby allowing the installation to use the answers provided in your answers file. Here is sample content for the answers file:
    systune=yes
    ntp=no
    firewall=no
    rlcheck=yes

Not all questions in install.sh can be automated with the answers file. The reason being is we want an admin to see what was detected and consciously agree to do or not to do something. An example is when install.sh detects that a shard of a DB is syncing right now. If that situation is detected, the admin needs to knowingly assume the risk of proceeding and not waiting.

Info: While `sudo ./install.sh -y` or using an answers file does not perform the steps necessary for Redise Flash or creating a cluster. That part of each node’s install still has to be done and potentially automated separately.

Which directories does Redise Pack install to?

  1. /opt/redislabs
  2. /var/opt/redislabs
  3. /etc/opt/redislabs
  4. /usr/share/doc/redislabs

Info: At this time, you cannot change the directories RP installs into.