Skip to content
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

Jira DOC-716: Fix broken links in in-page table of contents #1376

Merged
merged 5 commits into from
May 27, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
168 changes: 15 additions & 153 deletions content/rs/installing-upgrading/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,166 +180,28 @@ To install without answering the installation questions, either:

For geo-distributed Active-Active replication, create an [Active-Active]({{< relref "/rs/administering/creating-databases/create-active-active.md" >}}) database.

## Installation questions and options
## More info and options

The installation defaults serve most requirements; however, there are times when customizations are needed.
If you've already installed Redis Enterprise Software, you can also:

This section describes:
- [Upgrade an existing deployment]({{<relref "rs/installing-upgrading/upgrading.md">}})

- The questions asked [during installation](#installation-questions)
- [How to customize installation directories](#custom-installation-directories)
- [Set user and group ownership](#customize-system-user-and-group)
- How to perform a [silent install](#silent-install).
- Uninstall an existing deployment]({{<relref "rs/installing-upgrading/uninstalling.md">}})

### Installation questions
More info is available to help with customization and related questions:

Several questions appear during installation:

- **Linux swap file** - `Swap is enabled. Do you want to proceed? [Y/N]?`

We recommend that you [disable Linux swap]({{< relref "/rs/installing-upgrading/configuring/linux-swap.md" >}}) in the operating system configuration
to give Redis Software control of the memory allocation.

- **Automatic OS tuning** - `Do you want to automatically tune the system for best performance [Y/N]?`

To allow the installation process to optimize the OS for Redis Software, answer `Y`.
The installation process prompts you for additional information.

The `/opt/redislabs/sbin/systune.sh` file contains details about the tuning process.

- **Network time** - `Do you want to set up NTP time synchronization now [Y/N]?`

Redis Software requires that all cluster nodes have synchronized time.
You can either let the installation process configure NTP
or you can [configure NTP manually]({{< relref "/rs/administering/designing-production/synchronizing-clocks.md" >}}).

- **Firewall ports** - `Would you like to open RedisLabs cluster ports on the default firewall zone [Y/N]?`

Redis Enterprise Software requires that all nodes have [specific network ports]({{< relref "/rs/administering/designing-production/networking/port-configurations.md" >}}) open.
You can either:

- Answer `Y` to let the installation process open these ports.
- Answer `N` and configure the firewall manually for [RHEL/CentOS firewall]({{< relref "/rs/installing-upgrading/configuring/centos-rhel-7-firewall.md" >}}).
- Answer `N` and configure the firewall on the node manually for your OS.

- **Installation verification (rlcheck)** - `Would you like to run rlcheck to verify proper configuration? [Y/N]?`

We recommend running the `rlcheck` installation verification to make sure that the installation completed successfully.
If you want to run this verification at a later time, you can run: `/opt/redislabs/bin/rlcheck`

### Customize installation directories

During the installation, you can customize the installation directories.

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

{{< note >}}
- Custom installation directories are supported on RedHat Enterprise Linux version 7.
- When you install with custom directories, the installation does not run as an RPM file.
- If a `redislabs` directory already exists in the path that you specify, the installation fails.
- All nodes in a cluster must be installed with the same file locations.
{{< /note >}}

{{< note >}}
- Custom installation directories are not supported for databases using Redis on Flash.
{{< /note >}}

You can specify any or all of these file locations:

| Files | Installer flag | Example parameter | Example file location |
| ------------------- | -------------- | ----------------- | --------------------- |
| Binaries files | --install-dir | /opt | /opt/redislabs |
| Configuration files | --config-dir | /etc/opt | /etc/opt/redislabs |
| Data and log files | --var-dir | /var/opt | /var/opt/redislabs |

These files are not in the custom directories:

- OS files
- /etc/cron.d/redislabs
- /etc/firewalld/services
- /etc/firewalld/services/redislabs-clients.xml
- /etc/firewalld/services/redislabs.xml
- /etc/ld.so.conf.d/redislabs_ldconfig.conf.tmpl
- /etc/logrotate.d/redislabs
- /etc/profile.d/redislabs_env.sh
- /usr/lib/systemd/system/rlec_supervisor.service.tmpl
- /usr/share/selinux/mls/redislabs.pp
- /usr/share/selinux/targeted/redislabs.pp

- Installation reference files
- /etc/opt/redislabs/redislabs_custom_install_version
- /etc/opt/redislabs/redislabs_env_config.sh

To install to specific directories, run:

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

### Customize system user and group

By default, Redis Enterprise Software is installed with the user:group `redislabs:redislabs`.

During the installation, you can specify the user and group that own all Redis Enterprise Software processes.

If you specify the user only, then installation is run with the primary group that the user belongs to.

{{< note >}}
- Custom installation user is supported on RedHat Enterprise Linux version 7.
- When you install with custom directories, the installation does not run as an RPM file.
- You must create the user and group befor attempting to install Redis Software.
- You can specify an LDAP user as the installation user.
{{< /note >}}

Use command-line options for the install script to customize the user or group:

```sh
sudo ./install.sh --os-user <user> --os-group <group>
```

### Silent install

To install without answering the installation questions, do one of the following:

- Run `./install.sh -y` to answer yes to all of the questions.
- Prepare an answer file and use it to do a silent installation.

To install with an answer file:

1. Prepare the answer file with the answers to the [installation questions](#installation-questions).

The answer file can contain any of the parameters for the installation questions and indicate the answer for the question with `yes` or `no`.

For example:

```sh
ignore_swap=no
systune=yes
ntp=no
firewall=no
rlcheck=yes
```

If you use `systune=yes`, the installation answers `yes` to all of the system tuning questions.

1. Run the install script with `-c` and the path to the answer file.

For example:

```sh
./install.sh -c /home/user/answers
```

## Additional configuration

Specialized configuration info is also available:

- [Configure CentOS/RHEL Firewall]({{< relref "rs/installing-upgrading/configuring/centos-rhel-7-firewall.md" >}})
- [AWS EC2 configuration]({{<relref "rs/installing-upgrading/configuring-aws-instances.md">}})
- [CentOS/RHEL Firewall conifugration]({{< relref "rs/installing-upgrading/configuring/centos-rhel-7-firewall.md" >}})
- [Change socket file location]({{< relref "rs/installing-upgrading/configuring/change-location-socket-files.md" >}})
- [mDNS client prerequisites]({{< relref "rs/installing-upgrading/configuring/mdns.md" >}})
- [Configure cluster DNS]({{< relref "rs/installing-upgrading/configuring/cluster-dns.md" >}})
- [Configure Linux swap space]({{< relref "rs/installing-upgrading/configuring/linux-swap.md" >}})
- [Cluster DNS configuration]({{< relref "rs/installing-upgrading/configuring/cluster-dns.md" >}})
- [Cluster load balancer setup]({{< relref "rs/installing-upgrading/configuring/cluster-lba-setup.md" >}})
- [File locations]({{<relref "rs/installing-upgrading/file-locations.md">}})
- [Supported platforms]({{<relref "rs/installing-upgrading/supported-platforms.md">}})
- [Linux swap space configuration]({{< relref "rs/installing-upgrading/configuring/linux-swap.md" >}})
- [Manage installation questions]({{<relref "rs/installing-upgrading/manage-installation-questions.md">}})
- [mDNS client prerequisites]({{< relref "rs/installing-upgrading/configuring/mdns.md" >}})
- [Offline installation]({{<relref "rs/installing-upgrading/offline-installation.md">}})
- [User and group ownership](({{<relref "rs/installing-upgrading/customize-user-and-group.md">}}))

## Next steps
AlonMagrafta marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: CentOS/RHEL 7 Firewall Configuration
title: Configure CentOS/RHEL 7 Firewall
linkTitle: CentOS/RHEL 7 Firewall
description:
weight: $weight
alwaysopen: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
Title: Change Location of Socket Files
LinkTitle: Socket file location
description:
weight: $weight
alwaysopen: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
Title: Setting Up a Cluster Behind a Load Balancer
linkTitle: Cluster load balancer setup
description:
weight: $weight
alwaysopen: false
Expand All @@ -26,7 +27,7 @@ A load balancer is configured in front of Redis Enterprise cluster, exposing sev
- Control plane services, such as the RS admin console to access cluster administration interface
- Data plane services, such as a database endpoint to connect from client applications

Depending on which Redis Enterprise services you want to access outside the cluster you may need to configure the load balancers seperately.
Depending on which Redis Enterprise services you want to access outside the cluster you may need to configure the load balancers separately.
One or more Virtual IPs (VIPs) are defined on the load balancer to expose Redis Enterprise services.
The architecture is shown in the following diagram with 3 nodes Redis Enterprise cluster with one database (DB1) configured on port 12000:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
---
Title: Configuring AWS Route53 DNS Management
linkTitle: AWS Route 53 DNS
description:
weight: $weight
alwaysopen: false
categories: ["RS"]
aliases: /rs/administering/installing-upgrading/configuring/cluster-name-dns-connection-management/configuring-aws-route53-dns-redis-enterprise
/rs/installing-upgrading/configuring/cluster-name-dns-connection-management/configuring-aws-route53-dns-redis-enterprise/
---
Redis Enterprise Software (RS) requires DNS to be properly configured to
achieve high-availability (HA) and fail-over regardless of where it is
installed. Here we discuss doing this with AWS's Route53 service
for DNS resolution.
Redis Enterprise Software requires DNS to be properly configured to
achieve high availability and fail-over regardless of where it is
installed.

Here, you learn how to configure AWS Route53 DNS resolution.

## Prerequisites

Expand Down
1 change: 1 addition & 0 deletions content/rs/installing-upgrading/configuring/mdns.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
Title: Client Prerequisites for mDNS
linkTitle: mDNS client prerequisites
description:
weight: $weight
alwaysopen: false
Expand Down
57 changes: 57 additions & 0 deletions content/rs/installing-upgrading/customize-install-directories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
Title: Customize installation directories
linkTitle: Customize install locations
description:
weight: 30
alwaysopen: false
categories: ["RS"]
aliases: /rs/installing-upgrading/customize-install-directories/
---

When installing Redis Enterprise Software, you can customize the installation directories.

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

{{< note >}}
- Custom installation directories are supported on RedHat Enterprise Linux version 7.
- When you install with custom directories, the installation does not run as an RPM file.
- If a `redislabs` directory already exists in the path that you specify, the installation fails.
- All nodes in a cluster must be installed with the same file locations.
{{< /note >}}

{{< note >}}
- Custom installation directories are not supported for databases using Redis on Flash.
{{< /note >}}

You can specify any or all of these file locations:

| Files | Installer flag | Example parameter | Example file location |
| ------------------- | -------------- | ----------------- | --------------------- |
| Binaries files | --install-dir | /opt | /opt/redislabs |
| Configuration files | --config-dir | /etc/opt | /etc/opt/redislabs |
| Data and log files | --var-dir | /var/opt | /var/opt/redislabs |

These files are not in the custom directories:

- OS files
- /etc/cron.d/redislabs
- /etc/firewalld/services
- /etc/firewalld/services/redislabs-clients.xml
- /etc/firewalld/services/redislabs.xml
- /etc/ld.so.conf.d/redislabs_ldconfig.conf.tmpl
- /etc/logrotate.d/redislabs
- /etc/profile.d/redislabs_env.sh
- /usr/lib/systemd/system/rlec_supervisor.service.tmpl
- /usr/share/selinux/mls/redislabs.pp
- /usr/share/selinux/targeted/redislabs.pp

- Installation reference files
- /etc/opt/redislabs/redislabs_custom_install_version
- /etc/opt/redislabs/redislabs_env_config.sh

To install to specific directories, run:

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

29 changes: 29 additions & 0 deletions content/rs/installing-upgrading/customize-user-and-group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
Title: Customize system user and group
linkTitle: Customize user and group
description:
weight: 30
alwaysopen: false
categories: ["RS"]
aliases: /rs/installing-upgrading/customize-user-and-group/
---

By default, Redis Enterprise Software is installed with the user:group `redislabs:redislabs`.

During the installation, you can specify the user and group that own all Redis Enterprise Software processes.

If you specify the user only, then installation is run with the primary group that the user belongs to.

{{< note >}}
- Custom installation user is supported on RedHat Enterprise Linux version 7.
- When you install with custom directories, the installation does not run as an RPM file.
- You must create the user and group befor attempting to install Redis Software.
- You can specify an LDAP user as the installation user.
{{< /note >}}

Use command-line options for the install script to customize the user or group:

```sh
sudo ./install.sh --os-user <user> --os-group <group>
```

Loading