Skip to content

Commit

Permalink
Initial draft (#1472)
Browse files Browse the repository at this point in the history
  • Loading branch information
lanceleonard authored Jul 30, 2021
1 parent 368cf9c commit 5ad045c
Show file tree
Hide file tree
Showing 4 changed files with 144 additions and 132 deletions.
2 changes: 2 additions & 0 deletions content/rc/administration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ alwaysopen: false
categories: ["RC"]
aliases: /rv/administration/
/rc/administration/configuration/
/rv/how-to/
/rc/how-to/
---
With Redis Enterprise Cloud, most administrative tasks are handled for you; however, there are a few things that you need to take care of yourself.

Expand Down
9 changes: 0 additions & 9 deletions content/rc/how-to/_index.md

This file was deleted.

151 changes: 75 additions & 76 deletions content/ri/faqs.md
Original file line number Diff line number Diff line change
@@ -1,142 +1,141 @@
---
Title: FAQs
description:
description: Answers frequently asked questions about RedisInsight.
weight: 80
alwaysopen: false
categories: ["RI"]
---
Here are some frequently asked questions about Redis Enterprise Software.
Here are some frequently asked questions about RedisInsight.

## General

{{< expand-control >}}
{{% expand "What is RedisInsight?" %}}
RedisInsight is a browser based GUI for Redis. It lets you do the following -
### What is RedisInsight?

RedisInsight is a browser based graphical user interface (GUI) for Redis databases.

With it, you can:

- Browse
- View real time metrics from redis
- Create tabular views from your redis keys and export data in different formats
- Perform CRUD operations using the web based CLI
- Perform CRUD (create, read, update, and delete) operations using the web based command-line interface (CLI).
- Visualize and update data from [Streams](https://redis.io/topics/streams-intro), [RedisGraph](https://redisgraph.io), [RediSearch](https://redisearch.io) and [RedisTimeSeries](https://redistimeseries.io).

- Analyse
- Analyze memory used by redis by keys or key patterns, by expiry, by data types or or the internal encoding
- Filter keys by number of elements or by memory, and identify top keys
- Profile redis to list keys or commands redis is executing

- Bulk Actions

- Configure
- View and modify redis configuration
- View list of clients and kill specific clients
{{% /expand %}}
- View list of clients and stop specific clients

### What problem does RedisInsight solve?

RedisInsight lets you reduce memory used by Redis, which usually translates to a proportional cost reduction. It also helps you identify common latency issues and perform routine administrative tasks on your Redis server.

{{% expand "What problem does RedisInsight solve?" %}}
RedisInsight lets you reduce memory used by redis, which usually translates to a proportional cost reduction. It also helps you identify common latency issues, and perform routine administrative tasks on your redis server.
{{% /expand %}}
### How does RedisInsight compare with redis-rdb-tools?

{{% expand "How does RedisInsight compare with the open source redis-rdb-tools?" %}}
We open sourced redis-rdb-tools in 2012 as a way to analyze the RDB file, and we continue to support the open source version. The open source version is meant to be a library and command line utility. It is a fundamental building block for RedisInsight. RedisInsight is free to use but is closed source.
{{% /expand %}}

{{% expand "What versions of Redis does RedisInsight support?" %}}
### What versions of Redis does RedisInsight support?

Currently, RedisInsight supports single node redis instances. Redis Cluster support is experimental, but not all features work. If you want to use RedisInsight for Redis Cluster, send us an [email](mailto:redisinsight@redislabs.com) and we can try to accommodate your use case.
{{% /expand %}}

{{% expand "Do you support Redis Labs Enterprise Version?" %}}
Yes, RedisInsight is fully compatible with Redis Labs Enterprise version.
{{% /expand %}}
### Do you support Redis Enterprise?

Yes, RedisInsight is fully compatible with Redis Enterprise Software and Redis Enterprise Cloud.

{{% expand "What cloud providers do you support?" %}}
We support Redis Cloud, Redis Cloud Pro, AWS Elasticache and Azure Redis Cache. That said, RedisInsight should work with any cloud provider as long as you run it on a host that has network access to your cloud based redis server. Send us an [email](mailto:redisinsight@redislabs.com) if you would like to use RedisInsight on a cloud provider that we haven't listed.
{{% /expand %}}
### What cloud providers do you support?

{{< /expand-control >}}
We support Redis Enterprise Cloud, AWS Elasticache, and Azure Redis Cache. That said, RedisInsight should work with any cloud provider as long as you run it on a host that has network access to your cloud based Redis server.

Send us an [email](mailto:redisinsight@redislabs.com) if you would like to use RedisInsight on a cloud provider that we haven't listed.

## Memory analysis

{{< expand-control >}}
{{% expand "How long does the memory analysis take?" %}}
This depends on how large your dataset and the host on which you are running your docker container. Empirically, expect 30s per GB of RAM analyzed.
{{% /expand %}}
### How long does the memory analysis take?

This depends on the size of your database and the host server. In general, expect analysis to require 30 seconds per GB of RAM anaylyzed.

### What is the online mode of memory analysis?

In online mode, RedisInsight connects to your Redis server, downloads the entire data set, and then analyzes it in a background process.

Data is downloaded in one of two ways:

{{% expand "What is the online mode of memory analysis?" %}}
In online mode, RedisInsight connects to your redis server, downloads the entire data set, and then analyzes it in a background process. To download the data set from redis server, one of two approaches is used. If the server allows it, we use the SYNC command to download a RDB file. If the server blocks SYNC, we use SCAN + DUMP in an loop.
{{% /expand %}}
- If the server allows the SYNC command, we use it to a database RDB file.
- If the server blocks SYNC, we use SCAN&nbsp;+&nbsp;DUMP in an loop.

### What is the overhead of online memory analysis on redis server?

{{% expand "What is the overhead of online memory analysis on redis server?" %}}
The overhead is minimal. If SYNC command is supported, the overhead is the same as connecting a slave for a short duration. If SYNC command is disabled, we run the SCAN command followed by DUMP in a pipeline. Neither approach blocks your redis server.
{{% /expand %}}

{{% expand "What is offline mode of memory analysis?" %}}
In the offline mode, RedisInsight downloads a RDB file from a S3 bucket you specify. This RDB file is then analyzed in a background process.
{{% /expand %}}
### What is offline mode of memory analysis?

In the offline mode, RedisInsight downloads a RDB file from a specified S3 bucket you specify and then analyzes it in a background process.

### What is the overhead of offline memory analysis on redis server?

Zero overhead, since we do not need to connect to your Redis server

{{% expand "What is the overhead of offline memory analysis on redis server?" %}}
Zero overhead, since we do not need to connect to your redis server
{{% /expand %}}
### How is memory used by a key calculated?

{{% expand "How is memory used by a key calculated?" %}}
We look at the internal structures redis needs to allocate to store the key and determine the memory consumption. We also account for allocator overheads, as well as differences between redis versions.
{{% /expand %}}
We look at the internal structures Redis needs to allocate to store the key and determine the memory consumption. We also account for allocator overheads and differences between Redis versions.

{{% expand "How accurate is the memory analysis?" %}}
The memory used by a key is based on heuristics, and is usually within 10% of the actual consumption.
{{% /expand %}}
### How accurate is the memory analysis?

The memory used by a key is based on heuristics and is usually within 10% of the actual consumption.

### What are key patterns?

{{% expand "What are key patterns?" %}}
Key pattern is a grouping of related keys, for example users:*. RedisInsight can show you total memory consumption by key pattern, and also the biggest keys within that key pattern.
{{% /expand %}}

{{% expand "How are key patterns generated?" %}}
We assume that you use colon as a separator. If you use a non-standard separator, you have to add key patterns manually.
{{% /expand %}}
### How are key patterns generated?

{{< /expand-control >}}
We assume that you use colon as a separator. If you use a non-standard separator, you have to add key patterns manually.

## Connecting to Redis
## Connect to Redis

{{< expand-control >}}
### How do I connect to redis-server running on localhost?

{{% expand "How do I connect to redis-server running on localhost?" %}}
First, this works only if you have RedisInsight running on your local computer. Depending on your docker version, you can use one of these host names instead of localhost - docker.for.mac.localhost, docker.for.win.localhost or host.docker.internal. If none of those host names work, find the ip address of your computer (usually starts with 192.x.x.x), and use that ip address instead of localhost.
{{% /expand %}}

{{% expand "How do I connect to AWS Elasticache?" %}}
### How do I connect to AWS Elasticache?

You must install RedisInsight inside your VPC, either on an EC2 instance, or using ECS or Fargate. See [EC2 Installation Instructions]({{< relref "/ri/installing/install-ec2.md" >}})
{{% /expand %}}

{{% expand "What are the memory limits on your license terms?" %}}
Our licensing works on the sum of used memory on the redis instances you have added to RedisInsight. So if your license allows 15GB, you can add 5 redis instances using 3 GB RAM, or 1 redis server using 15 GB.
{{% /expand %}}
### What are the memory limits on your license terms?

{{< /expand-control >}}
Our licensing works on the sum of used memory on the Redis instances you have added to RedisInsight. So if your license allows 15GB, you can add 5 redis instances using 3 GB RAM, or 1 redis server using 15 GB.

## License and support

{{< expand-control >}}
### Is RedisInsight a free tool?

{{% expand "Is RedisInsight a free tool?" %}}
Yes, RedisInsight is available as a non-commercial, free of charge tool. You can review the terms of use in the [RedisInsight Licence Terms](https://redislabs.com/wp-content/uploads/2019/10/RedisInsight-EULA-terms.pdf) document.
{{% /expand %}}

{{% expand "Where can I find the licence terms of RedisInsight?" %}}
See the official [RedisInsight Licence Terms](https://redislabs.com/wp-content/uploads/2019/10/RedisInsight-EULA-terms.pdf) document.
{{% /expand %}}
### Where can I find the licence terms of RedisInsight?

{{< /expand-control >}}
See the official [RedisInsight Licence Terms](https://redislabs.com/wp-content/uploads/2019/10/RedisInsight-EULA-terms.pdf) document.

## Privacy and security

{{< expand-control >}}
## Who has access to my Redis servers?

{{% expand "Who has access to my redis servers?" %}}
We provide RedisInsight as a docker container that you install and run on your hardware or cloud account. We do not have any ability to connect to your installation of RedisInsight or look at data within your redis servers.
{{% /expand %}}

{{% expand "How can I secure my RedisInsight installation?" %}}
We recommend installing HTTPS, whitelisting IP addresses that have access to RedisInsight and/or making it available within your VPN/internal network. Additionally, make sure you use a strong admin password for your database.
{{% /expand %}}
### How can I secure my RedisInsight installation?

We recommend:
- Installing HTTPS
- Using an allow list to restrict IP access to RedisInsight
- Installing RedisInsight within your VPN/internal network.

Additionally, make sure you use a strong admin password for your database.

{{% expand "What information do you collect about my installation?" %}}
We use google analytics so that we can understand how customers use the software. Per google analytics terms and conditions, we do not track any personally identifiable information.
{{% /expand %}}
### What information do you collect about my installation?

{{< /expand-control >}}
We use Google Analytics to understand how customers use the software. Per their terms and conditions, we do not track any personally identifiable information.
114 changes: 67 additions & 47 deletions content/rs/faqs/_index.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,100 @@
---
Title: FAQs
description:
description: Answers frequently asked questions regarding Redis Enterprise Software.
weight: 70
alwaysopen: false
categories: ["RS"]
---
Here are some frequently asked questions about Redis Enterprise Software (RS).
Here are some frequently asked questions about Redis Enterprise Software.

## Features and terminology

{{< expand-control >}}
<!-- Also in RC -->
{{< expand "What exactly is Redis Enterprise?" >}}
{{< embed-md "what-is-redis-enterprise.md" >}}
{{< /expand >}}
### What exactly is Redis Enterprise?

Redis Labs has enhanced open source Redis with a technology layer that encapsulates open source Redis, while fully supporting all its commands, data structures and modules.

Redis Enterprise adds exceptional flexibility, stable high performance and unmatched resilience, as well as multiple deployment choices (public and private clouds, on-premises, hybrid, RAM-Flash combination), topology (active-active, active-passive, active-replica) and support for very large dataset sizes.

This enhanced and exponentially more powerful database platform is Redis Enterprise.

Learn more about [Redis Enterprise](https://redislabs.com/why-redis/redis-enterprise/).

### Are you fully compatible with open source Redis?

{{% expand "Are you fully compatible with open source Redis?" %}}
Redis Enterprise Software is fully [compatible with open source Redis]({{<relref "rs/concepts/compatibility">}}).
{{% /expand %}}

{{< expand "Can I keep my data safe and always available?" >}}
### Can I keep my data safe and always available?
Redis Enterprise Software offers a comprehensive suite of
high-availability provisions, including in-memory replication,
persistent storage, and backups.
{{< /expand>}}

{{< expand "What do you mean by the term shard?" >}}
### What do you mean by the term shard?

A shard is any type of provisioned Redis instance, such as a master
copy, slave copy, database shard that is part of a clustered database,
etc.
{{< /expand>}}

{{< expand "What client can I use to connect to the databases in Redis Enterprise?" >}}
Redis Enterprise works with all existing standard clients; it does not require you to use any special clients.
{{< /expand>}}
To learn more, see [Database clustering]({{<relref "rs/concepts/high-availability/clustering.md">}}).

### What client can I use to connect to the databases in Redis Enterprise Software

Redis Enterprise Software works with all existing standard clients; it does not require you to use any special clients.

To learn more, see [Develop with Redis clients]({{<relref "rs/references/client_references/">}}).

If you're already using open-source Redis, you can use existing Redis client and code, as they work directly against a Redis Software cluster. Simply point your existing standard Redis client and code
connection string to the new cluster and then scale as needed.

### What am I allowed to do with the trial version?

{{% expand "What am I allowed to do with the trial version?" %}}
You can use, experience and administer the full capabilities of Redis
Enterprise Software (RS), but you may not deploy it in a production
environment. In addition, the trial version allows a maximum of four
Enterprise Software, but you may not deploy it to a production
environment.

In addition, the trial version allows a maximum of four
shards and is limited to thirty (30) days of use after initial
installation on the first server in the cluster. After the thirty day
trial, the cluster shifts to read-only status. The free version does
not provide the same support options as the paid version. Finally, no
SLA is provided with the trial version. To continue operation of the
installation on the first server in the cluster.

After the thirty day
trial, the cluster shifts to read-only status.

The free version does
not provide the same support options as the paid version.

Finally, no
service level agreement (SLA) is provided with the trial version. To continue operation of the
cluster with full capabilities, you must purchase a [subscription
cluster key from Redis Labs](https://redislabs.com/pricing).
{{% /expand %}}

{{< expand "What are the RS payment schedule and terms?" >}}
Contact us at <sales@redislabs.com> to learn about RS pricing.
{{< /expand>}}
### What is the payment schedule and terms?

General information about pricing and terms are available on our [main website](https://redislabs.com/redis-enterprise-software/pricing/).

{{< expand "What client can I use to connect to the databases in Redis Enterprise Software?" >}}
RS works with any standard Redis client.
Use your existing Redis client and code, as they work directly against a
RS cluster. You point your existing standard Redis client and code
connection string at the RS cluster, then scale on the RS cluster as
you need.
{{< /expand>}}
{{< /expand-control >}}
For individual assistance, contact us at <sales@redislabs.com>.

## Technical capabilities

{{< expand-control >}}
{{< expand "How many Redis databases can I create and manage?" >}}
{{< embed-md "how-many-databases-software.md" >}}
{{< /expand >}}
### How many Redis databases can I create and manage?

The number of databases is unlimited. The limiting factors are the
available memory in the cluster and the number of shards in the
subscription.

Note that the impact of the specific database configuration on the
number of shards it consumes. For example:

- Enabling database replication, without enabling database clustering,
creates two shards: a primary (also called a _master_) shard and a replica shard.

- Enabling database clustering creates as many database shards as you
configure.

- Enabling both database replication and database clustering creates
double the number of database shards you configure.

### What happens when my database fills up?

{{% expand "What happens when my database fills up?" %}}
As explained in the open source [Redis FAQ](https://redis.io/topics/faq),
under "What happens if Redis runs out of memory?":
This is explained in the _What happens if Redis runs out of memory?_ question of the open source [Redis FAQ](https://redis.io/topics/faq):

<blockquote>...[you] can use the "maxmemory" option in the config file to put a
limit to the memory Redis can use. If this limit is reached Redis
Expand All @@ -79,9 +103,5 @@ accept read-only commands), or you can configure it to evict keys when
the max memory limit is reached in the case you are using Redis for
caching.</blockquote>

You can set the **maxmemory** value of each Redis Enterprise Software database in
the management UI using the **Memory limit** property, as well as
configure an eviction policy by setting it to any of the standard Redis
The Redis Enterprise Software admin console lets you set `maxmemory` by controlling the **Memory limit** property. You can also set the eviction policy by setting it to any of the standard Redis
behaviors, without interrupting database operations.
{{< /expand>}}
{{< /expand-control >}}

0 comments on commit 5ad045c

Please sign in to comment.