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 4 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
21 changes: 14 additions & 7 deletions content/embeds/hardware-requirements-embed.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The hardware requirements for Redis Enterprise Software (RS) are different for development and production environments.
The hardware requirements for Redis Enterprise Software are different for development and production environments.

- In a development environment you can test your application with a live RS database.
- In a development environment, you can test your application with a live database.

If you want to test your application under production conditions, use the production environment requirements.

Expand Down Expand Up @@ -33,12 +33,19 @@ We recommend these hardware requirements for production systems or for developme
<sup>*</sup>Additional considerations:

- Cores:
- When the CPU load reaches a certain level, Redis Enterprise Software sends an alert to the operator.
- When the CPU load reaches a certain level, Redis Enterprise Software sends an alert to the operator.

- If your application is designed to put a lot of load on your Redis database, make sure that you have at least one available core for each shard of your database.

- If some of the cluster nodes are utilizing more than 80% of the CPU, consider migrating busy resources to less busy nodes.

- If all the cluster nodes are utilizing over 80% of the CPU, consider scaling out the cluster by [adding a node]({{< relref "/rs/administering/adding-node.md" >}}).

- RAM:
- Since Redis uses a relatively large amount of buffers (such as for slave communication, client communication, and pub/sub commands) make sure that at least 30% of the RAM is "unused" on each node.
- If some of the cluster nodes are utilizing more than 65% of the RAM, you should look at migrating busy resources to less busy nodes.
- If all the cluster nodes are utilizing over 70% of the RAM, you should look to scale out the cluster by [adding a node]({{< relref "/rs/administering/adding-node.md" >}}).
- Do not run other memory-consuming systems on the RS node.
- Redis uses a relatively large number of buffers, which enable replica communication, client communication, pub/sub commands, and more. As a result, you should ensure that 30% of the RAM is available on each node at any given time.

- If one or more cluster nodes utilizes more than 65% of the RAM, consider migrating resources to less active nodes.

- If all cluster nodes are utilizing more than 70% of available RAM, consider [adding a node]({{< relref "/rs/administering/adding-node.md" >}}).

- Do not run any other memory-intensive processes on the Redis Software node.
347 changes: 88 additions & 259 deletions content/rs/installing-upgrading/_index.md

Large diffs are not rendered by default.

19 changes: 13 additions & 6 deletions content/rs/installing-upgrading/configuring-aws-instances.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
---
Title: Configuring AWS EC2 instances for Redis Enterprise Software
Title: Configure AWS EC2 instances for Redis Enterprise Software
linkTitle: AWS EC2 configuration
description:
weight: 30
alwaysopen: false
categories: ["RS"]
aliases: /rs/administering/installing-upgrading/configuring-aws-instances/
---
There are some special considerations that are important when installing
and running Redis Enterprise Software (RS) on AWS EC2 instances or AWS Outposts.
and running Redis Enterprise Software on Amazon Web Services (AWS), whether Amazon Electric Cloud Compute (EC2) AWS Outposts.

## Storage considerations
These include:

- [Storage considerations](#storage)
- [Instance types](#instance-types)
- [Security group configuration](#security)

## Storage considerations {#storage}

AWS EC2 instances are ephemeral, but your persistent database storage should
not be. If you require a persistent storage location for your database,
Expand Down Expand Up @@ -37,7 +44,7 @@ this feature could be critical to use:
this case, the provisioned IOPS should be on the nodes used as
slaves in the cluster.

## Instance types
## Instance types {#instance-types}

Choose an instance type that has (at minimum) enough free memory and
disk space to meet RS's [hardware
Expand All @@ -48,7 +55,7 @@ and some are not. If you are using persistent storage, you should use an
instance type that is, especially if disk drain rate matters to your database
implementation.

## Security
## Security group configuration {#security}

When configuring the Security Group:

Expand All @@ -66,5 +73,5 @@ When configuring the Security Group:

After successfully launching the instances:

1. Install RS from the [Linux package or AWS AMI]({{< relref "/rs/installing-upgrading/_index.md" >}}).
1. Install Redis Enterprise Software from the [Linux package or AWS AMI]({{< relref "/rs/installing-upgrading/_index.md" >}}).
2. [Set up the cluster]({{< relref "/rs/administering/new-cluster-setup.md" >}}).
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>
```

88 changes: 88 additions & 0 deletions content/rs/installing-upgrading/manage-installation-questions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
Title: Manage installation questions
linkTitle: Manage install questions
description:
weight: 30
alwaysopen: false
categories: ["RS"]
aliases: /rs/installing-upgrading/manage-installation-questions/
---

Several questions are displayed during the Redis Software installation process.

Here, you'll find a list of these questions and learn how to automatically answer these questions to perform a silent install.
lanceleonard marked this conversation as resolved.
Show resolved Hide resolved

## Installation 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`

## Answer install questions automatically

To perform a silent (or automated) install, answer the questions when you start the install.

There are two ways to do so:

- To automatically answer `yes` to all questions (which accepts the default values), start the install script with the `-y` parameter:

```bash
`% ./install.sh -y`
```

- Use an answer file to manage your response:

1. Create a text file to serve as an answer file.

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. Start the install script with the `-c` command-line option and add the path to the answer file.

For example:

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

1 change: 1 addition & 0 deletions content/rs/installing-upgrading/uninstalling.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
Title: Uninstalling Redis Enterprise Software
LinkTitle: Uninstall Redis Enterprise Software
description:
weight: 70
alwaysopen: false
Expand Down
25 changes: 13 additions & 12 deletions content/rs/installing-upgrading/upgrading.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
Title: Upgrading Redis Enterprise Software
Title: Upgrade Redis Enterprise Software
linkTitle: Upgrade Redis Enterprise Software
description:
weight: 60
alwaysopen: false
categories: ["RS"]
aliases: /rs/administering/installing-upgrading/upgrading/
---
To upgrade the Redis Enterprise Software (RS) software on a cluster,
To upgrade the Redis Enterprise Software software on a cluster,
you must upgrade each of the nodes and then upgrade each of the databases in the cluster.

For Active-Active clusters, you must upgrade all the nodes on all clusters first, and then upgrade each of the databases in each cluster.
Expand All @@ -33,7 +34,7 @@ Using features from the newer version before all nodes are upgraded can produce

{{< /warning >}}

## Upgrading a node
## Upgrade a node

Upgrading the software on a node requires installing the [RS installation
package]({{< relref "/rs/installing-upgrading/_index.md" >}})
Expand Down Expand Up @@ -78,22 +79,22 @@ If you have the RS management UI open in the browser while you are
upgrading the nodes, make sure that you refresh the browser before trying
to work with the UI again.

## Upgrading a database
## Upgrade a database

Some RS upgrades add support for new Redis versions. In these cases,
Some upgrades add support for new Redis versions. In these cases,
Redis Labs recommends that you upgrade the databases to the new Redis
version, although this is not mandatory because RS upgrades are backward
compatible. RS also supports a mix of Redis database versions.
version, although this is not mandatory because upgrades are backward
compatible. Redis Software also supports a mix of Redis database versions.

RS always supports two Redis versions. By default, new Redis databases
Redis Software always supports two Redis versions. By default, new Redis databases
are created with the latest version, and existing databases get upgraded
to the latest version according to the instructions detailed below. If
you would like to change the default Redis version to the previous
version supported, you should use the `tune cluster default_redis_version`
command in the rladmin CLI and set it to the previous Redis version supported.
command in the `rladmin` CLI and set it to the previous Redis version supported.

To check whether your Redis database versions match the latest Redis
version supported by RS:
To check whether your Redis database versions match the latest supported Redis
version:

- In the [rladmin CLI]({{< relref "/rs/references/rladmin.md" >}}),
run the `status` command.
Expand Down Expand Up @@ -125,7 +126,7 @@ a result:
- For databases that have neither replication nor [persistence]({{< relref "/rs/concepts/data-access/persistence.md" >}})
enabled, the database loses all its data after it is restarted.

## Upgrading Active-Active databases {#upgrading-activeactive-databases}
## Upgrade Active-Active databases {#upgrading-activeactive-databases}

When you upgrade an Active-Active (CRDB) database, you can also upgrade:

Expand Down
Loading