url
stringlengths 38
157
| content
stringlengths 72
15.1M
|
|---|---|
https://redis.io/docs/latest/commands/ts.madd/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TS.MADD
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TS.MADD {key timestamp value}...
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/timeseries">
TimeSeries 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N*M) when N is the amount of series updated and M is the amount of compaction rules or O(N) with no compaction
</dd>
</dl>
<p>
Append new samples to one or more time series
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is the key name for the time series.
</p>
</details>
<details open="">
<summary>
<code>
timestamp
</code>
</summary>
<p>
is Unix time (integer, in milliseconds) specifying the sample timestamp or
<code>
*
</code>
to set the sample timestamp to the Unix time of the server's clock.
</p>
<p>
Unix time is the number of milliseconds that have elapsed since 00:00:00 UTC on 1 January 1970, the Unix epoch, without adjustments made due to leap seconds.
</p>
</details>
<details open="">
<summary>
<code>
value
</code>
</summary>
<p>
is numeric data value of the sample (double). The double number should follow
<a href="https://tools.ietf.org/html/rfc7159">
RFC 7159
</a>
(a JSON standard). The parser rejects overly large values that would not fit in binary64. It does not accept NaN or infinite values.
</p>
</details>
<p>
<note>
<b>
Notes:
</b>
</note>
</p>
<ul>
<li>
If
<code>
timestamp
</code>
is older than the retention period compared to the maximum existing timestamp, the sample is discarded and an error is returned.
</li>
<li>
Explicitly adding samples to a compacted time series (using
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</code>
</a>
,
<code>
TS.MADD
</code>
,
<a href="/docs/latest/commands/ts.incrby/">
<code>
TS.INCRBY
</code>
</a>
, or
<a href="/docs/latest/commands/ts.decrby/">
<code>
TS.DECRBY
</code>
</a>
) may result in inconsistencies between the raw and the compacted data. The compaction process may override such samples.
</li>
<li>
<code>
ignoreMaxTimeDiff
</code>
and
<code>
ignoreMaxValDiff
</code>
cannot be specified as is the case with
<code>
TS.ADD
</code>
. However, the same logic still applies based on the values of the per-key configuration parameters. See the
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</code>
</a>
command page for more information.
</li>
</ul>
<h2 id="return-value">
Return value
</h2>
<p>
Returns one of these replies:
</p>
<ul>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
, where each element is an
<a href="/docs/latest/develop/reference/protocol-spec/#integers">
Integer reply
</a>
representing the timestamp of a upserted sample or an [] (when duplication policy is
<code>
BLOCK
</code>
, or when
<code>
timestamp
</code>
is older than the retention period compared to the maximum existing timestamp). For each element that is ignored (see
<code>
IGNORE
</code>
in
<a href="/docs/latest/commands/ts.create/">
<code>
TS.CREATE
</code>
</a>
), the reply element value will be the largest timestamp in the time series.
</li>
<li>
[] (invalid arguments, wrong key type, etc.)
</li>
</ul>
<h2 id="complexity">
Complexity
</h2>
<p>
If a compaction rule exits on a time series, TS.MADD performance might be reduced.
The complexity of TS.MADD is always
<code>
O(N*M)
</code>
, where
<code>
N
</code>
is the amount of series updated and
<code>
M
</code>
is the number of compaction rules or
<code>
O(N)
</code>
with no compaction.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Add stock prices at different timestamps
</b>
</summary>
<p>
Create two stocks and add their prices at three different timestamps.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE stock:A LABELS <span class="nb">type</span> stock name A
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE stock:B LABELS <span class="nb">type</span> stock name B
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">1000</span> <span class="m">100</span> stock:A <span class="m">1010</span> <span class="m">110</span> stock:A <span class="m">1020</span> <span class="m">120</span> stock:B <span class="m">1000</span> <span class="m">120</span> stock:B <span class="m">1010</span> <span class="m">110</span> stock:B <span class="m">1020</span> <span class="m">100</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ts.mrange/">
<code>
TS.MRANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.range/">
<code>
TS.RANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.mrevrange/">
<code>
TS.MREVRANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.revrange/">
<code>
TS.REVRANGE
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/data-types/timeseries/">
RedisTimeSeries
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ts.madd/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/clients/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Connect with Redis client API libraries
</h1>
<p class="text-lg -mt-5 mb-10">
Connect your application to a Redis database and try an example
</p>
<p>
Use the Redis client libraries to connect to Redis servers from
your own code. We document the following client libraries
for six main languages:
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
Language
</th>
<th style="text-align:left">
Client name
</th>
<th style="text-align:left">
Docs
</th>
<th style="text-align:left">
Supported
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="https://www.python.org/">
Python
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/redis/redis-py">
<code>
redis-py
</code>
</a>
</td>
<td style="text-align:left">
<a href="/docs/latest/develop/clients/redis-py/">
<code>
redis-py
</code>
guide
</a>
</td>
<td style="text-align:left">
Yes
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://www.python.org/">
Python
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/redis/redis-vl-python">
<code>
RedisVL
</code>
</a>
</td>
<td style="text-align:left">
<a href="/docs/latest/integrate/redisvl/">
RedisVL guide
</a>
</td>
<td style="text-align:left">
Yes
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://learn.microsoft.com/en-us/dotnet/csharp/">
C#/.NET
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/redis/NRedisStack">
<code>
NRedisStack
</code>
</a>
</td>
<td style="text-align:left">
<a href="/docs/latest/develop/clients/dotnet/">
<code>
NRedisStack
</code>
guide
</a>
</td>
<td style="text-align:left">
Yes
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://nodejs.org/en">
JavaScript
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/redis/node-redis">
<code>
node-redis
</code>
</a>
</td>
<td style="text-align:left">
<a href="/docs/latest/develop/clients/nodejs/">
<code>
node-redis
</code>
guide
</a>
</td>
<td style="text-align:left">
Yes
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://www.java.com/en/">
Java
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/redis/jedis">
<code>
Jedis
</code>
</a>
</td>
<td style="text-align:left">
<a href="/docs/latest/develop/clients/jedis/">
<code>
Jedis
</code>
guide
</a>
</td>
<td style="text-align:left">
Yes
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://www.java.com/en/">
Java
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/redis/lettuce">
<code>
Lettuce
</code>
</a>
</td>
<td style="text-align:left">
<a href="/docs/latest/develop/clients/lettuce/">
<code>
Lettuce
</code>
guide
</a>
</td>
<td style="text-align:left">
Yes
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://go.dev/">
Go
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/redis/go-redis">
<code>
go-redis
</code>
</a>
</td>
<td style="text-align:left">
<a href="/docs/latest/develop/clients/go/">
<code>
go-redis
</code>
guide
</a>
</td>
<td style="text-align:left">
Yes
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://www.php.net/">
PHP
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/predis/predis">
<code>
Predis
</code>
</a>
</td>
<td style="text-align:left">
<a href="/docs/latest/develop/clients/php/">
<code>
Predis
</code>
guide
</a>
</td>
<td style="text-align:left">
No
</td>
</tr>
</tbody>
</table>
<p>
We also provide several higher-level
<a href="/docs/latest/develop/clients/om-clients/">
object mapping (OM)
</a>
libraries for
<a href="/docs/latest/integrate/redisom-for-python/">
Python
</a>
,
<a href="/docs/latest/integrate/redisom-for-net/">
C#/.NET
</a>
,
<a href="/docs/latest/integrate/redisom-for-node-js/">
Node.js
</a>
, and
<a href="/docs/latest/integrate/redisom-for-java/">
Java/Spring
</a>
.
</p>
<h2 id="community-supported-clients">
Community-supported clients
</h2>
<p>
The table below shows the recommended third-party client libraries for languages that
Redis does not document directly:
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
Language
</th>
<th style="text-align:left">
Client name
</th>
<th style="text-align:left">
Github
</th>
<th style="text-align:left">
Docs
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
C
</td>
<td style="text-align:left">
hiredis
</td>
<td style="text-align:left">
<a href="https://github.com/redis/hiredis">
https://github.com/redis/hiredis
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/redis/hiredis">
https://github.com/redis/hiredis
</a>
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://www.php.net/">
PHP
</a>
</td>
<td style="text-align:left">
PhpRedis extension
</td>
<td style="text-align:left">
<a href="https://github.com/phpredis/phpredis">
https://github.com/phpredis/phpredis
</a>
</td>
<td style="text-align:left">
<a href="https://github.com/phpredis/phpredis/blob/develop/README.md">
https://github.com/phpredis/phpredis/blob/develop/README.md
</a>
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://www.ruby-lang.org/en/">
Ruby
</a>
</td>
<td style="text-align:left">
redis-rb
</td>
<td style="text-align:left">
<a href="https://github.com/redis/redis-rb">
https://github.com/redis/redis-rb
</a>
</td>
<td style="text-align:left">
<a href="https://rubydoc.info/gems/redis">
https://rubydoc.info/gems/redis
</a>
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://www.rust-lang.org/">
Rust
</a>
</td>
<td style="text-align:left">
redis-rs
</td>
<td style="text-align:left">
<a href="https://github.com/redis-rs/redis-rs">
https://github.com/redis-rs/redis-rs
</a>
</td>
<td style="text-align:left">
<a href="https://docs.rs/redis/latest/redis/">
https://docs.rs/redis/latest/redis/
</a>
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="https://en.wikipedia.org/wiki/C%2B%2B">
C++
</a>
</td>
<td style="text-align:left">
Boost.Redis
</td>
<td style="text-align:left">
<a href="https://github.com/boostorg/redis">
https://github.com/boostorg/redis
</a>
</td>
<td style="text-align:left">
<a href="https://www.boost.org/doc/libs/develop/libs/redis/doc/html/index.html">
https://www.boost.org/doc/libs/develop/libs/redis/doc/html/index.html
</a>
</td>
</tr>
</tbody>
</table>
<h2 id="requirements">
Requirements
</h2>
<p>
You will need access to a Redis server to use these libraries.
You can experiment with a local installation of Redis Stack
(see
<a href="/docs/latest/operate/oss_and_stack/install/install-stack/">
Install Redis Stack
</a>
) or with a free trial of
<a href="/docs/latest/operate/rc/">
Redis Cloud
</a>
.
To interact with a Redis server without writing code, use the
<a href="/docs/latest/develop/tools/cli/">
Redis CLI
</a>
and
<a href="/docs/latest/develop/tools/insight/">
Redis Insight
</a>
tools.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/clients/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/cluster-delslotsrange/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CLUSTER DELSLOTSRANGE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CLUSTER DELSLOTSRANGE start-slot end-slot [start-slot end-slot ...]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
7.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the total number of the slots between the start slot and end slot arguments.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@admin
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@dangerous
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
The
<code>
CLUSTER DELSLOTSRANGE
</code>
command is similar to the
<a href="/docs/latest/commands/cluster-delslots/">
<code>
CLUSTER DELSLOTS
</code>
</a>
command in that they both remove hash slots from the node.
The difference is that
<a href="/docs/latest/commands/cluster-delslots/">
<code>
CLUSTER DELSLOTS
</code>
</a>
takes a list of hash slots to remove from the node, while
<code>
CLUSTER DELSLOTSRANGE
</code>
takes a list of slot ranges (specified by start and end slots) to remove from the node.
</p>
<h2 id="example">
Example
</h2>
<p>
To remove slots 1 2 3 4 5 from the node, the
<a href="/docs/latest/commands/cluster-delslots/">
<code>
CLUSTER DELSLOTS
</code>
</a>
command is:
</p>
<pre><code>> CLUSTER DELSLOTS 1 2 3 4 5
OK
</code></pre>
<p>
The same operation can be completed with the following
<code>
CLUSTER DELSLOTSRANGE
</code>
command:
</p>
<pre><code>> CLUSTER DELSLOTSRANGE 1 5
OK
</code></pre>
<p>
However, note that:
</p>
<ol>
<li>
The command only works if all the specified slots are already associated with the node.
</li>
<li>
The command fails if the same slot is specified multiple times.
</li>
<li>
As a side effect of the command execution, the node may go into
<em>
down
</em>
state because not all hash slots are covered.
</li>
</ol>
<h2 id="usage-in-redis-cluster">
Usage in Redis Cluster
</h2>
<p>
This command only works in cluster mode and may be useful for
debugging and in order to manually orchestrate a cluster configuration
when a new cluster is created. It is currently not used by
<code>
redis-cli
</code>
,
and mainly exists for API completeness.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
if the command was successful. Otherwise an error is returned.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/cluster-delslotsrange/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/client-id/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CLIENT ID
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CLIENT ID</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
5.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@connection
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
The command just returns the ID of the current connection. Every connection
ID has certain guarantees:
</p>
<ol>
<li>
It is never repeated, so if
<code>
CLIENT ID
</code>
returns the same number, the caller can be sure that the underlying client did not disconnect and reconnect the connection, but it is still the same connection.
</li>
<li>
The ID is monotonically incremental. If the ID of a connection is greater than the ID of another connection, it is guaranteed that the second connection was established with the server at a later time.
</li>
</ol>
<p>
This command is especially useful together with
<a href="/docs/latest/commands/client-unblock/">
<code>
CLIENT UNBLOCK
</code>
</a>
which was
introduced also in Redis 5 together with
<code>
CLIENT ID
</code>
. Check the
<a href="/docs/latest/commands/client-unblock/">
<code>
CLIENT UNBLOCK
</code>
</a>
command page for a pattern involving the two commands.
</p>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> CLIENT ID
(integer) 820342
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: the ID of the client.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/client-id/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Migrate to role-based LDAP
</h1>
<p class="text-lg -mt-5 mb-10">
Describes how to migrate existing cluster-based LDAP deployments to role-based LDAP.
</p>
<p>
Redis Enterprise Software supports LDAP through a
<a href="/docs/latest/operate/rs/7.4/security/access-control/ldap/">
role-based mechanism
</a>
, first introduced
<a href="/docs/latest/operate/rs/release-notes/rs-6-0-20-april-2021/">
in v6.0.20
</a>
.
</p>
<p>
Earlier versions of Redis Enterprise Software supported a cluster-based mechanism; however, that mechanism was removed in v6.2.12.
</p>
<p>
If you're using the cluster-based mechanism to enable LDAP authentication, you need to migrate to the role-based mechanism before upgrading to Redis Enterprise Software v6.2.12 or later.
</p>
<h2 id="migration-checklist">
Migration checklist
</h2>
<p>
This checklist covers the basic process:
</p>
<ol>
<li>
<p>
Identify accounts per app on the customer end.
</p>
</li>
<li>
<p>
Create or identify an LDAP user account on the server that is responsible for LDAP authentication and authorization.
</p>
</li>
<li>
<p>
Create or identify an LDAP group that contains the app team members.
</p>
</li>
<li>
<p>
Verify or configure the Redis Enterprise ACLs.
</p>
</li>
<li>
<p>
Configure each database ACL.
</p>
</li>
<li>
<p>
Remove the earlier "external" (LDAP) users from Redis Enterprise.
</p>
</li>
<li>
<p>
<em>
(Recommended)
</em>
Update cluster configuration to replace the cluster-based configuration file.
</p>
<p>
You can use
<code>
rladmin
</code>
to update the cluster configuration:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">$ touch /tmp/saslauthd_empty.conf
</span></span><span class="line"><span class="cl">$ rladmin cluster config saslauthd_ldap_conf <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> /tmp/saslauthd_empty.conf
</span></span></code></pre>
</div>
<p>
Here, a blank file replaces the earlier configuration.
</p>
</li>
<li>
<p>
Use
<strong>
Access Control > LDAP > Configuration
</strong>
to enable role-based LDAP.
</p>
</li>
<li>
<p>
Map your LDAP groups to access control roles.
</p>
</li>
<li>
<p>
Test application connectivity using the LDAP credentials of an app team member.
</p>
</li>
<li>
<p>
<em>
(Recommended)
</em>
Turn off default access for the database to avoid anonymous client connections.
</p>
</li>
</ol>
<p>
Because deployments and requirements vary, you’ll likely need to adjust these guidelines.
</p>
<h2 id="test-ldap-access">
Test LDAP access
</h2>
<p>
To test your LDAP integration, you can:
</p>
<ul>
<li>
<p>
Connect with
<code>
redis-cli
</code>
and use the
<a href="/docs/latest/commands/auth/">
<code>
AUTH
</code>
command
</a>
to test LDAP username/password credentials.
</p>
</li>
<li>
<p>
Sign in to the Cluster Manager UI using LDAP credentials authorized for admin access.
</p>
</li>
<li>
<p>
Use
<a href="/docs/latest/develop/tools/insight/">
Redis Insight
</a>
to access a database using authorized LDAP credentials.
</p>
</li>
<li>
<p>
Use the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/">
REST API
</a>
to connect using authorized LDAP credentials.
</p>
</li>
</ul>
<h2 id="more-info">
More info
</h2>
<ul>
<li>
Enable and configure
<a href="/docs/latest/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap/">
role-based LDAP
</a>
</li>
<li>
Map LDAP groups to
<a href="/docs/latest/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles/">
access control roles
</a>
</li>
<li>
Update database ACLs to
<a href="/docs/latest/operate/rs/7.4/security/access-control/ldap/update-database-acls/">
authorize LDAP access
</a>
</li>
<li>
Learn more about Redis Enterprise Software
<a href="/docs/latest/operate/rs/7.4/security/">
security and practices
</a>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/databases/configure/proxy-policy/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Configure proxy policy
</h1>
<p>
Redis Enterprise Software (RS) provides high-performance data access
through a proxy process that manages and optimizes access to shards
within the RS cluster. Each node contains a single proxy process.
Each proxy can be active and take incoming traffic or it can be passive
and wait for failovers.
</p>
<h2 id="proxy-policies">
Proxy policies
</h2>
<p>
A database can have one of these proxy policies:
</p>
<table>
<thead>
<tr>
<th>
<strong>
Proxy policy
</strong>
</th>
<th>
<strong>
Description
</strong>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Single
</td>
<td>
There is only a single proxy that is bound to the database. This is the default database configuration and preferable in most use cases.
</td>
</tr>
<tr>
<td>
All primary shards
</td>
<td>
There are multiple proxies that are bound to the database, one on each node that hosts a database primary shard. This mode fits most use cases that require multiple proxies.
</td>
</tr>
<tr>
<td>
All nodes
</td>
<td>
There are multiple proxies that are bound to the database, one on each node in the cluster, regardless of whether or not there is a shard from this database on the node. This mode should be used only in special cases, such as
<a href="/docs/latest/operate/rs/networking/cluster-lba-setup/">
using a load balancer
</a>
.
</td>
</tr>
</tbody>
</table>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Manual intervention is also available via the rladmin bind add and
remove commands.
</div>
</div>
<h2 id="database-configuration">
Database configuration
</h2>
<p>
A database can be configured with a proxy policy using rladmin bind.
</p>
<p>
Warning: Any configuration update which causes existing proxies to be
unbounded can cause existing client connections to get disconnected.
</p>
<p>
You can run rladmin to control and view the existing settings for proxy
configuration.
</p>
<p>
The
<strong>
info
</strong>
command on cluster returns the existing proxy policy for
sharded and non-sharded (single shard) databases.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin info cluster
</span></span><span class="line"><span class="cl">cluster configuration:
</span></span><span class="line"><span class="cl"> repl_diskless: enabled
</span></span><span class="line"><span class="cl"> default_non_sharded_proxy_policy: single
</span></span><span class="line"><span class="cl"> default_sharded_proxy_policy: single
</span></span><span class="line"><span class="cl"> default_shards_placement: dense
</span></span><span class="line"><span class="cl"> default_shards_overbooking: disabled
</span></span><span class="line"><span class="cl"> default_fork_evict_ram: enabled
</span></span><span class="line"><span class="cl"> default_redis_version: 3.2
</span></span><span class="line"><span class="cl"> redis_migrate_node_threshold: 0KB <span class="o">(</span><span class="m">0</span> bytes<span class="o">)</span>
</span></span><span class="line"><span class="cl"> redis_migrate_node_threshold_percent: <span class="m">8</span> <span class="o">(</span>%<span class="o">)</span>
</span></span><span class="line"><span class="cl"> redis_provision_node_threshold: 0KB <span class="o">(</span><span class="m">0</span> bytes<span class="o">)</span>
</span></span><span class="line"><span class="cl"> redis_provision_node_threshold_percent: <span class="m">12</span> <span class="o">(</span>%<span class="o">)</span>
</span></span><span class="line"><span class="cl"> max_simultaneous_backups: <span class="m">4</span>
</span></span><span class="line"><span class="cl"> watchdog profile: local-network
</span></span></code></pre>
</div>
<p>
You can configure the proxy policy using the
<code>
bind
</code>
command in
rladmin. The following command is an example that changes the bind
policy for a database named "db1" with an endpoint id "1:1" to "All
primary shards" proxy policy.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">bind</span> db db1 endpoint 1:1 policy all-master-shards
</span></span></code></pre>
</div>
<p>
The next command performs the same task using the database id in place of the name. The id of this database is "1".
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">bind</span> db db:1 endpoint 1:1 policy all-master-shards
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
You can find the endpoint id for the endpoint argument by running
<em>
status
</em>
command for rladmin. Look for the endpoint id information under
the
<em>
ENDPOINT
</em>
section of the output.
</div>
</div>
<h3 id="reapply-policies-after-topology-changes">
Reapply policies after topology changes
</h3>
<p>
If you want to reapply the policy after topology changes, such as node restarts,
failovers and migrations, run this command to reset the policy:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">bind</span> db db:<ID> endpoint <endpoint id> policy <all-master-shards<span class="p">|</span>all-nodes>
</span></span></code></pre>
</div>
<p>
This is not required with single policies.
</p>
<h4 id="other-implications">
Other implications
</h4>
<p>
During the regular operation of the cluster different actions might take
place, such as automatic migration or automatic failover, which change
what proxy needs to be bound to what database. When such actions take
place the cluster attempts, as much as possible, to automatically change
proxy bindings to adhere to the defined policies. That said, the cluster
attempts to prevent any existing client connections from being
disconnected, and hence might not entirely enforce the policies. In such
cases, you can enforce the policy using the appropriate rladmin
commands.
</p>
<h2 id="about-multiple-active-proxy-support">
About multiple active proxy support
</h2>
<p>
RS allows multiple databases to be created. Each database gets an
endpoint (a unique URL and port on the FQDN). This endpoint receives all
the traffic for all operations for that database. By default, RS binds
this database endpoint to one of the proxies on a single node in the
cluster. This proxy becomes an active proxy and receives all the
operations for the given database. (note that if the node with the
active proxy fails, a new proxy on another node takes over as part of
the failover process automatically).
</p>
<p>
In most cases, a single proxy can handle a large number of operations
without consuming additional resources. However, under high load,
network bandwidth or a high rate of packets per second (PPS) on the
single active proxy can become a bottleneck to how fast database
operation can be performed. In such cases, having multiple active
proxies, across multiple nodes, mapped to the same external database
endpoint, can significantly improve throughput.
</p>
<p>
With the multiple active proxies capability, RS enables you to configure
a database to have multiple internal proxies in order to improve
performance, in some cases. It is important to note that, even though
multiple active proxies can help improve the throughput of database
operations, configuring multiple active proxies may cause additional
latency in operations as the shards and proxies are spread across
multiple nodes in the cluster.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
When the network on a single active proxy becomes the bottleneck,
you might also look into enabling the multiple NIC support in RS. With
nodes that have multiple physical NICs (Network Interface Cards), you
can configure RS to separate internal and external traffic onto
independent physical NICs. For more details, refer to
<a href="/docs/latest/operate/rs/networking/multi-ip-ipv6/">
Multi-IP &
IPv6
</a>
.
</div>
</div>
<p>
Having multiple proxies for a database can improve RS's ability for fast
failover in case of proxy and/or node failure. With multiple proxies for
a database, there is no need for a client to wait for the cluster
to spin up another proxy and a DNS change in most cases, the client
just uses the next IP in the list to connect to another proxy.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/databases/configure/proxy-policy/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/master/.html | <section class="prose w-full py-12 max-w-none">
<h1>
rladmin cluster master
</h1>
<p class="text-lg -mt-5 mb-10">
Identifies or changes the cluster's master node.
</p>
<p>
Identifies the cluster's master node. Use
<code>
set
</code>
to change the cluster's master to a different node.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">cluster master <span class="o">[</span> <span class="nb">set</span> <node_id> <span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
node_id
</td>
<td>
integer
</td>
<td>
Unique node ID
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns the ID of the cluster's master node. Otherwise, it returns an error message.
</p>
<h3 id="example">
Example
</h3>
<p>
Identify the cluster's master node:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin cluster master
</span></span><span class="line"><span class="cl">Node <span class="m">1</span> is the cluster master node
</span></span></code></pre>
</div>
<p>
Change the cluster master to node 3:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin cluster master <span class="nb">set</span> <span class="m">3</span>
</span></span><span class="line"><span class="cl">Node <span class="m">3</span> <span class="nb">set</span> to be the cluster master node
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/master/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/release-notes/legacy-release-notes/rlec-0-99-5-11-january-2015/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RLEC 0.99.5-11 Release Notes (January 5, 2015)
</h1>
<h3 id="new-features">
New features
</h3>
<p>
Initial release, everything is new!
</p>
<h3 id="changes">
Changes
</h3>
<p>
Initial release, no changes!
</p>
<h3 id="fixed-issues">
Fixed issues
</h3>
<p>
None.
</p>
<h3 id="known-issues">
Known issues
</h3>
<ul>
<li>
<strong>
Issue:
</strong>
When taking a node offline or removing a node, if the
node being taken offline or removed is currently serving as the web
server for the web browser being used to view the management UI, the
management UI appears down while the node is down.
<strong>
Workaround:
</strong>
If you are using the cluster name in order to
connect to the management UI in the browser, and the cluster name is
registered in your external DNS or you are using the mDNS option,
then the DNS entries will be updated to point to another node in the
cluster after a few seconds and the UI will open properly. If you
are not using the cluster name but rather the node IP in order to
connect to the management UI in the web browser, you have to use the
IP of another node in the cluster to access the management UI.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/release-notes/legacy-release-notes/rlec-0-99-5-11-january-2015/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/compatibility/commands/scripting/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Scripting commands compatibility
</h1>
<p class="text-lg -mt-5 mb-10">
Scripting and function commands compatibility.
</p>
<p>
The following table shows which Redis Community Edition
<a href="/docs/latest/commands/?group=scripting">
scripting and function commands
</a>
are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud.
</p>
<h2 id="function-commands">
Function commands
</h2>
<table>
<thead>
<tr>
<th style="text-align:left">
Command
</th>
<th style="text-align:left">
Redis
<br/>
Enterprise
</th>
<th style="text-align:left">
Redis
<br/>
Cloud
</th>
<th style="text-align:left">
Notes
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/fcall/">
FCALL
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/fcall_ro/">
FCALL_RO
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-delete/">
FUNCTION DELETE
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-dump/">
FUNCTION DUMP
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-flush/">
FUNCTION FLUSH
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-help/">
FUNCTION HELP
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-kill/">
FUNCTION KILL
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-list/">
FUNCTION LIST
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-load/">
FUNCTION LOAD
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-restore/">
FUNCTION RESTORE
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/function-stats/">
FUNCTION STATS
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
</tbody>
</table>
<h2 id="scripting-commands">
Scripting commands
</h2>
<table>
<thead>
<tr>
<th style="text-align:left">
Command
</th>
<th style="text-align:left">
Redis
<br/>
Enterprise
</th>
<th style="text-align:left">
Redis
<br/>
Cloud
</th>
<th style="text-align:left">
Notes
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/eval/">
EVAL
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/eval_ro/">
EVAL_RO
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/evalsha/">
EVALSHA
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/evalsha_ro/">
EVALSHA_RO
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-debug/">
SCRIPT DEBUG
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-exists/">
SCRIPT EXISTS
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-flush/">
SCRIPT FLUSH
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-kill/">
SCRIPT KILL
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/script-load/">
SCRIPT LOAD
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/compatibility/commands/scripting/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/security/access-control/multi-factor-authentication/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Multi-factor authentication
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Cloud supports multi-factor authentication to reduce the risk of unauthorized Redis Cloud console access.
</p>
<p>
To reduce the chances of unauthorized access, Redis Cloud allows users to enable multi-factor authentication (MFA).
</p>
<p>
When MFA is enabled, users must enter their username, password, and an authentication code when signing in. MFA requires a mobile device that can receive these authentication codes over text messaging. In addition, you may
<a href="#app">
use an authenticator app
</a>
such as
<a href="https://en.wikipedia.org/wiki/Google_Authenticator">
Google Authenticator
</a>
as one of your factors.
</p>
<p>
To further increase the security of the account, the account owner can
<a href="#enforcing">
require MFA enforcement for all users
</a>
.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Once you enable MFA, it will be required to access every account that belongs to you. Deactivating MFA enforcement on an account does not deactivate MFA enforcement for other users of that account that have defined a phone number. To deactivate MFA enforcement for other users, those users will each need to deactivate MFA enforcement for their own user accounts.
</div>
</div>
<h3 id="enable-mfa">
Enable MFA
</h3>
<p>
Each user can enable and configure MFA for their account.
The default MFA configuration sends an authentication code by text message that users must enter when they sign in.
</p>
<p>
To configure MFA for your user account:
</p>
<ol>
<li>
<p>
Sign in to your account.
</p>
</li>
<li>
<p>
From the Redis Cloud console menu, select your name and then
<strong>
User Profile
</strong>
from the drop down menu.
</p>
<a href="/docs/latest/images/rc/multi-factor-authentication-user-dropdown.png" sdata-lightbox="/images/rc/multi-factor-authentication-user-dropdown.png">
<img alt="Use the user drop down menu to get to the User Profile section." src="/docs/latest/images/rc/multi-factor-authentication-user-dropdown.png" width="300px"/>
</a>
</li>
<li>
<p>
Under your user profile, locate
<strong>
Multi-factor authentication
</strong>
.
</p>
<a href="/docs/latest/images/rc/multi-factor-authentication-user-profile.png" sdata-lightbox="/images/rc/multi-factor-authentication-user-profile.png">
<img alt="Multi-factor authentication is located on the user profile page." src="/docs/latest/images/rc/multi-factor-authentication-user-profile.png"/>
</a>
</li>
<li>
<p>
Enter your mobile phone number in the
<strong>
Text message
</strong>
box and then select
<strong>
Send code
</strong>
.
</p>
</li>
<li>
<p>
You will receive a confirmation code sent by text message. Enter the code when prompted by the Redis Cloud console and select
<strong>
Verify
</strong>
.
</p>
</li>
</ol>
<p>
Your account is now configured for MFA.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
We recommend that you also
<a href="#app">
configure MFA for an authenticator app
</a>
as an additional factor.
</div>
</div>
<p>
If you cannot sign in to your account because of MFA, please
<a href="https://redislabs.com/company/support/">
contact support
</a>
.
</p>
<p>
If your mobile phone is lost or stolen, make sure that you update the MFA configuration to prevent unauthorized sign-ins.
</p>
<h3 id="change-your-mfa-phone-number">
Change your MFA phone number
</h3>
<p>
To change the mobile phone number used for MFA:
</p>
<ol>
<li>
Navigate to the Multi-Factor authentication section in the
<strong>
User Profile
</strong>
.
</li>
<li>
Select
<strong>
Change number
</strong>
.
</li>
<li>
Enter the new mobile phone number, and complete the verification process as described above.
</li>
</ol>
<h3 id="app">
Configure MFA for an authenticator app
</h3>
<p>
After you configure MFA for text messages, you can also configure MFA to work with a time-based one-time password (TOTP) app such as
<a href="https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en_US&gl=US&pli=1">
Google Authenticator
</a>
.
</p>
<p>
When you sign in to the Redis Cloud console, you can select either an authentication code sent by text message or an authentication code shown in your authenticator app.
</p>
<p>
To configure MFA for an authenticator app:
</p>
<ol>
<li>
Install an authenticator app on your mobile phone.
</li>
<li>
Add Redis Cloud to the app:
<ol>
<li>
From the
<strong>
User Profile
</strong>
view in your Redis Cloud account, locate
<strong>
Multi-Factor Authentication
</strong>
.
</li>
<li>
Select
<strong>
Connect
</strong>
for the authenticator app. A QR code appears, requesting verification.
</li>
<li>
Scan the QR code using your phone's authenticator app.
</li>
<li>
Enter the code generated by your authenticator app to verify the setup.
</li>
</ol>
</li>
</ol>
<p>
You can now use either a text message code or an authenticator app code as your second factor when signing in.
</p>
<h4 id="deactivate-mfa">
Deactivate MFA
</h4>
<p>
You can deactivate MFA for your user account. To deactivate MFA, go to your profile, locate
<strong>
Multi-Factor Authentication
</strong>
, and select
<strong>
Deactivate
</strong>
.
</p>
<h3 id="enforcing">
Enforce MFA for all user accounts
</h3>
<p>
Account owner users can enable MFA enforcement for all users in their account.
After MFA is enforced for the account, all users who do not have MFA enabled will be required to configure MFA the next time they sign in to the Redis Cloud console.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Redis Cloud does not enforce MFA for
<a href="/docs/latest/operate/rc/security/access-control/saml-sso/">
SAML SSO
</a>
users since the identity provider handles MFA management and enforcement.
</div>
</div>
<p>
To enable MFA enforcement for all user accounts:
</p>
<ol>
<li>
<p>
Sign in as an account owner.
</p>
</li>
<li>
<p>
Go to
<strong>
Account Settings
</strong>
.
</p>
</li>
<li>
<p>
Under
<strong>
Security
</strong>
, switch the
<strong>
MFA environment
</strong>
toggle to
<em>
On
</em>
.
</p>
<a href="/docs/latest/images/rc/multi-factor-authentication-force-all-users-on.png" sdata-lightbox="/images/rc/multi-factor-authentication-force-all-users-on.png">
<img alt="Multi-factor authentication toggle for all users on." src="/docs/latest/images/rc/multi-factor-authentication-force-all-users-on.png"/>
</a>
</li>
</ol>
<ul>
<li>
When you enable MFA enforcement, users cannot disable MFA for their account.
</li>
<li>
When you disable MFA enforcement, users can disable MFA for their account.
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Tip:
</div>
Notify all of your Redis Cloud console users before enabling MFA enforcement.
</div>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/security/access-control/multi-factor-authentication/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|