You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: content/operate/rs/installing-upgrading/install/customize-install-directories.md
+43Lines changed: 43 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,10 @@ When you install Redis Enterprise Software on Red Hat Enterprise Linux, you can
14
14
15
15
The files are installed in the `redislabs` directory located in the path that you specify.
16
16
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
+
17
21
## Considerations
18
22
19
23
- 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
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:
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
+
79
122
## Limitations
80
123
81
124
Several Redis Enterprise Software installation reference files are installed to the directory `/etc/opt/redislabs/` even if you use custom installation directories.
Copy file name to clipboardExpand all lines: content/operate/rs/installing-upgrading/install/install-on-linux.md
+28-8Lines changed: 28 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -29,37 +29,57 @@ To install Redis Enterprise Software, use the command line:
29
29
1. _(Optional)_ Use the {{< download "GPG key file""../GPG-KEY-redislabs-packages.gpg">}} to confirm the authenticity of Ubuntu/Debian or RHEL RPM packages:
30
30
31
31
- For Ubuntu:
32
-
1. Import the key:
32
+
1. Import the key:
33
33
```sh
34
34
gpg --import <path to GPG key>
35
-
```
36
-
2. Verify the package signature:
37
-
```sh
35
+
```
36
+
2. Verify the package signature:
37
+
```sh
38
38
dpkg-sig --verify </path-to/package.deb>
39
39
```
40
40
41
41
- For RHEL:
42
-
1. Import the key:
42
+
1. Import the key:
43
43
```sh
44
44
rpm --import <path to GPG key>
45
45
```
46
-
2. Verify the package signature:
46
+
2. Verify the package signature:
47
47
```sh
48
48
rpm --checksig </path-to/package.rpm>
49
49
```
50
50
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:
52
52
53
+
**For standard installation:**
53
54
```sh
54
55
sudo ./install.sh
55
56
```
56
57
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.
For detailed information about custom installations, see [Customize installation directories]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories">}}).
67
+
57
68
{{< 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.
59
70
- 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.
60
71
- You must either be the root user or use `sudo` to run the installation script.
61
72
{{< /note >}}
62
73
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
+
63
83
1. Answer the [installation questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions.md">}}) when shown to complete the installation process.
Copy file name to clipboardExpand all lines: content/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -41,3 +41,7 @@ You can change these file locations for:
41
41
42
42
-[Ephemeral and persistence storage]({{< relref "/operate/rs/clusters/new-cluster-setup.md" >}}) during cluster setup
43
43
-[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.
0 commit comments