Skip to content

Clarify custom installation requirements for custom storage paths (DO… #1625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,36 @@ To configure different mount points for data and log directories, use symbolic l
ln -s /var/opt/redislabs/log </path/to/log/mount/point>
```

## Customize storage paths

When you install Redis Enterprise Software to custom directories, you can specify custom storage paths for persistent and ephemeral storage during [cluster setup]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}) or when [adding nodes]({{< relref "/operate/rs/clusters/add-node" >}}).


1. Specify the custom file location with the `--var-dir` option when you install Redis Enterprise Software:

```sh
sudo ./install.sh --var-dir <path>
```

2. Grant the `redislabs` user access to the custom directories:
```sh
$ sudo chown -R redislabs:redislabs /path/to/custom/storage
$ sudo chmod -R 755 /path/to/custom/storage
```

3. Confirm the storage path is properly mounted:
```sh
$ df -h /path/to/custom/storage
$ mount | grep /path/to/custom/storage
```

4. Verify the directory exists and is accessible:
```sh
ls -l /path/to/custom/storage
```

For more information about storage requirements, see [Persistent and ephemeral node storage]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}).

## Limitations

Several Redis Enterprise Software installation reference files are installed to the directory `/etc/opt/redislabs/` even if you use custom installation directories.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,33 +29,44 @@ To install Redis Enterprise Software, use the command line:
1. _(Optional)_ Use the {{< download "GPG key file" "../GPG-KEY-redislabs-packages.gpg" >}} to confirm the authenticity of Ubuntu/Debian or RHEL RPM packages:

- For Ubuntu:
1. Import the key:
1. Import the key:
```sh
gpg --import <path to GPG key>
```
2. Verify the package signature:
```sh
```
2. Verify the package signature:
```sh
dpkg-sig --verify </path-to/package.deb>
```

- For RHEL:
1. Import the key:
1. Import the key:
```sh
rpm --import <path to GPG key>
```
2. Verify the package signature:
2. Verify the package signature:
```sh
rpm --checksig </path-to/package.rpm>
```

1. To start the installation process, run the installation script. See [installation script options]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) for a list of command-line options you can add to the following command:
1. To start the installation process, run the installation script. See [installation script options]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) for a complete list of command-line options.

**For default installation:**
```sh
sudo ./install.sh
```

**For custom installation directories:**

If you need to specify custom storage paths for persistent or ephemeral storage during cluster setup, you must install Redis Enterprise Software to custom directories.

```sh
sudo ./install.sh --install-dir <path> --config-dir <path> --var-dir <path>
```

For detailed information about custom installations, see [Customize installation directories]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}}).

{{< note >}}
- The Redis Enterprise Software files are installed in the default [file locations]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md" >}}).
- The Redis Enterprise Software files are installed in the default [file locations]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md" >}}) unless you specify custom directories.
- By default, Redis Enterprise Software runs on the OS as the `redislabs` user and `redislabs` group. If needed, you can [specify a different user and group]({{< relref "/operate/rs/installing-upgrading/install/customize-user-and-group.md" >}}) during the installation.
- You must either be the root user or use `sudo` to run the installation script.
{{< /note >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,7 @@ You can change these file locations for:

- [Ephemeral and persistence storage]({{< relref "/operate/rs/clusters/new-cluster-setup.md" >}}) during cluster setup
- [Socket files]({{< relref "/operate/rs/installing-upgrading/configuring/change-location-socket-files.md" >}}) after cluster setup

{{< note >}}
To specify custom paths for ephemeral and persistent storage during cluster setup, you must install Redis Enterprise Software using [custom installation directories]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}}). If you use the default installation, you cannot specify custom storage paths and will receive a "path not mounted" error.
{{< /note >}}