Skip to content

Commit 1d17c34

Browse files
Clarify custom installation requirements for custom storage paths (DOC-635)
- Update install-on-linux.md to clearly explain when custom installation is needed - Add specific guidance about custom storage path requirements - Enhance customize-install-directories.md with troubleshooting section - Include specific error message and resolution steps - Add cross-references between installation and storage documentation - Address fragmented user experience by connecting related concepts Resolves DOC-635
1 parent 73fda7e commit 1d17c34

File tree

3 files changed

+75
-8
lines changed

3 files changed

+75
-8
lines changed

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

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ When you install Redis Enterprise Software on Red Hat Enterprise Linux, you can
1414

1515
The files are installed in the `redislabs` directory located in the path that you specify.
1616

17+
{{< note >}}
18+
Custom installation is required if you plan to specify custom storage paths for persistent or ephemeral storage during cluster setup. If you install Redis Enterprise Software to default directories, you cannot specify custom storage paths during cluster creation.
19+
{{< /note >}}
20+
1721
## Considerations
1822

1923
- When you install with custom directories, the installation does not run as an RPM file.
@@ -76,6 +80,45 @@ To configure different mount points for data and log directories, use symbolic l
7680
ln -s /var/opt/redislabs/log </path/to/log/mount/point>
7781
```
7882

83+
## Custom storage paths
84+
85+
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" >}}).
86+
87+
### Prerequisites for custom storage paths
88+
89+
Before specifying custom storage paths during cluster setup:
90+
91+
1. Install Redis Enterprise Software to custom directories using the `--install-dir`, `--config-dir`, and `--var-dir` flags.
92+
93+
2. Ensure proper permissions: The custom storage directories must have full permissions for the `redislabs` user and group (`redislabs:redislabs`).
94+
95+
3. Verify mount points: Custom storage paths must be properly mounted and accessible.
96+
97+
### Troubleshooting custom storage paths
98+
99+
If you encounter the error "path entered is not mounted. Please correct" when specifying custom storage paths:
100+
101+
1. Verify the installation method: Ensure Redis Enterprise Software was installed using custom directories. If you used the default installation (`sudo ./install.sh` without custom directory flags), you cannot specify custom storage paths.
102+
103+
2. Check directory permissions: Ensure the `redislabs` user has full access to the specified directories:
104+
```sh
105+
sudo chown -R redislabs:redislabs /path/to/custom/storage
106+
sudo chmod -R 755 /path/to/custom/storage
107+
```
108+
109+
3. Verify mount points: Confirm the storage path is properly mounted:
110+
```sh
111+
df -h /path/to/custom/storage
112+
mount | grep /path/to/custom/storage
113+
```
114+
115+
4. Check directory existence: Ensure the directory exists and is accessible:
116+
```sh
117+
ls -la /path/to/custom/storage
118+
```
119+
120+
For more information about storage requirements, see [Persistent and ephemeral node storage]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}).
121+
79122
## Limitations
80123

81124
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: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,37 +29,57 @@ 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:
5252

53+
**For standard 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. See [installation script options]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) for a complete list of command-line options.
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 >}}
6273

74+
### When to use custom installation directories
75+
76+
You should use custom installation directories if you need to:
77+
78+
- Specify custom storage paths for persistent or ephemeral storage during cluster setup
79+
- Install Redis Enterprise Software in non-default locations for organizational or security requirements
80+
- Avoid using root directories for the installation
81+
- Meet specific compliance or infrastructure requirements
82+
6383
1. Answer the [installation questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions.md" >}}) when shown to complete the installation process.
6484

6585
{{< 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 storage 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)