Skip to content

Commit e87ff34

Browse files
Merge pull request #1625 from redis/DOC-635
Clarify custom installation requirements for custom storage paths (DO…
2 parents 1460939 + cb229b6 commit e87ff34

File tree

3 files changed

+53
-8
lines changed

3 files changed

+53
-8
lines changed

content/operate/rs/installing-upgrading/install/customize-install-directories.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,36 @@ To configure different mount points for data and log directories, use symbolic l
7676
ln -s /var/opt/redislabs/log </path/to/log/mount/point>
7777
```
7878

79+
## Customize storage paths
80+
81+
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" >}}).
82+
83+
84+
1. Specify the custom file location with the `--var-dir` option when you install Redis Enterprise Software:
85+
86+
```sh
87+
sudo ./install.sh --var-dir <path>
88+
```
89+
90+
2. Grant the `redislabs` user access to the custom directories:
91+
```sh
92+
$ sudo chown -R redislabs:redislabs /path/to/custom/storage
93+
$ sudo chmod -R 755 /path/to/custom/storage
94+
```
95+
96+
3. Confirm the storage path is properly mounted:
97+
```sh
98+
$ df -h /path/to/custom/storage
99+
$ mount | grep /path/to/custom/storage
100+
```
101+
102+
4. Verify the directory exists and is accessible:
103+
```sh
104+
ls -l /path/to/custom/storage
105+
```
106+
107+
For more information about storage requirements, see [Persistent and ephemeral node storage]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}).
108+
79109
## Limitations
80110

81111
Several Redis Enterprise Software installation reference files are installed to the directory `/etc/opt/redislabs/` even if you use custom installation directories.

content/operate/rs/installing-upgrading/install/install-on-linux.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,33 +29,44 @@ To install Redis Enterprise Software, use the command line:
2929
1. _(Optional)_ Use the {{< download "GPG key file" "../GPG-KEY-redislabs-packages.gpg" >}} to confirm the authenticity of Ubuntu/Debian or RHEL RPM packages:
3030

3131
- For Ubuntu:
32-
1. Import the key:
32+
1. Import the key:
3333
```sh
3434
gpg --import <path to GPG key>
35-
```
36-
2. Verify the package signature:
37-
```sh
35+
```
36+
2. Verify the package signature:
37+
```sh
3838
dpkg-sig --verify </path-to/package.deb>
3939
```
4040

4141
- For RHEL:
42-
1. Import the key:
42+
1. Import the key:
4343
```sh
4444
rpm --import <path to GPG key>
4545
```
46-
2. Verify the package signature:
46+
2. Verify the package signature:
4747
```sh
4848
rpm --checksig </path-to/package.rpm>
4949
```
5050

51-
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:
51+
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.
5252

53+
**For default installation:**
5354
```sh
5455
sudo ./install.sh
5556
```
5657

58+
**For custom installation directories:**
59+
60+
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.
61+
62+
```sh
63+
sudo ./install.sh --install-dir <path> --config-dir <path> --var-dir <path>
64+
```
65+
66+
For detailed information about custom installations, see [Customize installation directories]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}}).
67+
5768
{{< note >}}
58-
- The Redis Enterprise Software files are installed in the default [file locations]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md" >}}).
69+
- 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.
5970
- 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.
6071
- You must either be the root user or use `sudo` to run the installation script.
6172
{{< /note >}}

content/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,7 @@ You can change these file locations for:
4141

4242
- [Ephemeral and persistence storage]({{< relref "/operate/rs/clusters/new-cluster-setup.md" >}}) during cluster setup
4343
- [Socket files]({{< relref "/operate/rs/installing-upgrading/configuring/change-location-socket-files.md" >}}) after cluster setup
44+
45+
{{< note >}}
46+
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.
47+
{{< /note >}}

0 commit comments

Comments
 (0)