Skip to content

Commit

Permalink
Merge branch 'main' into DOC-2495
Browse files Browse the repository at this point in the history
  • Loading branch information
rrelledge committed May 8, 2024
2 parents 77f67eb + c4f4461 commit 50e2e82
Show file tree
Hide file tree
Showing 11 changed files with 239 additions and 32 deletions.
21 changes: 21 additions & 0 deletions content/develop/connect/insight/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,27 @@ With Redis Insight you can now also extend the core functionality by building yo

Redis Insight includes an opt-in telemetry system. This help us improve the developer experience of the app. We value your privacy; all collected data is anonymized.

## Log files

To get detailed information about errors in Redis Insight, you can review the log files with the `.log` extension in the appropriate location:

- **Docker**: In the `/data/logs` directory *inside the container*.
- **Mac**: In the `/Users/<your-username>/.redis-insight` directory.
- **Windows**: In the `C:\Users\<your-username>\.redis-insight` directory.
- **Linux**: In the `/home/<your-username>/.redis-insight` directory.

{{< note >}}
You can install Redis Insight on operating systems that are not officially supported, but it may not behave as expected.
{{< /note >}}

## Using behind a reverse proxy

When you configure Redis Insight to run behind a reverse proxy like [NGINX](https://www.nginx.com/):

- Because some requests can be long-running, it is recommended that the request timeout is set to over 30 seconds on the reverse proxy.
Redis Insight also allows you to manage its connection timeout, which is 30 seconds by default, on the form to manage the connection details.
- Hosting Redis Insight behind a prefix path (path-rewriting) is not supported.

## Feedback

To provide your feedback, [open a ticket in our Redis Insight repository](https://github.com/Redis-Insight/Redis-Insight/issues/new).
Expand Down
7 changes: 5 additions & 2 deletions content/operate/kubernetes/active-active/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ For versions 6.4.2 or earlier, this Active-Active setup method includes the foll

To create an Active-Active Redis Enterprise deployment for Kubernetes with these new features, first [prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}) then [create an Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}).

{{<note>}} If you are using a preview version of these features (operator version 6.4.2-4 or 6.4.2-5), you'll need to enable the Active-Active controller with the following steps. You need to do this only once per cluster. We recommend using the fully supported 6.4.2-6 version.
### Preview versions

If you are using a preview version of these features (operator version 6.4.2-4 or 6.4.2-5), you'll need to enable the Active-Active controller with the following steps. You need to do this only once per cluster. We recommend using the fully supported 6.4.2-6 version.

1. Download the custom resource definitions (CRDs) for the most recent release (6.4.2-4) from [redis-enterprise-k8s-docs Github](https://github.com/RedisLabs/redis-enterprise-k8s-docs/tree/master/crds).

Expand All @@ -60,13 +62,14 @@ To create an Active-Active Redis Enterprise deployment for Kubernetes with these
kubectl apply -f crds/reaadb_crd.yaml
kubectl apply -f crds/rerc_crd.yaml
```

1. Enable the Active-Active and remote cluster controllers on the operator ConfigMap.

```sh
kubectl patch cm operator-environment-config --type merge --patch "{\"data\": \
{\"ACTIVE_ACTIVE_DATABASE_CONTROLLER_ENABLED\":\"true\", \
\"REMOTE_CLUSTER_CONTROLLER_ENABLED\":\"true\"}}"
{{</note>}}
### REAADB custom resource
Expand Down
8 changes: 5 additions & 3 deletions content/operate/kubernetes/active-active/prepare-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ Next you'll [collect credentials](#collect-rec-credentials) for your participati

For a list of example values used throughout this article, see the [Example values](#example-values) section.

{{<note>}} If you are using a preview version of these features (operator version 6.4.2-4 or 6.4.2-5), you'll need to enable the Active-Active controller with the following steps. You need to do this only once per cluster. We recommend using the fully supported 6.4.2-6 version.
### Preview versions

If you are using a preview version of these features (operator version 6.4.2-4 or 6.4.2-5), you'll need to enable the Active-Active controller with the following steps. You need to do this only once per cluster. We recommend using the fully supported 6.4.2-6 version.

1. Download the custom resource definitions (CRDs) for the most recent release (6.4.2-4) from [redis-enterprise-k8s-docs Github](https://github.com/RedisLabs/redis-enterprise-k8s-docs/tree/master/crds).

Expand All @@ -41,14 +43,14 @@ For a list of example values used throughout this article, see the [Example valu
kubectl apply -f crds/reaadb_crd.yaml
kubectl apply -f crds/rerc_crd.yaml
```

1. Enable the Active-Active and remote cluster controllers on the operator ConfigMap.

```sh
kubectl patch cm operator-environment-config --type merge --patch "{\"data\": \
{\"ACTIVE_ACTIVE_DATABASE_CONTROLLER_ENABLED\":\"true\", \
\"REMOTE_CLUSTER_CONTROLLER_ENABLED\":\"true\"}}"
{{</note>}}
## Collect REC credentials
To communicate with other clusters, all participating clusters will need access to the admin credentials for all other clusters.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Replication can affect performance as traffic increases to synchronize all copie

For both Redis Cloud Essentials and Redis Cloud Pro, replication doubles the dataset size you need for your database.

For Redis Cloud Essentials, the size of the plan you choose includes replication. Therefore, if you choose replication, the dataset size you can use is half of the stated plan size. For example, if you choose a 1GB plan, Redis allocates 512 GB for the memory limit, and the other 512 MB for Replication.
For Redis Cloud Essentials, the size of the plan you choose includes replication. Therefore, if you choose replication, the dataset size you can use is half of the stated plan size. For example, if you choose a 1GB plan, Redis allocates 512 MB for the dataset size, and the other 512 MB for replication.

For Redis Cloud Pro, you also need to double the amount of memory needed if you choose replication.

Expand Down
4 changes: 4 additions & 0 deletions content/operate/rc/security/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Secure access to the Redis Cloud console by:

- Enabling [SAML SSO]({{< relref "/operate/rc/security/access-control/saml-sso" >}}).

{{< note >}}
A user session on Redis Cloud expires after 30 minutes. You'll be signed out of Redis Cloud after 30 minutes of inactivity.
{{< /note >}}

## Database security

You have several options when it comes to securing your Redis Cloud databases. For more information, see [Cloud database security]({{< relref "/operate/rc/security/database-security/" >}}). Options include:
Expand Down
160 changes: 160 additions & 0 deletions content/operate/redisinsight/install/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
---
categories:
- docs
- operate
- redisinsight
linkTitle: Configuration settings
title: Configuration settings
weight: 5
---
To configure Redis Insight with environment variables:

1. Follow the instructions to set environment variables for your operating system:

- [macOS](https://apple.stackexchange.com/a/106814)
- [Windows](https://www.architectryan.com/2018/08/31/how-to-change-environment-variables-on-windows-10/)
- [Linux](https://askubuntu.com/a/58828)
- [Docker](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)

1. Restart Redis Insight.

## Redis Insight environment variables

Use the following environment variables to configure Redis Insight:

### RIPORT

**Description:** Which port should Redis Insight listen on.

**Type:** Number

**Default:** `8001`

### RIHOST

**Description:** Which host should Redis Insight bind to.

**Type:** String

**Default:** `"0.0.0.0"` on Docker and `"127.0.0.1"` on Windows, macOS, and Linux.

### RIHOMEDIR

**Description:** Sets the storage directory where Redis Insight stores application data (such as local database, log files, and snapshot files).

**Type:** String

**Default:** `"~/.redisinsight"` on desktop, `"/db"` on Docker.

### RILOGDIR

**Description:** Sets the directory where Redis Insight stores application logs.

**Type:** String

**Default:** `"~/.redisinsight"` on desktop, `"/db"` on Docker.


### RILOGLEVEL

**Description:** Configures the log level of the application. Possible values are `"DEBUG"`, `"INFO"`, `"WARNING"`, `"ERROR`", and `"CRITICAL"`.

**Type:** String

**Default:** `"WARNING"`


### RITRUSTEDORIGINS

**Description:** Configures the trusted origins of the application.

**Type:** String

**Default:** `""`

**Examples:** `"https://my-website.com,https://my-another-website.com,http://my-third-website.com"`

### RIPROXYENABLE

**Description:** Enables Sub-path Proxy for the application.

**Type:** Bool

**Default:** `False`


### RIPROXYPATH

**Description:** Configures Sub-path Proxy path for the application.

**Type:** String

**Default:** `""`

**Examples:** `"/redisinsight"`, `"/myapp"`

### RIPROXYPREFIX

**Description:** Sets the Sub-path proxy prefix HTTP header field name for the application. The application uses the value from this HTTP header key as the proxy sub-path.

**Type:** String

**Default:** `"X-Forwarded-Prefix"`

**Examples:** `"X-Forwarded-Prefix"`, `"X-Forwarded-Path"`

### RIAUTHPROMPT

**Description:** Enables an authentication prompt that asks for authentication before opening an instance or when the user is idle.

**Type:** Bool

**Default:** `false`


### RIAUTHTIMER

**Description:** Idle timer value for the authentication prompt in minutes.

**Type:** Bool

**Default:** `30`


### REDISINSIGHT_PORT (DEPRECATED)

**Description:** Which port should Redis Insight listen on.

**Type:** Number

**Default:** `8001`

**Deprecated in:** `v1.9.0`

### REDISINSIGHT_HOST (DEPRECATED)

**Description:** Which host should Redis Insight bind to.

**Type:** String

**Default:** `"0.0.0.0"`

**Deprecated in:** `v1.9.0`

### REDISINSIGHT_HOME_DIR (DEPRECATED)

**Description:** Sets the storage directory where Redis Insight stores application data (such as local database, log files, and snapshot files).

**Type:** String

**Default:** `"~/.redisinsight"` on desktop, `"/db"` on docker.

**Deprecated in:** `v1.9.0`

### LOG_DIR (DEPRECATED)

**Description:** Sets the directory where Redis Insight stores application logs.

**Type:** String

**Default:** `"~/.redisinsight"` on desktop, `"/db"` on docker.
2 changes: 1 addition & 1 deletion content/operate/redisinsight/install/install-on-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ spec:
- /bin/sh
- '-c'
- |
chown -R 1001 /data
chown -R 1000 /data
resources: {}
volumeMounts:
- name: redisinsight
Expand Down
12 changes: 6 additions & 6 deletions layouts/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,28 +48,28 @@ <h1 class="text-5xl font-medium">{{ .Title }}</h1>
</button>
<div id="dropdown" class="hidden lg:block border-t border-opacity-50 border-redis-ink-900 text-redis-pen-800">
<ul class="p-6">
<li><a class="py-2 hover:underline hover:text-redis-pen-600" href='{{ .Scratch.Get "path" }}/commands'>Commands</a></li>
<li><a class="py-2 hover:underline hover:text-redis-pen-600">APIs</a></li>
<li><a class="py-2 hover:underline hover:text-redis-pen-600" href='{{ .Scratch.Get "path" }}/get-started'>Get started</a></li>
<li><a class="py-2 hover:underline hover:text-redis-pen-600" href='{{ .Scratch.Get "path" }}/develop'>Develop</a></li>
<li><a class="py-2 hover:underline hover:text-redis-pen-600" href='{{ .Scratch.Get "path" }}/integrate'>Integrate</a></li>
<li><a class="py-2 hover:underline hover:text-redis-pen-600" href='{{ .Scratch.Get "path" }}/operate'>Operate</a></li>
<li><a class="py-2 hover:underline hover:text-redis-pen-600" href='{{ .Scratch.Get "path" }}/commands'>Commands</a></li>
<li><a class="py-2 hover:underline hover:text-redis-pen-600">APIs</a></li>
</ul>
</div>
</div>
</nav>
<nav class="hidden lg:block w-full lg:w-64 z-40 h-full leading-7">
<div class="flex flex-col gap-4">
<div class="flex flex-col border border-redis-ink-900 border-opacity-50 rounded-md">
<a class="px-6 py-4 rounded-t-md hover:bg-redis-pen-200 text-redis-red-600" href='{{ .Scratch.Get "path" }}/commands'>Commands</a>
<a class="px-6 py-4 rounded-b-md hover:bg-redis-pen-200 border-t border-redis-ink-900 border-opacity-50" href='{{ .Scratch.Get "path" }}/apis'>APIs</a>
</div>
<a class="px-6 py-4 hover:bg-redis-pen-200 border border-redis-ink-900 border-opacity-50 rounded-md" href='{{ .Scratch.Get "path" }}/get-started'>Get started</a>
<div class="flex flex-col border border-redis-ink-900 border-opacity-50 rounded-md">
<a class="px-6 py-4 rounded-t-md hover:bg-redis-pen-200" href='{{ .Scratch.Get "path" }}/develop'>Develop</a>
<a class="px-6 py-4 hover:bg-redis-pen-200 border-y border-redis-ink-900 border-opacity-50" href='{{ .Scratch.Get "path" }}/integrate'>Integrate</a>
<a class="px-6 py-4 rounded-b-md hover:bg-redis-pen-200" href='{{ .Scratch.Get "path" }}/operate'>Operate</a>
</div>
<div class="flex flex-col border border-redis-ink-900 border-opacity-50 rounded-md">
<a class="px-6 py-4 rounded-t-md hover:bg-redis-pen-200 text-redis-red-600" href='{{ .Scratch.Get "path" }}/commands'>Commands</a>
<a class="px-6 py-4 rounded-b-md hover:bg-redis-pen-200 border-t border-redis-ink-900 border-opacity-50" href='{{ .Scratch.Get "path" }}/apis'>APIs</a>
</div>
</div>
</nav>
</div>
Expand Down
17 changes: 11 additions & 6 deletions layouts/partials/docs-nav-collapsed.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
<div class="md:block w-full md:w-96 h-fit md:h-full shrink-0 text-base font-mono font-normal py-6">
<nav class="w-full md:w-96 z-40 bg-white md:fixed md:pt-6 h-fit md:h-full max-h-[calc(100vh-7rem)] leading-7">
{{ $navRoot := cond (eq .Site.Home.Type "docs") .Site.Home .FirstSection -}}
{{ if in (slice "Commands" "Integrate") $navRoot.LinkTitle }}
<div id="sidebar" class="max-h-[calc(100vh-8rem)] border border-opacity-50 border-redis-ink-900 rounded-md flex flex-col mt-4">
<a class='px-6 py-4 rounded-t-md hover:bg-redis-pen-200 text-redis-red-600 {{ if eq $navRoot.LinkTitle "Commands" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/commands'>Commands</a>
<a class='px-6 py-4 rounded-b-md hover:bg-redis-pen-200 border-t border-redis-ink-900 border-opacity-50 {{ if eq $navRoot.LinkTitle "APIs" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/apis'>APIs</a>
</div>
<div id="sidebar" class="max-h-[calc(100vh-8rem)] border border-opacity-50 border-redis-ink-900 rounded-md flex flex-col mt-4">
<a class='px-6 py-4 rounded-md hover:bg-redis-pen-200 {{ if eq $navRoot.LinkTitle "Get started" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/get-started'>Get started</a>
</div>
{{ end }}
<div style="height: 20px;"></div> <!-- This is the spacer -->
<div id="sidebar" class="max-h-[calc(100vh-8rem)] border border-opacity-50 border-redis-ink-900 rounded-md flex flex-col">
{{ if in (slice "Develop" "Integrate" "Operate" "Commands") $navRoot.LinkTitle }}
<a class='px-6 py-4 rounded-t-md hover:bg-redis-pen-200 {{ if eq $navRoot.LinkTitle "Develop" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/develop'>Develop</a>
Expand All @@ -9,12 +19,7 @@
{{ else }}
<a class='px-6 py-4 rounded-t-md hover:bg-redis-pen-200 font-bold' href="{{ $navRoot.RelPermalink }}">{{ $navRoot.LinkTitle }}</a>
<div class="hidden md:block w-full py-6"></div>
{{ end }}
</div>
{{ if in (slice "Commands" "Integrate") $navRoot.LinkTitle }}
<div id="sidebar-cmd" class="max-h-[calc(100vh-8rem)] border border-opacity-50 border-redis-ink-900 rounded-md flex flex-col mt-4">
<a class='px-6 py-4 hover:bg-redis-pen-200 text-redis-red-600 {{ if eq $navRoot.LinkTitle "Commands" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/commands'>Commands</a>
</div>
{{ end }}
{{ end }}
</nav>
</div>
29 changes: 22 additions & 7 deletions layouts/partials/docs-nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,28 @@
{{ $navRoot := cond (eq .Site.Home.Type "docs") .Site.Home .FirstSection -}}
{{ $ulNr := 0 -}}
{{ $ulShow := 1 -}}
<div class='min-h-0 border border-opacity-50 border-redis-ink-900 rounded-md flex flex-col {{ if not (eq $navRoot.LinkTitle "Commands") }} shrink-0 {{ end }}'>
<a class='px-6 py-4 rounded-t-md hover:bg-redis-pen-200 text-redis-red-600 {{ if eq $navRoot.LinkTitle "Commands" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/commands'>Commands</a>
{{ if eq $navRoot.LinkTitle "Commands" }}
<ul class="md:block overflow-y-auto grow pr-6 border-t border-opacity-50 border-redis-ink-900">
{{ template "li" (dict "page" . "pages" (union $navRoot.Pages $navRoot.Sections).ByWeight) }}
</ul>
{{ end }}
<a class='px-6 py-4 rounded-b-md hover:bg-redis-pen-200 border-t border-redis-ink-900 border-opacity-50 {{ if eq $navRoot.LinkTitle "APIs" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/apis'>APIs</a>
{{ if eq $navRoot.LinkTitle "APIs" }}
<ul class="md:block overflow-y-auto grow pr-6">
{{ template "li" (dict "page" . "pages" (union $navRoot.Pages $navRoot.Sections).ByWeight) }}
</ul>
{{ end }}
</div>
<div class='min-h-0 border border-opacity-50 border-redis-ink-900 rounded-md flex flex-col {{ if not (eq $navRoot.LinkTitle "Get started") }} shrink-0 {{ end }}'>
<a class='px-6 py-4 rounded-md hover:bg-redis-pen-200 {{ if eq $navRoot.LinkTitle "Get started" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/get-started'>Get started</a>
{{ if eq $navRoot.LinkTitle "Get started" }}
<ul class="md:block overflow-y-auto grow pr-6">
{{ template "li" (dict "page" . "pages" (union $navRoot.Pages $navRoot.Sections).ByWeight) }}
</ul>
{{ end }}
</div>
<div class='min-h-0 border border-opacity-50 border-redis-ink-900 rounded-md flex flex-col {{ if not (in (slice "Develop" "Integrate" "Operate") $navRoot.LinkTitle) }} shrink-0 {{ end }}'>
<a class='px-6 py-4 rounded-t-md hover:bg-redis-pen-200 {{ if eq $navRoot.LinkTitle "Develop" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/develop'>Develop</a>
{{ if eq $navRoot.LinkTitle "Develop" }}
Expand All @@ -61,13 +83,6 @@
</ul>
{{ end }}
</div>
<div class='min-h-0 border border-opacity-50 border-redis-ink-900 rounded-md flex flex-col {{ if not (eq $navRoot.LinkTitle "Commands") }} shrink-0 {{ end }}'>
<a class='px-6 py-4 hover:bg-redis-pen-200 text-redis-red-600 {{ if eq $navRoot.LinkTitle "Commands" }} font-bold {{ end }}' href='{{ .Scratch.Get "path" }}/commands'>Commands</a>
{{ if eq $navRoot.LinkTitle "Commands" }}
<ul class="md:block overflow-y-auto grow pr-6 border-t border-opacity-50 border-redis-ink-900">
{{ template "li" (dict "page" . "pages" (union $navRoot.Pages $navRoot.Sections).ByWeight) }}
</ul>
{{ end }}
</div>
</div>
</nav>
Expand Down
Loading

0 comments on commit 50e2e82

Please sign in to comment.