iknow-lab/redis_manual_7_4_en · Datasets at Hugging Face

https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database/.html

<section class="prose w-full py-12 max-w-none"> <h1> Enable a module for a database </h1> Modules add additional functionality to Redis databases for specific use cases. You can enable modules when you create a database. <h2 id="prerequisites"> Prerequisites </h2> <ul> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster/"> Installed the module on the cluster </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module/"> Upgraded the module </a> to the latest version </li> </ul> <h2 id="create-a-database-with-a-module"> Create a database with a module </h2> <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 only add modules to a database when you first create it. You cannot add modules to an existing database. </div> </div> In the Redis Enterprise Cluster Manager UI, follow these steps to add modules to a database: <ol> <li> From the Databases screen, select Quick database or Create database . </li> <li> In the Capabilities section, select one or more capabilities: <a href="/docs/latest/images/rs/screenshots/databases/quick-db-capabilities-7-8-2.png" sdata-lightbox="/images/rs/screenshots/databases/quick-db-capabilities-7-8-2.png"> <img alt="Select which capabilities to add to your database." src="/docs/latest/images/rs/screenshots/databases/quick-db-capabilities-7-8-2.png"/> </a> <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 cannot use RediSearch 1.x and RediSearch 2.x in the same database. </div> </div> </li> <li> To use custom configuration for capabilities: <ol> <li> Select Parameters . </li> <li> Enter the <a href="#module-configuration-options"> configuration options </a> . </li> <li> Select Done . </li> </ol> </li> <li> Configure additional database settings. <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> Depending on the <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities/#module-feature-support"> features supported by an enabled module </a> , certain database configuration fields may not be available. </div> </div> </li> <li> Select Create . </li> </ol> <h2 id="module-configuration-options"> Module configuration options </h2> <ul> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/search/config/"> RediSearch configuration options </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/timeseries/config/"> RedisTimeSeries configuration options </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/bloom/config/"> RedisBloom configuration options </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/oss_and_stack/stack-with-enterprise/install/add-module-to-database/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/cli-utilities/rladmin/status/.html

<section class="prose w-full py-12 max-w-none"> <h1> rladmin status </h1> Displays the current cluster status and topology information. Displays the current cluster status and topology information. <h2 id="status"> <code> status </code> </h2> Displays the current status of all nodes, databases, database endpoints, and shards on the cluster. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin status [ extra <parameter> ] [ issues_only] </code></pre> </div> <h3 id="parameters"> Parameters </h3> <table> <thead> <tr> <th> Parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> extra <parameter> </td> <td> Extra options that show more information </td> </tr> <tr> <td> issues_only </td> <td> Filters out all items that have an <code> OK </code> status </td> </tr> </tbody> </table> <table> <thead> <tr> <th> Extra parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> extra all </td> <td> Shows all <code> extra </code> information </td> </tr> <tr> <td> extra backups </td> <td> Shows periodic backup status </td> </tr> <tr> <td> extra frag </td> <td> Shows fragmented memory available after the restart </td> </tr> <tr> <td> extra nodestats </td> <td> Shows shards per node </td> </tr> <tr> <td> extra rack_id </td> <td> Shows <code> rack_id </code> if customer is not <code> rack_aware </code> </td> </tr> <tr> <td> extra redis_version </td> <td> Shows Redis version of all databases in the cluster </td> </tr> <tr> <td> extra state_machine </td> <td> Shows execution of state machine information </td> </tr> <tr> <td> extra watchdog </td> <td> Shows watchdog status </td> </tr> </tbody> </table> <h3 id="returns"> Returns </h3> Returns tables of the status of all nodes, databases, and database endpoints on the cluster. If <code> issues_only </code> is specified, it only shows instances that do not have an <code> OK </code> status. <h3 id="example"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin status extra all CLUSTER: OK. Cluster master: 1 (198.51.100.2) Cluster health: OK, [1, 0.13333333333333333, 0.03333333333333333] failures/minute - avg1 1.00, avg15 0.13, avg60 0.03. CLUSTER NODES: NODE:ID ROLE ADDRESS EXTERNAL_ADDRESS HOSTNAME MASTERS SLAVES OVERBOOKING_DEPTH SHARDS CORES FREE_RAM PROVISIONAL_RAM VERSION SHA RACK-ID STATUS node:1 master 198.51.100.2 3d99db1fdf4b 4 0 10.91GB 4/100 6 14.91GB/19.54GB 10.91GB/16.02GB 6.2.12-37 5c2106 - OK node:2 slave 198.51.100.3 fc7a3d332458 0 0 11.4GB 0/100 6 14.91GB/19.54GB 11.4GB/16.02GB 6.2.12-37 5c2106 - OK *node:3 slave 198.51.100.4 b87cc06c830f 0 0 11.4GB 0/100 6 14.91GB/19.54GB 11.4GB/16.02GB 6.2.12-37 5c2106 - OK DATABASES: DB:ID NAME TYPE STATUS SHARDS PLACEMENT REPLICATION PERSISTENCE ENDPOINT EXEC_STATE EXEC_STATE_MACHINE BACKUP_PROGRESS MISSING_BACKUP_TIME REDIS_VERSION db:3 database3 redis active 4 dense disabled disabled redis-11103.cluster.local:11103 N/A N/A N/A N/A 6.0.16 ENDPOINTS: DB:ID NAME ID NODE ROLE SSL WATCHDOG_STATUS db:3 database3 endpoint:3:1 node:1 single No OK SHARDS: DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY BACKUP_PROGRESS RAM_FRAG WATCHDOG_STATUS STATUS db:3 database3 redis:4 node:1 master 0-4095 2.08MB N/A 4.73MB OK OK db:3 database3 redis:5 node:1 master 4096-8191 2.08MB N/A 4.62MB OK OK db:3 database3 redis:6 node:1 master 8192-12287 2.08MB N/A 4.59MB OK OK db:3 database3 redis:7 node:1 master 12288-16383 2.08MB N/A 4.66MB OK OK </code></pre> </div> <h2 id="status-databases"> <code> status databases </code> </h2> Displays the current status of all databases on the cluster. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin status databases [ extra <parameters> ] [ sort <column_titles> ] [ issues_only ] </code></pre> </div> <h3 id="parameters-1"> Parameters </h3> <table> <thead> <tr> <th> Parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> extra <parameter> </td> <td> Extra options that show more information </td> </tr> <tr> <td> sort <column_titles> </td> <td> Sort results by specified column titles </td> </tr> <tr> <td> issues_only </td> <td> Filters out all items that have an <code> OK </code> status </td> </tr> </tbody> </table> <table> <thead> <tr> <th> Extra parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> extra all </td> <td> Shows all <code> extra </code> information </td> </tr> <tr> <td> extra backups </td> <td> Shows periodic backup status </td> </tr> <tr> <td> extra frag </td> <td> Shows fragmented memory available after the restart </td> </tr> <tr> <td> extra nodestats </td> <td> Shows shards per node </td> </tr> <tr> <td> extra rack_id </td> <td> Shows <code> rack_id </code> if customer is not <code> rack_aware </code> </td> </tr> <tr> <td> extra redis_version </td> <td> Shows Redis version of all databases in the cluster </td> </tr> <tr> <td> extra state_machine </td> <td> Shows execution of state machine information </td> </tr> <tr> <td> extra watchdog </td> <td> Shows watchdog status </td> </tr> </tbody> </table> <h3 id="returns-1"> Returns </h3> Returns a table of the status of all databases on the cluster. If <code> sort <column_titles> </code> is specified, the result is sorted by the specified table columns. If <code> issues_only </code> is specified, it only shows databases that do not have an <code> OK </code> status. <h3 id="example-1"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin status databases sort REPLICATION PERSISTENCE DB:ID NAME TYPE STATUS SHARDS PLACEMENT REPLICATION PERSISTENCE ENDPOINT db:1 database1 redis active 1 dense disabled disabled redis-10269.testdbd11169.localhost:10269 db:2 database2 redis active 1 dense disabled snapshot redis-13897.testdbd11169.localhost:13897 db:3 database3 redis active 1 dense enabled snapshot redis-19416.testdbd13186.localhost:19416 </code></pre> </div> <h2 id="status-endpoints"> <code> status endpoints </code> </h2> Displays the current status of all endpoints on the cluster. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin status endpoints [ node <id> ] [ db { db:<id> | <name> } ] [ extra <parameters> ] [ sort <column_titles> ] [ issues_only ] </code></pre> </div> <h3 id="parameters-2"> Parameters </h3> <table> <thead> <tr> <th> Parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> node <id> </td> <td> Only show endpoints for the specified node ID </td> </tr> <tr> <td> db db:<id> </td> <td> Only show endpoints for the specified database ID </td> </tr> <tr> <td> db <name> </td> <td> Only show endpoints for the specified database name </td> </tr> <tr> <td> extra <parameter> </td> <td> Extra options that show more information </td> </tr> <tr> <td> sort <column_titles> </td> <td> Sort results by specified column titles </td> </tr> <tr> <td> issues_only </td> <td> Filters out all items that have an <code> OK </code> status </td> </tr> </tbody> </table> <table> <thead> <tr> <th> Extra parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> extra all </td> <td> Shows all <code> extra </code> information </td> </tr> <tr> <td> extra backups </td> <td> Shows periodic backup status </td> </tr> <tr> <td> extra frag </td> <td> Shows fragmented memory available after the restart </td> </tr> <tr> <td> extra nodestats </td> <td> Shows shards per node </td> </tr> <tr> <td> extra rack_id </td> <td> Shows <code> rack_id </code> if customer is not <code> rack_aware </code> </td> </tr> <tr> <td> extra redis_version </td> <td> Shows Redis version of all endpoints in the cluster </td> </tr> <tr> <td> extra state_machine </td> <td> Shows execution of state machine information </td> </tr> <tr> <td> extra watchdog </td> <td> Shows watchdog status </td> </tr> </tbody> </table> <h3 id="returns-2"> Returns </h3> Returns a table of the status of all endpoints on the cluster. If <code> sort <column_titles> </code> is specified, the result is sorted by the specified table columns. If <code> issues_only </code> is specified, it only shows endpoints that do not have an <code> OK </code> status. <h3 id="example-2"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin status endpoints DB:ID NAME ID NODE ROLE SSL db:1 database1 endpoint:1:1 node:1 single No db:2 database2 endpoint:2:1 node:2 single No db:3 database3 endpoint:3:1 node:3 single No </code></pre> </div> <h2 id="status-modules"> <code> status modules </code> </h2> Displays the current status of modules installed on the cluster and modules used by databases. This information is not included in the combined status report returned by <a href="#status"> <code> rladmin status </code> </a> . <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin status modules [ db { db:<id1> | <name1> } ... { db:<idN> | <nameN> } ] [ extra { all | min_redis_version | module_id } ] </code></pre> </div> <h3 id="parameters-3"> Parameters </h3> <table> <thead> <tr> <th> Parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> db db:<id> </td> <td> Provide a list of database IDs to show only modules used by the specified databases (for example: <code> rladmin status modules db db:1 db:2 </code> ) </td> </tr> <tr> <td> db <name> </td> <td> Provide a list of database names to show only modules used by the specified databases (for example: <code> rladmin status modules db name1 name2 </code> ) </td> </tr> <tr> <td> extra all </td> <td> Shows all extra information </td> </tr> <tr> <td> extra module_id </td> <td> Shows module IDs </td> </tr> <tr> <td> extra min_redis_version </td> <td> Shows the minimum compatible Redis database version for each module </td> </tr> </tbody> </table> <h3 id="returns-3"> Returns </h3> Returns the status of modules installed on the cluster and modules used by databases. <h3 id="example-3"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin status modules extra all CLUSTER MODULES: MODULE VERSION MIN_REDIS_VERSION ID RedisBloom 2.4.5 6.0 1b895a180592cbcae5bd3bff6af24be2 RedisBloom 2.6.8 7.1 95264e7c9ac9540268c115c86a94659b RediSearch 2 2.6.12 6.0 2c000539f65272f7a2712ed3662c2b6b RediSearch 2 2.8.9 7.1 dd9a75710db528afa691767e9310ac6f RedisGears 2.0.15 7.1 18c83d024b8ee22e7caf030862026ca6 RedisGraph 2.10.12 6.0 5a1f2fdedb8f6ca18f81371ea8d28f68 RedisJSON 2.4.7 6.0 28308b101a0203c21fa460e7eeb9344a RedisJSON 2.6.8 7.1 b631b6a863edde1b53b2f7a27a49c004 RedisTimeSeries 1.8.11 6.0 8fe09b00f56afe5dba160d234a6606af RedisTimeSeries 1.10.9 7.1 98a492a017ea6669a162fd3503bf31f3 DATABASE MODULES: DB:ID NAME MODULE VERSION ARGS STATUS db:1 search-json-db RediSearch 2 2.8.9 PARTITIONS AUTO OK db:1 search-json-db RedisJSON 2.6.8 OK db:2 timeseries-db RedisTimeSeries 1.10.9 OK </code></pre> </div> <h2 id="status-nodes"> <code> status nodes </code> </h2> Displays the current status of all nodes on the cluster. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin status nodes [ extra <parameters> ] [ sort <column_titles> ] [ issues_only ] </code></pre> </div> <h3 id="parameters-4"> Parameters </h3> <table> <thead> <tr> <th> Parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> extra <parameter> </td> <td> Extra options that show more information </td> </tr> <tr> <td> sort <column_titles> </td> <td> Sort results by specified column titles </td> </tr> <tr> <td> issues_only </td> <td> Filters out all items that have an <code> OK </code> status </td> </tr> </tbody> </table> <table> <thead> <tr> <th> Extra parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> extra all </td> <td> Shows all <code> extra </code> information </td> </tr> <tr> <td> extra backups </td> <td> Shows periodic backup status </td> </tr> <tr> <td> extra frag </td> <td> Shows fragmented memory available after the restart </td> </tr> <tr> <td> extra nodestats </td> <td> Shows shards per node </td> </tr> <tr> <td> extra rack_id </td> <td> Shows <code> rack_id </code> if customer is not <code> rack_aware </code> </td> </tr> <tr> <td> extra redis_version </td> <td> Shows Redis version of all nodes in the cluster </td> </tr> <tr> <td> extra state_machine </td> <td> Shows execution of state machine information </td> </tr> <tr> <td> extra watchdog </td> <td> Shows watchdog status </td> </tr> </tbody> </table> <h3 id="returns-4"> Returns </h3> Returns a table of the status of all nodes on the cluster. If <code> sort <column_titles> </code> is specified, the result is sorted by the specified table columns. If <code> issues_only </code> is specified, it only shows nodes that do not have an <code> OK </code> status. <h3 id="example-4"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin status nodes sort PROVISIONAL_RAM HOSTNAME CLUSTER NODES: NODE:ID ROLE ADDRESS EXTERNAL_ADDRESS HOSTNAME SHARDS CORES FREE_RAM PROVISIONAL_RAM VERSION STATUS node:1 master 198.51.100.2 3d99db1fdf4b 4/100 6 14.74GB/19.54GB 10.73GB/16.02GB 6.2.12-37 OK *node:3 slave 198.51.100.4 b87cc06c830f 0/100 6 14.74GB/19.54GB 11.22GB/16.02GB 6.2.12-37 OK node:2 slave 198.51.100.3 fc7a3d332458 0/100 6 14.74GB/19.54GB 11.22GB/16.02GB 6.2.12-37 OK </code></pre> </div> <h2 id="status-shards"> <code> status shards </code> </h2> Displays the current status of all shards on the cluster. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin status shards [ node <id> ] [ db {db:<id> | <name>} ] [ extra <parameters> ] [ sort <column_titles> ] [ issues_only ] </code></pre> </div> <h3 id="parameters-5"> Parameters </h3> <table> <thead> <tr> <th> Parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> node <id> </td> <td> Only show shards for the specified node ID </td> </tr> <tr> <td> db db:<id> </td> <td> Only show shards for the specified database ID </td> </tr> <tr> <td> db <name> </td> <td> Only show shards for the specified database name </td> </tr> <tr> <td> extra <parameter> </td> <td> Extra options that show more information </td> </tr> <tr> <td> sort <column_titles> </td> <td> Sort results by specified column titles </td> </tr> <tr> <td> issues_only </td> <td> Filters out all items that have an <code> OK </code> status </td> </tr> </tbody> </table> <table> <thead> <tr> <th> Extra parameter </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> extra all </td> <td> Shows all <code> extra </code> information </td> </tr> <tr> <td> extra backups </td> <td> Shows periodic backup status </td> </tr> <tr> <td> extra frag </td> <td> Shows fragmented memory available after the restart </td> </tr> <tr> <td> extra shardstats </td> <td> Shows shards per node </td> </tr> <tr> <td> extra rack_id </td> <td> Shows <code> rack_id </code> if customer is not <code> rack_aware </code> </td> </tr> <tr> <td> extra redis_version </td> <td> Shows Redis version of all shards in the cluster </td> </tr> <tr> <td> extra state_machine </td> <td> Shows execution of state machine information </td> </tr> <tr> <td> extra watchdog </td> <td> Shows watchdog status </td> </tr> </tbody> </table> <h3 id="returns-5"> Returns </h3> Returns a table of the status of all shards on the cluster. If <code> sort <column_titles> </code> is specified, the result is sorted by the specified table columns. If <code> issues_only </code> is specified, it only shows shards that do not have an <code> OK </code> status. <h3 id="example-5"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin status shards sort USED_MEMORY ID SHARDS: DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS db:3 database3 redis:6 node:1 master 8192-12287 2.04MB OK db:3 database3 redis:4 node:1 master 0-4095 2.08MB OK db:3 database3 redis:5 node:1 master 4096-8191 2.08MB OK db:3 database3 redis:7 node:1 master 12288-16383 2.08MB OK </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/7.4/references/cli-utilities/rladmin/status/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/expiretime/.html

<section class="prose w-full py-12"> <h1 class="command-name"> EXPIRETIME </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">EXPIRETIME key</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(1) </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @keyspace </code> , <code> @read </code> , <code> @fast </code> , </dd> </dl> Returns the absolute Unix timestamp (since January 1, 1970) in seconds at which the given key will expire. See also the <a href="/docs/latest/commands/pexpiretime/"> <code> PEXPIRETIME </code> </a> command which returns the same information with milliseconds resolution. <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> SET mykey "Hello" "OK" redis> EXPIREAT mykey 33177117420 (integer) 1 redis> EXPIRETIME mykey (integer) 33177117420 </pre> <div class="prompt" style=""> redis> <input autocomplete="off" name="prompt" spellcheck="false" type="text"/> </div> </form> <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> One of the following: <ul> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : the expiration Unix timestamp in seconds. </li> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> -1 </code> if the key exists but has no associated expiration time. </li> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> -2 </code> if the key does not exist. </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/commands/expiretime/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/ft.info/.html

<section class="prose w-full py-12"> <h1 class="command-name"> FT.INFO </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">FT.INFO index</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/interact/search-and-query"> Search 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(1) </dd> </dl> Returns information and statistics about a given index. <h2 id="required-arguments"> Required arguments </h2> <code> index </code> is the name of the given index. You must first create the index using <a href="/docs/latest/commands/ft.create/"> <code> FT.CREATE </code> </a> . <h2 id="resp-reply"> RESP reply </h2> <code> FT.INFO </code> returns an array reply with pairs of keys and values. <h2 id="returned-values"> Returned values </h2> <h3 id="general"> General </h3> <table> <thead> <tr> <th style="text-align:left"> Return field name </th> <th style="text-align:left"> Definition </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> <code> index_name </code> </td> <td style="text-align:left"> The index name that was defined when index was created. </td> </tr> <tr> <td style="text-align:left"> <code> index_options </code> </td> <td style="text-align:left"> The index options selected during <code> FT.CREATE </code> such as <code> FILTER {filter} </code> , <code> LANGUAGE {default_lang} </code> , etc. </td> </tr> <tr> <td style="text-align:left"> <code> index_definition </code> </td> <td style="text-align:left"> Includes <code> key_type </code> , hash or JSON; <code> prefixes </code> , if any; and <code> default_score </code> . </td> </tr> <tr> <td style="text-align:left"> <code> attributes </code> </td> <td style="text-align:left"> The index schema field names, types, and attributes. </td> </tr> <tr> <td style="text-align:left"> <code> num_docs </code> </td> <td style="text-align:left"> The number of documents. </td> </tr> <tr> <td style="text-align:left"> <code> max_doc_id </code> </td> <td style="text-align:left"> The maximum document ID. </td> </tr> <tr> <td style="text-align:left"> <code> num_terms </code> </td> <td style="text-align:left"> The number of distinct terms. </td> </tr> <tr> <td style="text-align:left"> <code> num_records </code> </td> <td style="text-align:left"> The total number of records. </td> </tr> </tbody> </table> <h3 id="various-size-statistics"> Various size statistics </h3> <table> <thead> <tr> <th style="text-align:left"> Statistic </th> <th style="text-align:left"> Definition </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> <code> inverted_sz_mb </code> </td> <td style="text-align:left"> The memory used by the inverted index, which is the core data structure used for searching in RediSearch. The size is given in megabytes. </td> </tr> <tr> <td style="text-align:left"> <code> vector_index_sz_mb </code> </td> <td style="text-align:left"> The memory used by the vector index, which stores any vectors associated with each document. </td> </tr> <tr> <td style="text-align:left"> <code> total_inverted_index_blocks </code> </td> <td style="text-align:left"> The total number of blocks in the inverted index. </td> </tr> <tr> <td style="text-align:left"> <code> offset_vectors_sz_mb </code> </td> <td style="text-align:left"> The memory used by the offset vectors, which store positional information for terms in documents. </td> </tr> <tr> <td style="text-align:left"> <code> doc_table_size_mb </code> </td> <td style="text-align:left"> The memory used by the document table, which contains metadata about each document in the index. </td> </tr> <tr> <td style="text-align:left"> <code> sortable_values_size_mb </code> </td> <td style="text-align:left"> The memory used by sortable values, which are values associated with documents and used for sorting purposes. </td> </tr> <tr> <td style="text-align:left"> <code> key_table_size_mb </code> </td> <td style="text-align:left"> The memory used by the key table, which stores the mapping between document IDs and Redis keys. </td> </tr> <tr> <td style="text-align:left"> <code> geoshapes_sz_mb </code> </td> <td style="text-align:left"> The memory used by GEO-related fields. </td> </tr> <tr> <td style="text-align:left"> <code> records_per_doc_avg </code> </td> <td style="text-align:left"> The average number of records (including deletions) per document. </td> </tr> <tr> <td style="text-align:left"> <code> bytes_per_record_avg </code> </td> <td style="text-align:left"> The average size of each record in bytes. </td> </tr> <tr> <td style="text-align:left"> <code> offsets_per_term_avg </code> </td> <td style="text-align:left"> The average number of offsets (position information) per term. </td> </tr> <tr> <td style="text-align:left"> <code> offset_bits_per_record_avg </code> </td> <td style="text-align:left"> The average number of bits used for offsets per record. </td> </tr> </tbody> </table> <h3 id="indexing-related-statistics"> Indexing-related statistics </h3> <table> <thead> <tr> <th style="text-align:left"> Statistic </th> <th style="text-align:left"> Definition </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> <code> hash_indexing_failures </code> </td> <td style="text-align:left"> The number of failures encountered during indexing. </td> </tr> <tr> <td style="text-align:left"> <code> total_indexing_time </code> </td> <td style="text-align:left"> The total time taken for indexing in seconds. </td> </tr> <tr> <td style="text-align:left"> <code> indexing </code> </td> <td style="text-align:left"> Indicates whether the index is currently being generated. </td> </tr> <tr> <td style="text-align:left"> <code> percent_indexed </code> </td> <td style="text-align:left"> The percentage of the index that has been successfully generated (1 means 100%). </td> </tr> <tr> <td style="text-align:left"> <code> number_of_uses </code> </td> <td style="text-align:left"> The number of times the index has been used. </td> </tr> <tr> <td style="text-align:left"> <code> cleaning </code> </td> <td style="text-align:left"> The index deletion flag. A value of <code> 1 </code> indicates index deletion is in progress. </td> </tr> </tbody> </table> <h3 id="garbage-collection-statistics"> Garbage collection statistics </h3> <table> <thead> <tr> <th style="text-align:left"> Statistic </th> <th style="text-align:left"> Definition </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> <code> bytes_collected </code> </td> <td style="text-align:left"> The number of bytes collected during garbage collection. </td> </tr> <tr> <td style="text-align:left"> <code> total_ms_run </code> </td> <td style="text-align:left"> The total time in milliseconds spent on garbage collection. </td> </tr> <tr> <td style="text-align:left"> <code> total_cycles </code> </td> <td style="text-align:left"> The total number of garbage collection cycles. </td> </tr> <tr> <td style="text-align:left"> <code> average_cycle_time_ms </code> </td> <td style="text-align:left"> The average time in milliseconds for each garbage collection cycle. The value <code> nan </code> indicates that the average cycle time is not available. </td> </tr> <tr> <td style="text-align:left"> <code> last_run_time_ms </code> </td> <td style="text-align:left"> The time in milliseconds taken by the last garbage collection run. </td> </tr> </tbody> </table> The next two GC-related fields are relevant in scenarios where simultaneous changes occurred in the same memory area for both the parent process and the child process, resulting in the parent discarding these changes. <table> <thead> <tr> <th style="text-align:left"> Statistic </th> <th style="text-align:left"> Definition </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> <code> gc_numeric_trees_missed </code> </td> <td style="text-align:left"> The number of numeric tree nodes whose changes were discarded due to splitting by the parent process during garbage collection. </td> </tr> <tr> <td style="text-align:left"> <code> gc_blocks_denied </code> </td> <td style="text-align:left"> The number of blocks whose changes were discarded (skipped) because they were modified by the parent process during the garbage collection. Notably, as inverted index blocks are append-only, only the last block of an inverted index can be skipped. </td> </tr> </tbody> </table> <h3 id="cursor-statistics"> Cursor statistics </h3> <table> <thead> <tr> <th style="text-align:left"> Statistic </th> <th style="text-align:left"> Definition </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> <code> global_idle </code> </td> <td style="text-align:left"> The number of idle cursors in the system. </td> </tr> <tr> <td style="text-align:left"> <code> global_total </code> </td> <td style="text-align:left"> The total number of cursors in the system. </td> </tr> <tr> <td style="text-align:left"> <code> index_capacity </code> </td> <td style="text-align:left"> The maximum number of cursors allowed per index. </td> </tr> <tr> <td style="text-align:left"> <code> index_total </code> </td> <td style="text-align:left"> The total number of cursors open on the index. </td> </tr> </tbody> </table> <h3 id="other-statistics"> Other statistics </h3> <ul> <li> Dialect statistics: the number of times the index was searched using each DIALECT, 1 - 4. </li> <li> Index error statistics, including <code> indexing failures </code> , <code> last indexing error </code> , and <code> last indexing error key </code> . </li> <li> Field statistics, including <code> indexing failures </code> , <code> last indexing error </code> , and <code> last indexing error key </code> for each schema field. </li> </ul> <h2 id="example"> Example </h2> <details open=""> <summary> Return statistics about an index </summary> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">127.0.0.1:6379> ft.info idx:bicycle 1) index_name 2) idx:bicycle 3) index_options 4) (empty array) 5) index_definition 6) 1) key_type 2) JSON 3) prefixes 4) 1) bicycle: 5) default_score 6) "1" 7) attributes 8) 1) 1) identifier 2) $.pickup_zone 3) attribute 4) pickup_zone 5) type 6) GEOSHAPE 7) coord_system 8) SPHERICAL 2) 1) identifier 2) $.store_location 3) attribute 4) store_location 5) type 6) GEO 3) 1) identifier 2) $.brand 3) attribute 4) brand 5) type 6) TEXT 7) WEIGHT 8) "1" 4) 1) identifier 2) $.model 3) attribute 4) model 5) type 6) TEXT 7) WEIGHT 8) "1" 5) 1) identifier 2) $.description 3) attribute 4) description 5) type 6) TEXT 7) WEIGHT 8) "1" 6) 1) identifier 2) $.price 3) attribute 4) price 5) type 6) NUMERIC 7) 1) identifier 2) $.condition 3) attribute 4) condition 5) type 6) TAG 7) SEPARATOR 8) , 9) num_docs 10) "10" 11) max_doc_id 12) "10" 13) num_terms 14) "546" 15) num_records 16) "692" 17) inverted_sz_mb 18) "0.003993034362792969" 19) vector_index_sz_mb 20) "0" 21) total_inverted_index_blocks 22) "551" 23) offset_vectors_sz_mb 24) "7.047653198242188e-4" 25) doc_table_size_mb 26) "7.152557373046875e-4" 27) sortable_values_size_mb 28) "0" 29) key_table_size_mb 30) "3.0422210693359375e-4" 31) geoshapes_sz_mb 32) "0.00426483154296875" 33) records_per_doc_avg 34) "69.19999694824219" 35) bytes_per_record_avg 36) "6.0505781173706055" 37) offsets_per_term_avg 38) "1.0679190158843994" 39) offset_bits_per_record_avg 40) "8" 41) hash_indexing_failures 42) "0" 43) total_indexing_time 44) "4.539999961853027" 45) indexing 46) "0" 47) percent_indexed 48) "1" 49) number_of_uses 50) (integer) 1 51) cleaning 52) (integer) 0 53) gc_stats 54) 1) bytes_collected 2) "0" 3) total_ms_run 4) "0" 5) total_cycles 6) "0" 7) average_cycle_time_ms 8) "nan" 9) last_run_time_ms 10) "0" 11) gc_numeric_trees_missed 12) "0" 13) gc_blocks_denied 14) "0" 55) cursor_stats 56) 1) global_idle 2) (integer) 0 3) global_total 4) (integer) 0 5) index_capacity 6) (integer) 128 7) index_total 8) (integer) 0 57) dialect_stats 58) 1) dialect_1 2) (integer) 0 3) dialect_2 4) (integer) 0 5) dialect_3 6) (integer) 0 7) dialect_4 8) (integer) 0 59) Index Errors 60) 1) indexing failures 2) (integer) 0 3) last indexing error 4) N/A 5) last indexing error key 6) "N/A" 61) field statistics 62) 1) 1) identifier 2) $.pickup_zone 3) attribute 4) pickup_zone 5) Index Errors 6) 1) indexing failures 2) (integer) 0 3) last indexing error 4) N/A 5) last indexing error key 6) "N/A" 2) 1) identifier 2) $.store_location 3) attribute 4) store_location 5) Index Errors 6) 1) indexing failures 2) (integer) 0 3) last indexing error 4) N/A 5) last indexing error key 6) "N/A" 3) 1) identifier 2) $.brand 3) attribute 4) brand 5) Index Errors 6) 1) indexing failures 2) (integer) 0 3) last indexing error 4) N/A 5) last indexing error key 6) "N/A" 4) 1) identifier 2) $.model 3) attribute 4) model 5) Index Errors 6) 1) indexing failures 2) (integer) 0 3) last indexing error 4) N/A 5) last indexing error key 6) "N/A" 5) 1) identifier 2) $.description 3) attribute 4) description 5) Index Errors 6) 1) indexing failures 2) (integer) 0 3) last indexing error 4) N/A 5) last indexing error key 6) "N/A" 6) 1) identifier 2) $.price 3) attribute 4) price 5) Index Errors 6) 1) indexing failures 2) (integer) 0 3) last indexing error 4) N/A 5) last indexing error key 6) "N/A" 7) 1) identifier 2) $.condition 3) attribute 4) condition 5) Index Errors 6) 1) indexing failures 2) (integer) 0 3) last indexing error 4) N/A 5) last indexing error key 6) "N/A"</code></pre> </div> </details> <h2 id="see-also"> See also </h2> <a href="/docs/latest/commands/ft.create/"> <code> FT.CREATE </code> </a> | <a href="/docs/latest/commands/ft.search/"> <code> FT.SEARCH </code> </a> <h2 id="related-topics"> Related topics </h2> <a href="/docs/latest/develop/interact/search-and-query/"> RediSearch </a> <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/ft.info/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/ft.suglen/.html

<section class="prose w-full py-12"> <h1 class="command-name"> FT.SUGLEN </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">FT.SUGLEN key </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/interact/search-and-query"> Search 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(1) </dd> </dl> Get the size of an auto-complete suggestion dictionary <a href="#examples"> Examples </a> <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> key </code> </summary> is suggestion dictionary key. </details> <h2 id="return"> Return </h2> FT.SUGLEN returns an integer reply, which is the current size of the suggestion dictionary. <h2 id="examples"> Examples </h2> <details open=""> <summary> Get the size of an auto-complete suggestion dictionary </summary> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">127.0.0.1:6379> FT.SUGLEN sug (integer) 2</code></pre> </div> </details> <h2 id="see-also"> See also </h2> <a href="/docs/latest/commands/ft.sugadd/"> <code> FT.SUGADD </code> </a> | <a href="/docs/latest/commands/ft.sugdel/"> <code> FT.SUGDEL </code> </a> | <a href="/docs/latest/commands/ft.sugget/"> <code> FT.SUGGET </code> </a> <h2 id="related-topics"> Related topics </h2> <a href="/docs/latest/develop/interact/search-and-query/"> RediSearch </a> <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/ft.suglen/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/data-types/timeseries/quickstart.html

<section class="prose w-full py-12"> <h1> Quickstart </h1> Quick Start Guide to Time Series <h2 id="setup"> Setup </h2> You can get RedisTimeSeries setup in the cloud, in a Docker container or on your own machine. <h3 id="redis-cloud"> Redis Cloud </h3> Redis Time Series are available on all Redis Cloud managed services, including a completely free managed database up to 30MB. <a href="https://redislabs.com/try-free/"> Get started here </a> <h3 id="docker"> Docker </h3> To quickly try out Redis Time Series, launch an instance of Redis Stack using docker: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">docker run -p 6379:6379 -it --rm redis/redis-stack-server </code></pre> </div> <h3 id="download-and-running-binaries"> Download and running binaries </h3> First download the pre-compiled version from the <a href="https://redis.io/downloads"> Redis download center </a> . Next, run Redis with RedisTimeSeries: <pre tabindex="0"><code>$ redis-server --loadmodule /path/to/module/redistimeseries.so </code></pre> <h3 id="build-and-run-it-yourself"> Build and Run it yourself </h3> You can also build and run RedisTimeSeries on your own machine. Major Linux distributions as well as macOS are supported. <h4 id="requirements"> Requirements </h4> First, clone the RedisTimeSeries repository from git: <pre tabindex="0"><code>git clone --recursive https://github.com/RedisTimeSeries/RedisTimeSeries.git </code></pre> Then, to install required build artifacts, invoke the following: <pre tabindex="0"><code>cd RedisTimeSeries make setup </code></pre> Or you can install required dependencies manually listed in <a href="https://github.com/RedisTimeSeries/RedisTimeSeries/blob/master/sbin/system-setup.py"> system-setup.py </a> . If <code> make </code> is not yet available, the following commands are equivalent: <pre tabindex="0"><code>./deps/readies/bin/getpy3 ./system-setup.py </code></pre> Note that <code> system-setup.py </code> will install various packages on your system using the native package manager and pip. This requires root permissions (i.e. sudo) on Linux. If you prefer to avoid that, you can: <ul> <li> Review system-setup.py and install packages manually, </li> <li> Utilize a Python virtual environment, </li> <li> Use Docker with the <code> --volume </code> option to create an isolated build environment. </li> </ul> <h4 id="build"> Build </h4> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">make build </code></pre> </div> Binary artifacts are placed under the <code> bin </code> directory. <h4 id="run"> Run </h4> In your redis-server run: <code> loadmodule bin/redistimeseries.so </code> For more information about modules, go to the <a href="/docs/latest/develop/reference/modules/"> redis official documentation </a> . <h2 id="give-it-a-try-with-redis-cli"> Give it a try with <code> redis-cli </code> </h2> After you setup RedisTimeSeries, you can interact with it using redis-cli. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ redis-cli 127.0.0.1:6379> TS.CREATE sensor1 OK </code></pre> </div> <h2 id="creating-a-timeseries"> Creating a timeseries </h2> A new timeseries can be created with the <a href="/docs/latest/commands/ts.create/"> <code> TS.CREATE </code> </a> command; for example, to create a timeseries named <code> sensor1 </code> run the following: <pre tabindex="0"><code>TS.CREATE sensor1 </code></pre> You can prevent your timeseries growing indefinitely by setting a maximum age for samples compared to the last event time (in milliseconds) with the <code> RETENTION </code> option. The default value for retention is <code> 0 </code> , which means the series will not be trimmed. <pre tabindex="0"><code>TS.CREATE sensor1 RETENTION 2678400000 </code></pre> This will create a timeseries called <code> sensor1 </code> and trim it to values of up to one month. <h2 id="adding-data-points"> Adding data points </h2> For adding new data points to a timeseries we use the <a href="/docs/latest/commands/ts.add/"> <code> TS.ADD </code> </a> command: <pre tabindex="0"><code>TS.ADD key timestamp value </code></pre> The <code> timestamp </code> argument is the UNIX timestamp of the sample in milliseconds and <code> value </code> is the numeric data value of the sample. Example: <pre tabindex="0"><code>TS.ADD sensor1 1626434637914 26 </code></pre> To add a datapoint with the current timestamp you can use a <code> * </code> instead of a specific timestamp: <pre tabindex="0"><code>TS.ADD sensor1 * 26 </code></pre> You can append data points to multiple timeseries at the same time with the <a href="/docs/latest/commands/ts.madd/"> <code> TS.MADD </code> </a> command: <pre tabindex="0"><code>TS.MADD key timestamp value [key timestamp value ...] </code></pre> <h2 id="deleting-data-points"> Deleting data points </h2> Data points between two timestamps (inclusive) can be deleted with the <a href="/docs/latest/commands/ts.del/"> <code> TS.DEL </code> </a> command: <pre tabindex="0"><code>TS.DEL key fromTimestamp toTimestamp </code></pre> Example: <pre tabindex="0"><code>TS.DEL sensor1 1000 2000 </code></pre> To delete a single timestamp, use it as both the "from" and "to" timestamp: <pre tabindex="0"><code>TS.DEL sensor1 1000 1000 </code></pre> Note: When a sample is deleted, the data in all downsampled timeseries will be recalculated for the specific bucket. If part of the bucket has already been removed though, because it's outside of the retention period, we won't be able to recalculate the full bucket, so in those cases we will refuse the delete operation. <h2 id="labels"> Labels </h2> Labels are key-value metadata we attach to data points, allowing us to group and filter. They can be either string or numeric values and are added to a timeseries on creation: <pre tabindex="0"><code>TS.CREATE sensor1 LABELS region east </code></pre> <h2 id="compaction"> Compaction </h2> Another useful feature of Redis Time Series is compacting data by creating a rule for compaction ( <a href="/docs/latest/commands/ts.createrule/"> <code> TS.CREATERULE </code> </a> ). For example, if you have collected more than one billion data points in a day, you could aggregate the data by every minute in order to downsample it, thereby reducing the dataset size to 24 * 60 = 1,440 data points. You can choose one of the many available aggregation types in order to aggregate multiple data points from a certain minute into a single one. The currently supported aggregation types are: <code> avg, sum, min, max, range, count, first, last, std.p, std.s, var.p, var.s and twa </code> . It's important to point out that there is no data rewriting on the original timeseries; the compaction happens in a new series, while the original one stays the same. In order to prevent the original timeseries from growing indefinitely, you can use the retention option, which will trim it down to a certain period of time. NOTE: You need to create the destination (the compacted) timeseries before creating the rule. <pre tabindex="0"><code>TS.CREATERULE sourceKey destKey AGGREGATION aggregationType bucketDuration </code></pre> Example: <pre tabindex="0"><code>TS.CREATE sensor1_compacted # Create the destination timeseries first TS.CREATERULE sensor1 sensor1_compacted AGGREGATION avg 60000 # Create the rule </code></pre> With this creation rule, datapoints added to the <code> sensor1 </code> timeseries will be grouped into buckets of 60 seconds (60000ms), averaged, and saved in the <code> sensor1_compacted </code> timeseries. <h2 id="filtering"> Filtering </h2> You can filter your time series by value, timestamp and labels: <h3 id="filtering-by-label"> Filtering by label </h3> You can retrieve datapoints from multiple timeseries in the same query, and the way to do this is by using label filters. For example: <pre tabindex="0"><code>TS.MRANGE - + FILTER area_id=32 </code></pre> This query will show data from all sensors (timeseries) that have a label of <code> area_id </code> with a value of <code> 32 </code> . The results will be grouped by timeseries. Or we can also use the <a href="/docs/latest/commands/ts.mget/"> <code> TS.MGET </code> </a> command to get the last sample that matches the specific filter: <pre tabindex="0"><code>TS.MGET FILTER area_id=32 </code></pre> <h3 id="filtering-by-value"> Filtering by value </h3> We can filter by value across a single or multiple timeseries: <pre tabindex="0"><code>TS.RANGE sensor1 - + FILTER_BY_VALUE 25 30 </code></pre> This command will return all data points whose value sits between 25 and 30, inclusive. To achieve the same filtering on multiple series we have to combine the filtering by value with filtering by label: <pre tabindex="0"><code>TS.MRANGE - + FILTER_BY_VALUE 20 30 FILTER region=east </code></pre> <h3 id="filtering-by-timestamp"> Filtering by timestamp </h3> To retrieve the datapoints for specific timestamps on one or multiple timeseries we can use the <code> FILTER_BY_TS </code> argument: Filter on one timeseries: <pre tabindex="0"><code>TS.RANGE sensor1 - + FILTER_BY_TS 1626435230501 1626443276598 </code></pre> Filter on multiple timeseries: <pre tabindex="0"><code>TS.MRANGE - + FILTER_BY_TS 1626435230501 1626443276598 FILTER region=east </code></pre> <h2 id="aggregation"> Aggregation </h2> It's possible to combine values of one or more timeseries by leveraging aggregation functions: <pre tabindex="0"><code>TS.RANGE ... AGGREGATION aggType bucketDuration... </code></pre> For example, to find the average temperature per hour in our <code> sensor1 </code> series we could run: <pre tabindex="0"><code>TS.RANGE sensor1 - + + AGGREGATION avg 3600000 </code></pre> To achieve the same across multiple sensors from the area with id of 32 we would run: <pre tabindex="0"><code>TS.MRANGE - + AGGREGATION avg 3600000 FILTER area_id=32 </code></pre> <h3 id="aggregation-bucket-alignment"> Aggregation bucket alignment </h3> When doing aggregations, the aggregation buckets will be aligned to 0 as so: <pre tabindex="0"><code>TS.RANGE sensor3 10 70 + AGGREGATION min 25 </code></pre> <pre tabindex="0"><code>Value: | (1000) (2000) (3000) (4000) (5000) (6000) (7000) Timestamp: |-------|10|-------|20|-------|30|-------|40|-------|50|-------|60|-------|70|---> Bucket(25ms): |_________________________||_________________________||___________________________| V V V min(1000, 2000)=1000 min(3000, 4000)=3000 min(5000, 6000, 7000)=5000 </code></pre> And we will get the following datapoints: 1000, 3000, 5000. You can choose to align the buckets to the start or end of the queried interval as so: <pre tabindex="0"><code>TS.RANGE sensor3 10 70 + AGGREGATION min 25 ALIGN start </code></pre> <pre tabindex="0"><code>Value: | (1000) (2000) (3000) (4000) (5000) (6000) (7000) Timestamp: |-------|10|-------|20|-------|30|-------|40|-------|50|-------|60|-------|70|---> Bucket(25ms): |__________________________||_________________________||___________________________| V V V min(1000, 2000, 3000)=1000 min(4000, 5000)=4000 min(6000, 7000)=6000 </code></pre> The result array will contain the following datapoints: 1000, 4000 and 6000 <h3 id="aggregation-across-timeseries"> Aggregation across timeseries </h3> By default, results of multiple timeseries will be grouped by timeseries, but (since v1.6) you can use the <code> GROUPBY </code> and <code> REDUCE </code> options to group them by label and apply an additional aggregation. To find minimum temperature per region, for example, we can run: <pre tabindex="0"><code>TS.MRANGE - + FILTER region=(east,west) GROUPBY region REDUCE min </code></pre> <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/data-types/timeseries/quickstart/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/get-started/vector-database.html

<section class="prose w-full py-12"> <h1> Redis as a vector database quick start guide </h1> Understand how to use Redis as a vector database This quick start guide helps you to: <ol> <li> Understand what a vector database is </li> <li> Create a Redis vector database </li> <li> Create vector embeddings and store vectors </li> <li> Query data and perform a vector search </li> </ol> <h2 id="understand-vector-databases"> Understand vector databases </h2> Data is often unstructured, which means that it isn't described by a well-defined schema. Examples of unstructured data include text passages, images, videos, or audio. One approach to storing and searching through unstructured data is to use vector embeddings. What are vectors? In machine learning and AI, vectors are sequences of numbers that represent data. They are the inputs and outputs of models, encapsulating underlying information in a numerical form. Vectors transform unstructured data, such as text, images, videos, and audio, into a format that machine learning models can process. <ul> <li> Why are they important? Vectors capture complex patterns and semantic meanings inherent in data, making them powerful tools for a variety of applications. They allow machine learning models to understand and manipulate unstructured data more effectively. </li> <li> Enhancing traditional search. Traditional keyword or lexical search relies on exact matches of words or phrases, which can be limiting. In contrast, vector search, or semantic search, leverages the rich information captured in vector embeddings. By mapping data into a vector space, similar items are positioned near each other based on their meaning. This approach allows for more accurate and meaningful search results, as it considers the context and semantic content of the query rather than just the exact words used. </li> </ul> <h2 id="create-a-redis-vector-database"> Create a Redis vector database </h2> You can use <a href="/docs/latest/operate/oss_and_stack/"> Redis Stack </a> as a vector database. It allows you to: <ul> <li> Store vectors and the associated metadata within hashes or <a href="/docs/latest/develop/data-types/json/"> JSON </a> documents </li> <li> Create and configure secondary indices for search </li> <li> Perform vector searches </li> <li> Update vectors and metadata </li> <li> Delete and cleanup </li> </ul> The easiest way to get started is to use Redis Cloud: <ol> <li> Create a <a href="https://redis.com/try-free?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users"> free account </a> . <img src="../img/free-cloud-db.png" width="500px"/> </li> <li> Follow the instructions to create a free database. </li> </ol> This free Redis Cloud database comes out of the box with all the Redis Stack features. You can alternatively use the <a href="/docs/latest/operate/oss_and_stack/install/install-stack/"> installation guides </a> to install Redis Stack on your local machine. You need to have the following features configured for your Redis server: JSON and Search and query. <h2 id="install-the-required-python-packages"> Install the required Python packages </h2> Create a Python virtual environment and install the following dependencies using <code> pip </code> : <ul> <li> <code> redis </code> : You can find further details about the <code> redis-py </code> client library in the <a href="/docs/latest/develop/clients/redis-py/"> clients </a> section of this documentation site. </li> <li> <code> pandas </code> : Pandas is a data analysis library. </li> <li> <code> sentence-transformers </code> : You will use the <a href="https://www.sbert.net/"> SentenceTransformers </a> framework to generate embeddings on full text. </li> <li> <code> tabulate </code> : <code> pandas </code> uses <code> tabulate </code> to render Markdown. </li> </ul> You will also need the following imports in your Python code: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepimports"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepimports" name="search_vss-stepimports" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepimports" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepimports" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepimports" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepimports')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepimports" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> <h2 id="connect"> Connect </h2> Connect to Redis. By default, Redis returns binary responses. To decode them, you pass the <code> decode_responses </code> parameter set to <code> True </code> : <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepconnect"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepconnect" name="search_vss-stepconnect" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepconnect" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepconnect" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepconnect" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepconnect')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepconnect" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </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"> Tip: </div> Instead of using a local Redis Stack server, you can copy and paste the connection details from the Redis Cloud database configuration page. Here is an example connection string of a Cloud database that is hosted in the AWS region <code> us-east-1 </code> and listens on port 16379: <code> redis-16379.c283.us-east-1-4.ec2.cloud.redislabs.com:16379 </code> . The connection string has the format <code> host:port </code> . You must also copy and paste the username and password of your Cloud database. The line of code for connecting with the default user changes then to <code> client = redis.Redis(host="redis-16379.c283.us-east-1-4.ec2.cloud.redislabs.com", port=16379, password="your_password_here", decode_responses=True) </code> . </div> </div> <h2 id="prepare-the-demo-dataset"> Prepare the demo dataset </h2> This quick start guide also uses the bikes dataset. Here is an example document from it: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "model": "Jigger", "brand": "Velorim", "price": 270, "type": "Kids bikes", "specs": { "material": "aluminium", "weight": "10" }, "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! ..." } </code></pre> </div> The <code> description </code> field contains free-form text descriptions of bikes and will be used to create vector embeddings. <h3 id="1-fetch-the-demo-data"> 1. Fetch the demo data </h3> You need to first fetch the demo dataset as a JSON array: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepget_data"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepget_data" name="search_vss-stepget_data" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepget_data" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepget_data" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepget_data" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepget_data')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepget_data" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> Inspect the structure of one of the bike JSON documents: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepdump_data"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepdump_data" name="search_vss-stepdump_data" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepdump_data" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepdump_data" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepdump_data" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepdump_data')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepdump_data" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> <h3 id="2-store-the-demo-data-in-redis"> 2. Store the demo data in Redis </h3> Now iterate over the <code> bikes </code> array to store the data as <a href="/docs/latest/develop/data-types/json/"> JSON </a> documents in Redis by using the <a href="/docs/latest/commands/json.set//"> JSON.SET </a> command. The below code uses a <a href="/docs/latest/develop/use/pipelining/"> pipeline </a> to minimize the network round-trip times: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepload_data"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepload_data" name="search_vss-stepload_data" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepload_data" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepload_data" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepload_data" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepload_data')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepload_data" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> Once loaded, you can retrieve a specific attribute from one of the JSON documents in Redis using a <a href="https://goessner.net/articles/JsonPath/"> JSONPath </a> expression: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepget"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepget" name="search_vss-stepget" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepget" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepget" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepget" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepget')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepget" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> <h3 id="3-select-a-text-embedding-model"> 3. Select a text embedding model </h3> <a href="https://huggingface.co"> HuggingFace </a> has a large catalog of text embedding models that are locally servable through the <code> SentenceTransformers </code> framework. Here we use the <a href="https://microsoft.github.io/msmarco/"> MS MARCO </a> model that is widely used in search engines, chatbots, and other AI applications. <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">from sentence_transformers import SentenceTransformer embedder = SentenceTransformer('msmarco-distilbert-base-v4') </code></pre> </div> <h3 id="4-generate-text-embeddings"> 4. Generate text embeddings </h3> Iterate over all the Redis keys with the prefix <code> bikes: </code> : <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepget_keys"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepget_keys" name="search_vss-stepget_keys" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepget_keys" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepget_keys" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepget_keys" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepget_keys')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepget_keys" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> Use the keys as input to the <a href="/docs/latest/commands/json.mget/"> JSON.MGET </a> command, along with the <code> $.description </code> field, to collect the descriptions in a list. Then, pass the list of descriptions to the <code> .encode() </code> method: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepgenerate_embeddings"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepgenerate_embeddings" name="search_vss-stepgenerate_embeddings" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepgenerate_embeddings" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepgenerate_embeddings" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepgenerate_embeddings" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepgenerate_embeddings')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepgenerate_embeddings" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> Insert the vectorized descriptions to the bike documents in Redis using the <a href="/docs/latest/commands/json.set"> JSON.SET </a> command. The following command inserts a new field into each of the documents under the JSONPath <code> $.description_embeddings </code> . Once again, do this using a pipeline to avoid unnecessary network round-trips: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepload_embeddings"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepload_embeddings" name="search_vss-stepload_embeddings" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepload_embeddings" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepload_embeddings" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepload_embeddings" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepload_embeddings')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepload_embeddings" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> Inspect one of the updated bike documents using the <a href="/docs/latest/commands/json.get"> JSON.GET </a> command: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepdump_example"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepdump_example" name="search_vss-stepdump_example" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepdump_example" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepdump_example" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepdump_example" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepdump_example')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepdump_example" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </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> When storing a vector embedding within a JSON document, the embedding is stored as a JSON array. In the example above, the array was shortened considerably for the sake of readability. </div> </div> <h2 id="create-an-index"> Create an index </h2> <h3 id="1-create-an-index-with-a-vector-field"> 1. Create an index with a vector field </h3> You must create an index to query document metadata or to perform vector searches. Use the <a href="/docs/latest/commands/ft.create"> FT.CREATE </a> command: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepcreate_index"> <input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_vss-stepcreate_index" name="search_vss-stepcreate_index" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_vss-stepcreate_index" title="Open example"> >_ Redis CLI </label> <div aria-labelledby="tab-search_vss-stepcreate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_vss-stepcreate_index" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-plaintext" data-lang="plaintext">FT.CREATE idx:bikes_vss ON JSON PREFIX 1 bikes: SCORE 1.0 SCHEMA $.model TEXT WEIGHT 1.0 NOSTEM $.brand TEXT WEIGHT 1.0 NOSTEM $.price NUMERIC $.type TAG SEPARATOR "," $.description AS description TEXT WEIGHT 1.0 $.description_embeddings AS vector VECTOR FLAT 6 TYPE FLOAT32 DIM 768 DISTANCE_METRIC COSINE</code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_vss-stepcreate_index')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <div class="flex-1 text-xs text-white overflow-ellipsis"> Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis. </div> <div class="text-right"> <a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight"> <svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg"> <path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5"> </path> <path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5"> </path> <path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5"> </path> <path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171"> </path> <path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171"> </path> <path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5"> </path> <path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171"> </path> <path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5"> </path> </svg> Get Redis Insight </a> </div> </div> </div> <input class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepcreate_index" name="search_vss-stepcreate_index" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepcreate_index" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepcreate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepcreate_index" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepcreate_index')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepcreate_index" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> Here is a breakdown of the <code> VECTOR </code> field definition: <ul> <li> <code> $.description_embeddings AS vector </code> : The vector field's JSON path and its field alias <code> vector </code> . </li> <li> <code> FLAT </code> : Specifies the indexing method, which is either a flat index or a hierarchical navigable small world graph ( <a href="https://arxiv.org/ftp/arxiv/papers/1603/1603.09320.pdf"> HNSW </a> ). </li> <li> <code> TYPE FLOAT32 </code> : Sets the float precision of a vector component, in this case a 32-bit floating point number. </li> <li> <code> DIM 768 </code> : The length or dimension of the embeddings, determined by the chosen embedding model. </li> <li> <code> DISTANCE_METRIC COSINE </code> : The chosen distance function: <a href="https://en.wikipedia.org/wiki/Cosine_similarity"> cosine distance </a> . </li> </ul> You can find further details about all these options in the <a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/vectors/"> vector reference documentation </a> . <h3 id="2-check-the-state-of-the-index"> 2. Check the state of the index </h3> As soon as you execute the <a href="/docs/latest/commands/ft.create"> FT.CREATE </a> command, the indexing process runs in the background. In a short time, all JSON documents should be indexed and ready to be queried. To validate that, you can use the <a href="/docs/latest/commands/ft.info"> FT.INFO </a> command, which provides details and statistics about the index. Of particular interest are the number of documents successfully indexed and the number of failures: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepvalidate_index"> <input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_vss-stepvalidate_index" name="search_vss-stepvalidate_index" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_vss-stepvalidate_index" title="Open example"> >_ Redis CLI </label> <div aria-labelledby="tab-search_vss-stepvalidate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_vss-stepvalidate_index" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-plaintext" data-lang="plaintext">FT.INFO idx:bikes_vss</code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_vss-stepvalidate_index')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <div class="flex-1 text-xs text-white overflow-ellipsis"> Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis. </div> <div class="text-right"> <a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight"> <svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg"> <path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5"> </path> <path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5"> </path> <path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5"> </path> <path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171"> </path> <path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171"> </path> <path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5"> </path> <path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171"> </path> <path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5"> </path> </svg> Get Redis Insight </a> </div> </div> </div> <input class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepvalidate_index" name="search_vss-stepvalidate_index" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepvalidate_index" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepvalidate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepvalidate_index" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepvalidate_index')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepvalidate_index" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> <h2 id="perform-vector-searches"> Perform vector searches </h2> This quick start guide focuses on vector search. However, you can learn more about how to query based on document metadata in the <a href="/docs/latest/develop/get-started/document-database/"> document database quick start guide </a> . <h3 id="1-embed-your-queries"> 1. Embed your queries </h3> The following code snippet shows a list of text queries you will use to perform vector search in Redis: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepdef_bulk_queries"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepdef_bulk_queries" name="search_vss-stepdef_bulk_queries" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepdef_bulk_queries" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepdef_bulk_queries" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepdef_bulk_queries" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepdef_bulk_queries')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepdef_bulk_queries" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> First, encode each input query as a vector embedding using the same SentenceTransformers model: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepenc_bulk_queries"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepenc_bulk_queries" name="search_vss-stepenc_bulk_queries" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepenc_bulk_queries" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepenc_bulk_queries" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepenc_bulk_queries" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepenc_bulk_queries')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepenc_bulk_queries" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </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"> Tip: </div> It is vital that you use the same embedding model to embed your queries as you did your documents. Using a different model will result in poor semantic search results or error. </div> </div> <h3 id="2-k-nearest-neighbors-knn-search"> 2. K-nearest neighbors (KNN) search </h3> The KNN algorithm calculates the distance between the query vector and each vector in Redis based on the chosen distance function. It then returns the top K items with the smallest distances to the query vector. These are the most semantically similar items. Now construct a query to do just that: <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">query = ( Query('(*)=>[KNN 3 @vector $query_vector AS vector_score]') .sort_by('vector_score') .return_fields('vector_score', 'id', 'brand', 'model', 'description') .dialect(2) ) </code></pre> </div> Let's break down the above query template: <ul> <li> The filter expression <code> (*) </code> means <code> all </code> . In other words, no filtering was applied. You could replace it with an expression that filters by additional metadata. </li> <li> The <code> KNN </code> part of the query searches for the top 3 nearest neighbors. </li> <li> The query vector must be passed in as the param <code> query_vector </code> . </li> <li> The distance to the query vector is returned as <code> vector_score </code> . </li> <li> The results are sorted by this <code> vector_score </code> . </li> <li> Finally, it returns the fields <code> vector_score </code> , <code> id </code> , <code> brand </code> , <code> model </code> , and <code> description </code> for each result. </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"> Note: </div> To utilize a vector query with the <a href="/docs/latest/commands/ft.search/"> <code> FT.SEARCH </code> </a> command, you must specify DIALECT 2 or greater. </div> </div> You must pass the vectorized query as a byte array with the param name <code> query_vector </code> . The following code creates a Python NumPy array from the query vector and converts it into a compact, byte-level representation that can be passed as a parameter to the query: <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">client.ft('idx:bikes_vss').search( query, { 'query_vector': np.array(encoded_query, dtype=np.float32).tobytes() } ).docs </code></pre> </div> With the template for the query in place, you can execute all queries in a loop. Notice that the script calculates the <code> vector_score </code> for each result as <code> 1 - doc.vector_score </code> . Because the cosine distance is used as the metric, the items with the smallest distance are closer and, therefore, more similar to the query. Then, loop over the matched documents and create a list of results that can be converted into a Pandas table to visualize the results: <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepdefine_bulk_query"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepdefine_bulk_query" name="search_vss-stepdefine_bulk_query" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepdefine_bulk_query" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-stepdefine_bulk_query" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepdefine_bulk_query" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepdefine_bulk_query')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-stepdefine_bulk_query" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> The query results show the individual queries' top three matches (our K parameter) along with the bike's id, brand, and model for each query. For example, for the query "Best Mountain bikes for kids", the highest similarity score ( <code> 0.54 </code> ) and, therefore the closest match was the 'Nord' brand 'Chook air 5' bike model, described as: <blockquote> The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails. The Chook Air 5 is the perfect intro to mountain biking. </blockquote> From the description, this bike is an excellent match for younger children, and the embeddings accurately captured the semantics of the description. <div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-steprun_knn_query"> <input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-steprun_knn_query" name="search_vss-steprun_knn_query" tabindex="1" type="radio"/> <label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-steprun_knn_query" title="Open example"> Python </label> <div aria-labelledby="tab-search_vss-steprun_knn_query" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-steprun_knn_query" role="tabpanel" tabindex="0"> <div class="highlight"> <pre class="chroma"><code class="language-python" data-lang="python">""" Code samples for vector database quickstart pages: https://redis.io/docs/latest/develop/get-started/vector-database/ """ import json import time import numpy as np import pandas as pd import requests import redis from redis.commands.search.field import ( NumericField, TagField, TextField, VectorField, ) from redis.commands.search.indexDefinition import IndexDefinition, IndexType from redis.commands.search.query import Query from sentence_transformers import SentenceTransformer URL = ("https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started" "/main/data/bikes.json" ) response = requests.get(URL, timeout=10) bikes = response.json() json.dumps(bikes[0], indent=2) client = redis.Redis(host="localhost", port=6379, decode_responses=True) res = client.ping() # >>> True pipeline = client.pipeline() for i, bike in enumerate(bikes, start=1): redis_key = f"bikes:{i:03}" pipeline.json().set(redis_key, "$", bike) res = pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010", "$.model") # >>> ['Summit'] keys = sorted(client.keys("bikes:*")) # >>> ['bikes:001', 'bikes:002', ..., 'bikes:011'] descriptions = client.json().mget(keys, "$.description") descriptions = [item for sublist in descriptions for item in sublist] embedder = SentenceTransformer("msmarco-distilbert-base-v4") embeddings = embedder.encode(descriptions).astype(np.float32).tolist() VECTOR_DIMENSION = len(embeddings[0]) # >>> 768 pipeline = client.pipeline() for key, embedding in zip(keys, embeddings): pipeline.json().set(key, "$.description_embeddings", embedding) pipeline.execute() # >>> [True, True, True, True, True, True, True, True, True, True, True] res = client.json().get("bikes:010") # >>> # { # "model": "Summit", # "brand": "nHill", # "price": 1200, # "type": "Mountain Bike", # "specs": { # "material": "alloy", # "weight": "11.3" # }, # "description": "This budget mountain bike from nHill performs well..." # "description_embeddings": [ # -0.538114607334137, # -0.49465855956077576, # -0.025176964700222015, # ... # ] # } schema = ( TextField("$.model", no_stem=True, as_name="model"), TextField("$.brand", no_stem=True, as_name="brand"), NumericField("$.price", as_name="price"), TagField("$.type", as_name="type"), TextField("$.description", as_name="description"), VectorField( "$.description_embeddings", "FLAT", { "TYPE": "FLOAT32", "DIM": VECTOR_DIMENSION, "DISTANCE_METRIC": "COSINE", }, as_name="vector", ), ) definition = IndexDefinition(prefix=["bikes:"], index_type=IndexType.JSON) res = client.ft("idx:bikes_vss").create_index(fields=schema, definition=definition) # >>> 'OK' info = client.ft("idx:bikes_vss").info() num_docs = info["num_docs"] indexing_failures = info["hash_indexing_failures"] # print(f"{num_docs} documents indexed with {indexing_failures} failures") # >>> 11 documents indexed with 0 failures query = Query("@brand:Peaknetic") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950', 'description_embeddings': ... query = Query("@brand:Peaknetic").return_fields("id", "brand", "model", "price") res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:008', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Soothe Electric bike', # 'price': '1950' # }, # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] query = Query("@brand:Peaknetic @price:[0 1000]").return_fields( "id", "brand", "model", "price" ) res = client.ft("idx:bikes_vss").search(query).docs # print(res) # >>> [ # Document { # 'id': 'bikes:009', # 'payload': None, # 'brand': 'Peaknetic', # 'model': 'Secto', # 'price': '430' # } # ] queries = [ "Bike for small kids", "Best Mountain bikes for kids", "Cheap Mountain bike for kids", "Female specific mountain bike", "Road bike for beginners", "Commuter bike for people over 60", "Comfortable commuter bike", "Good bike for college students", "Mountain bike for beginners", "Vintage bike", "Comfortable city bike", ] encoded_queries = embedder.encode(queries) len(encoded_queries) # >>> 11 def create_query_table(query, queries, encoded_queries, extra_params=None): """ Creates a query table. """ results_list = [] for i, encoded_query in enumerate(encoded_queries): result_docs = ( client.ft("idx:bikes_vss") .search( query, {"query_vector": np.array(encoded_query, dtype=np.float32).tobytes()} | (extra_params if extra_params else {}), ) .docs ) for doc in result_docs: vector_score = round(1 - float(doc.vector_score), 2) results_list.append( { "query": queries[i], "score": vector_score, "id": doc.id, "brand": doc.brand, "model": doc.model, "description": doc.description, } ) # Optional: convert the table to Markdown using Pandas queries_table = pd.DataFrame(results_list) queries_table.sort_values( by=["query", "score"], ascending=[True, False], inplace=True ) queries_table["query"] = queries_table.groupby("query")["query"].transform( lambda x: [x.iloc[0]] + [""] * (len(x) - 1) ) queries_table["description"] = queries_table["description"].apply( lambda x: (x[:497] + "...") if len(x) > 500 else x ) return queries_table.to_markdown(index=False) query = ( Query("(*)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.54 | bikes:003... hybrid_query = ( Query("(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]") .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .dialect(2) ) table = create_query_table(hybrid_query, queries, encoded_queries) print(table) # >>> | Best Mountain bikes for kids | 0.3 | bikes:008... range_query = ( Query( "@vector:[VECTOR_RANGE $range $query_vector]=>" "{$YIELD_DISTANCE_AS: vector_score}" ) .sort_by("vector_score") .return_fields("vector_score", "id", "brand", "model", "description") .paging(0, 4) .dialect(2) ) table = create_query_table( range_query, queries[:1], encoded_queries[:1], {"range": 0.55} ) print(table) # >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |... </code></pre> </div> <button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-steprun_knn_query')" tabindex="1" title="Copy to clipboard"> <svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z"> </path> </svg> <div class="tooltip relative inline-block"> Copied! </div> </button> <button aria-controls="panel_Python_search_vss-steprun_knn_query" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility"> <svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z"> </path> </svg> <svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg"> <path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z"> </path> </svg> </button> <div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible"> <a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start"> Python Quick-Start </a> <div class="w-1/2"> </div> <div class="flex-1 text-right"> <a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example"> <svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg"> <path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd"> </path> </svg> </a> </div> </div> </div> </div> <table> <thead> <tr> <th style="text-align:left"> query </th> <th style="text-align:left"> score </th> <th style="text-align:left"> id </th> <th style="text-align:left"> brand </th> <th style="text-align:left"> model </th> <th style="text-align:left"> description </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> Best Mountain bikes for kids </td> <td style="text-align:left"> 0.54 </td> <td style="text-align:left"> bikes:003 </td> <td style="text-align:left"> Nord </td> <td style="text-align:left"> Chook air 5 </td> <td style="text-align:left"> The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails. The Chook Air 5 is the perfect intro to mountain biking. </td> </tr> <tr> <td style="text-align:left"> </td> <td style="text-align:left"> 0.51 </td> <td style="text-align:left"> bikes:010 </td> <td style="text-align:left"> nHill </td> <td style="text-align:left"> Summit </td> <td style="text-align:left"> This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail riding on the weekends or you’re just after a stable,... </td> </tr> <tr> <td style="text-align:left"> </td> <td style="text-align:left"> 0.46 </td> <td style="text-align:left"> bikes:001 </td> <td style="text-align:left"> Velorim </td> <td style="text-align:left"> Jigger </td> <td style="text-align:left"> Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go. We say rare because this smokin’ little bike is not ideal for a nervous first-time rider, but it’s a true giddy up for a true speedster. The Jigger is a 12 inch lightweight kids bicycle and it will meet your little one’s need for speed. It’s a single... </td> </tr> </tbody> </table> <h2 id="next-steps"> Next steps </h2> <ol> <li> You can learn more about the query options, such as filters and vector range queries, by reading the <a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/vectors/"> vector reference documentation </a> . </li> <li> The complete <a href="/docs/latest/develop/interact/search-and-query/"> Redis Query Engine documentation </a> might be interesting for you. </li> <li> If you want to follow the code examples more interactively, then you can use the <a href="https://github.com/RedisVentures/redis-vss-getting-started/blob/main/vector_similarity_with_redis.ipynb"> Jupyter notebook </a> that inspired this quick start guide. </li> <li> If you want to see more advanced examples of a Redis vector database in action, visit the <a href="https://github.com/redis-developer/redis-ai-resources"> Redis AI Resources </a> page on GitHub. </li> </ol> <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/get-started/vector-database/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/requests/shards/actions/.html

<section class="prose w-full py-12 max-w-none"> <h1> Shard actions requests </h1> REST API requests to perform shard actions <h2 id="migrate"> Migrate </h2> <table> <thead> <tr> <th> Method </th> <th> Path </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/references/rest-api/requests/shards/actions/migrate/#post-multi-shards"> POST </a> </td> <td> <code> /v1/shards/actions/migrate </code> </td> <td> Migrate multiple shards </td> </tr> <tr> <td> <a href="/docs/latest/operate/rs/references/rest-api/requests/shards/actions/migrate/#post-shard"> POST </a> </td> <td> <code> /v1/shards/{uid}/actions/migrate </code> </td> <td> Migrate a specific shard </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/references/rest-api/requests/shards/actions/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/oss_and_stack/stack-with-enterprise/gears-v1/jvm/classes/gearsbuilder/asyncmap/.html

<section class="prose w-full py-12 max-w-none"> <h1> AsyncMap </h1> Asynchronously maps records one-to-one. <div class="highlight"> <pre class="chroma"><code class="language-java" data-lang="java">public <I extends java.io.Serializable> GearsBuilder<I> asyncMap( gears.operations.AsyncMapOperation<T,I> mapper) </code></pre> </div> The <code> asyncMap </code> function allows you to use a <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/classes/gearsfuture/"> <code> GearsFuture </code> </a> object to asynchronously map each input record in the pipe to an output record, one-to-one. <h2 id="parameters"> Parameters </h2> Type parameters: <table> <thead> <tr> <th> Name </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> I </td> <td> The template type of the returned builder </td> </tr> </tbody> </table> Function parameters: <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> mapper </td> <td> AsyncMapOperation<T,I> </td> <td> For each input record, returns a new output record </td> </tr> </tbody> </table> <h2 id="returns"> Returns </h2> Returns a GearsBuilder object with a new template type. <h2 id="example"> Example </h2> <div class="highlight"> <pre class="chroma"><code class="language-java" data-lang="java">GearsBuilder.CreateGearsBuilder(reader). asyncMap(r->{ GearsFuture<String> f = new GearsFuture<String>(); new Thread(new Runnable() { @Override public void run() { try { Thread.sleep(1); f.setResult("done"); } catch (Exception e) { e.printStackTrace(); } } }).start(); return f; }); </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/oss_and_stack/stack-with-enterprise/gears-v1/jvm/classes/gearsbuilder/asyncmap/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/networking/mdns/.html

<section class="prose w-full py-12 max-w-none"> <h1> Client prerequisites for mDNS </h1> Requirements for using the mDNS protocol in development and testing environments. <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> mDNS is only supported for development and testing environments. </div> </div> If you choose to use the mDNS protocol when <a href="/docs/latest/operate/rs/7.4/networking/cluster-dns/"> you set the cluster name </a> , make sure that the configurations and prerequisites for resolving database endpoints are met on the client machines. If you have <a href="/docs/latest/operate/rs/7.4/databases/import-export/replica-of/"> Replica Of </a> databases on the cluster, the configurations and prerequisites are also required for the Redis Enterprise Software nodes. To prepare a client or node for mDNS: <ol> <li> Make sure that the clients and cluster nodes are on the same physical network or have the network infrastructure configured to allow multicasting between them. </li> <li> Install these prerequisite packages: <ul> <li> For Ubuntu: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">apt-get install libnss-mdns </code></pre> </div> </li> <li> For RHEL/CentOS 6.x: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rpm -ivh http://download.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm $ yum install nss-mdns $ service avahi-daemon start </code></pre> </div> </li> <li> For RHEL/CentOS 7: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rpm -ivh https://dl.fedoraproject.org/pub/epel/7/x86_64/Packages/e/epel-release-7-12.noarch.rpm $ yum install nss-mdns $ service avahi-daemon start </code></pre> </div> </li> </ul> </li> <li> If you are using <a href="/docs/latest/operate/rs/networking/multi-ip-ipv6/"> mDNS with IPv6 addresses </a> , update the hosts line in <code> /etc/nsswitch.conf </code> to: <div class="highlight"> <pre class="chroma"><code class="language-yaml" data-lang="yaml">hosts: files mdns4_minimal \[NOTFOUND=return\] mdns </code></pre> </div> </li> </ol> <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/networking/mdns/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/kubernetes/kubernetes-archive/.html

<section class="prose w-full py-12 max-w-none"> <h1> Archive </h1> Describes where to view the archive of Redis Enterprise for Kubernetes documentation. Previous versions of Redis Enterprise for Kubernetes documentation are available on the archived web site: <ul> <li> <a href="https://docs.redis.com/7.4/kubernetes/"> Redis Enterprise for Kubernetes v7.4 documentation archive </a> </li> <li> <a href="https://docs.redis.com/7.2/kubernetes/"> Redis Enterprise for Kubernetes v7.2 documentation archive </a> </li> <li> <a href="https://docs.redis.com/6.4/kubernetes/"> Redis Enterprise for Kubernetes v6.x documentation archive </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/kubernetes/kubernetes-archive/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/oss_and_stack/management/security/encryption/.html

<section class="prose w-full py-12 max-w-none"> <h1> TLS </h1> Redis TLS support SSL/TLS is supported by Redis starting with version 6 as an optional feature that needs to be enabled at compile time. <h2 id="getting-started"> Getting Started </h2> <h3 id="building"> Building </h3> To build with TLS support you'll need OpenSSL development libraries (e.g. <code> libssl-dev </code> on Debian/Ubuntu). Build Redis with the following command: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">make BUILD_TLS=yes </code></pre> </div> <h3 id="tests"> Tests </h3> To run Redis test suite with TLS, you'll need TLS support for TCL (i.e. <code> tcl-tls </code> package on Debian/Ubuntu). <ol> <li> Run <code> ./utils/gen-test-certs.sh </code> to generate a root CA and a server certificate. </li> <li> Run <code> ./runtest --tls </code> or <code> ./runtest-cluster --tls </code> to run Redis and Redis Cluster tests in TLS mode. </li> </ol> <h3 id="running-manually"> Running manually </h3> To manually run a Redis server with TLS mode (assuming <code> gen-test-certs.sh </code> was invoked so sample certificates/keys are available): <pre><code>./src/redis-server --tls-port 6379 --port 0 \ --tls-cert-file ./tests/tls/redis.crt \ --tls-key-file ./tests/tls/redis.key \ --tls-ca-cert-file ./tests/tls/ca.crt </code></pre> To connect to this Redis server with <code> redis-cli </code> : <pre><code>./src/redis-cli --tls \ --cert ./tests/tls/redis.crt \ --key ./tests/tls/redis.key \ --cacert ./tests/tls/ca.crt </code></pre> <h3 id="certificate-configuration"> Certificate configuration </h3> In order to support TLS, Redis must be configured with a X.509 certificate and a private key. In addition, it is necessary to specify a CA certificate bundle file or path to be used as a trusted root when validating certificates. To support DH based ciphers, a DH params file can also be configured. For example: <pre tabindex="0"><code>tls-cert-file /path/to/redis.crt tls-key-file /path/to/redis.key tls-ca-cert-file /path/to/ca.crt tls-dh-params-file /path/to/redis.dh </code></pre> <h3 id="tls-listening-port"> TLS listening port </h3> The <code> tls-port </code> configuration directive enables accepting SSL/TLS connections on the specified port. This is in addition to listening on <code> port </code> for TCP connections, so it is possible to access Redis on different ports using TLS and non-TLS connections simultaneously. You may specify <code> port 0 </code> to disable the non-TLS port completely. To enable only TLS on the default Redis port, use: <pre tabindex="0"><code>port 0 tls-port 6379 </code></pre> <h3 id="client-certificate-authentication"> Client certificate authentication </h3> By default, Redis uses mutual TLS and requires clients to authenticate with a valid certificate (authenticated against trusted root CAs specified by <code> ca-cert-file </code> or <code> ca-cert-dir </code> ). You may use <code> tls-auth-clients no </code> to disable client authentication. <h3 id="replication"> Replication </h3> A Redis master server handles connecting clients and replica servers in the same way, so the above <code> tls-port </code> and <code> tls-auth-clients </code> directives apply to replication links as well. On the replica server side, it is necessary to specify <code> tls-replication yes </code> to use TLS for outgoing connections to the master. <h3 id="cluster"> Cluster </h3> When Redis Cluster is used, use <code> tls-cluster yes </code> in order to enable TLS for the cluster bus and cross-node connections. <h3 id="sentinel"> Sentinel </h3> Sentinel inherits its networking configuration from the common Redis configuration, so all of the above applies to Sentinel as well. When connecting to master servers, Sentinel will use the <code> tls-replication </code> directive to determine if a TLS or non-TLS connection is required. In addition, the very same <code> tls-replication </code> directive will determine whether Sentinel's port, that accepts connections from other Sentinels, will support TLS as well. That is, Sentinel will be configured with <code> tls-port </code> if and only if <code> tls-replication </code> is enabled. <h3 id="additional-configuration"> Additional configuration </h3> Additional TLS configuration is available to control the choice of TLS protocol versions, ciphers and cipher suites, etc. Please consult the self documented <code> redis.conf </code> for more information. <h3 id="performance-considerations"> Performance considerations </h3> TLS adds a layer to the communication stack with overheads due to writing/reading to/from an SSL connection, encryption/decryption and integrity checks. Consequently, using TLS results in a decrease of the achievable throughput per Redis instance (for more information refer to this <a href="https://github.com/redis/redis/issues/7595"> discussion </a> ). <h3 id="limitations"> Limitations </h3> I/O threading is currently not supported with TLS. <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/oss_and_stack/management/security/encryption/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/xgroup/.html

<section class="prose w-full py-12"> <h1 class="command-name"> XGROUP </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">XGROUP</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"> Depends on subcommand. </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @slow </code> , </dd> </dl> This is a container command for stream consumer group management commands. To see the list of available commands you can call <a href="/docs/latest/commands/xgroup-help/"> <code> XGROUP HELP </code> </a> . <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/xgroup/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/command/.html

<section class="prose w-full py-12"> <h1 class="command-name"> COMMAND </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">COMMAND</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"> 2.8.13 </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 Redis commands </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @slow </code> , <code> @connection </code> , </dd> </dl> Return an array with details about every Redis command. The <code> COMMAND </code> command is introspective. Its reply describes all commands that the server can process. Redis clients can call it to obtain the server's runtime capabilities during the handshake. <code> COMMAND </code> also has several subcommands. Please refer to its subcommands for further details. Cluster note: this command is especially beneficial for cluster-aware clients. Such clients must identify the names of keys in commands to route requests to the correct shard. Although most commands accept a single key as their first argument, there are many exceptions to this rule. You can call <code> COMMAND </code> and then keep the mapping between commands and their respective key specification rules cached in the client. The reply it returns is an array with an element per command. Each element that describes a Redis command is represented as an array by itself. The command's array consists of a fixed number of elements. The exact number of elements in the array depends on the server's version. <ol> <li> Name </li> <li> Arity </li> <li> Flags </li> <li> First key </li> <li> Last key </li> <li> Step </li> <li> <a href="/operate/oss_and_stack/management/security/acl"> ACL categories </a> (as of Redis 6.0) </li> <li> <a href="/develop/reference/command-tips.md"> Tips </a> (as of Redis 7.0) </li> <li> <a href="/develop/reference/key-specs.md"> Key specifications </a> (as of Redis 7.0) </li> <li> Subcommands (as of Redis 7.0) </li> </ol> <h2 id="name"> Name </h2> This is the command's name in lowercase. Note: Redis command names are case-insensitive. <h2 id="arity"> Arity </h2> Arity is the number of arguments a command expects. It follows a simple pattern: <ul> <li> A positive integer means a fixed number of arguments. </li> <li> A negative integer means a minimal number of arguments. </li> </ul> Command arity always includes the command's name itself (and the subcommand when applicable). Examples: <ul> <li> <a href="/docs/latest/commands/get/"> <code> GET </code> </a> 's arity is 2 since the command only accepts one argument and always has the format <code> GET _key_ </code> . </li> <li> <a href="/docs/latest/commands/mget/"> <code> MGET </code> </a> 's arity is -2 since the command accepts at least one argument, but possibly multiple ones: <code> MGET _key1_ [key2] [key3] ... </code> . </li> </ul> <h2 id="flags"> Flags </h2> Command flags are an array. It can contain the following simple strings (status reply): <ul> <li> admin: the command is an administrative command. </li> <li> asking: the command is allowed even during hash slot migration. This flag is relevant in Redis Cluster deployments. </li> <li> blocking: the command may block the requesting client. </li> <li> denyoom : the command is rejected if the server's memory usage is too high (see the maxmemory configuration directive). </li> <li> fast: the command operates in constant or log(N) time. This flag is used for monitoring latency with the <a href="/docs/latest/commands/latency/"> <code> LATENCY </code> </a> command. </li> <li> loading: the command is allowed while the database is loading. </li> <li> movablekeys: the first key , last key , and step values don't determine all key positions. Clients need to use <a href="/docs/latest/commands/command-getkeys/"> <code> COMMAND GETKEYS </code> </a> or <a href="/develop/reference/key-specs.md"> key specifications </a> in this case. See below for more details. </li> <li> no_auth: executing the command doesn't require authentication. </li> <li> no_async_loading: the command is denied during asynchronous loading (that is when a replica uses disk-less <code> SWAPDB SYNC </code> , and allows access to the old dataset). </li> <li> no_mandatory_keys: the command may accept key name arguments, but these aren't mandatory. </li> <li> no_multi: the command isn't allowed inside the context of a <a href="/docs/latest/develop/interact/transactions/"> transaction </a> . </li> <li> noscript: the command can't be called from <a href="/docs/latest/develop/interact/programmability/eval-intro/"> scripts </a> or <a href="/docs/latest/develop/interact/programmability/functions-intro/"> functions </a> . </li> <li> pubsub: the command is related to <a href="/docs/latest/develop/interact/pubsub/"> Redis Pub/Sub </a> . </li> <li> random : the command returns random results, which is a concern with verbatim script replication. As of Redis 7.0, this flag is a <a href="/develop/reference/command-tips.md"> command tip </a> . </li> <li> readonly: the command doesn't modify data. </li> <li> sort_for_script: the command's output is sorted when called from a script. </li> <li> skip_monitor: the command is not shown in <a href="/docs/latest/commands/monitor/"> <code> MONITOR </code> </a> 's output. </li> <li> skip_slowlog: the command is not shown in <a href="/docs/latest/commands/slowlog/"> <code> SLOWLOG </code> </a> 's output. As of Redis 7.0, this flag is a <a href="/develop/reference/command-tips.md"> command tip </a> . </li> <li> stale: the command is allowed while a replica has stale data. </li> <li> write: the command may modify data. </li> </ul> <h3 id="movablekeys"> Movablekeys </h3> Consider <a href="/docs/latest/commands/sort/"> <code> SORT </code> </a> : <pre tabindex="0"><code>1) 1) "sort" 2) (integer) -2 3) 1) write 2) denyoom 3) movablekeys 4) (integer) 1 5) (integer) 1 6) (integer) 1 ... </code></pre> Some Redis commands have no predetermined key locations or are not easy to find. For those commands, the movablekeys flag indicates that the first key , last key , and step values are insufficient to find all the keys. Here are several examples of commands that have the movablekeys flag: <ul> <li> <a href="/docs/latest/commands/sort/"> <code> SORT </code> </a> : the optional STORE , BY , and GET modifiers are followed by names of keys. </li> <li> <a href="/docs/latest/commands/zunion/"> <code> ZUNION </code> </a> : the numkeys argument specifies the number key name arguments. </li> <li> <a href="/docs/latest/commands/migrate/"> <code> MIGRATE </code> </a> : the keys appear KEYS keyword and only when the second argument is the empty string. </li> </ul> Redis Cluster clients need to use other measures, as follows, to locate the keys for such commands. You can use the <a href="/docs/latest/commands/command-getkeys/"> <code> COMMAND GETKEYS </code> </a> command and have your Redis server report all keys of a given command's invocation. As of Redis 7.0, clients can use the <a href="#key-specifications"> key specifications </a> to identify the positions of key names. The only commands that require using <a href="/docs/latest/commands/command-getkeys/"> <code> COMMAND GETKEYS </code> </a> are <a href="/docs/latest/commands/sort/"> <code> SORT </code> </a> and <a href="/docs/latest/commands/migrate/"> <code> MIGRATE </code> </a> for clients that parse keys' specifications. For more information, please refer to the <a href="/develop/reference/key-specs.md"> key specifications page </a> . <h2 id="first-key"> First key </h2> The position of the command's first key name argument. For most commands, the first key's position is 1. Position 0 is always the command name itself. <h2 id="last-key"> Last key </h2> The position of the command's last key name argument. Redis commands usually accept one, two or multiple number of keys. Commands that accept a single key have both first key and last key set to 1. Commands that accept two key name arguments, e.g. <a href="/docs/latest/commands/brpoplpush/"> <code> BRPOPLPUSH </code> </a> , <a href="/docs/latest/commands/smove/"> <code> SMOVE </code> </a> and <a href="/docs/latest/commands/rename/"> <code> RENAME </code> </a> , have this value set to the position of their second key. Multi-key commands that accept an arbitrary number of keys, such as <a href="/docs/latest/commands/mset/"> <code> MSET </code> </a> , use the value -1. <h2 id="step"> Step </h2> The step, or increment, between the first key and the position of the next key. Consider the following two examples: <pre tabindex="0"><code>1) 1) "mset" 2) (integer) -3 3) 1) write 2) denyoom 4) (integer) 1 5) (integer) -1 6) (integer) 2 ... </code></pre> <pre tabindex="0"><code>1) 1) "mget" 2) (integer) -2 3) 1) readonly 2) fast 4) (integer) 1 5) (integer) -1 6) (integer) 1 ... </code></pre> The step count allows us to find keys' positions. For example <a href="/docs/latest/commands/mset/"> <code> MSET </code> </a> : Its syntax is <code> MSET _key1_ _val1_ [key2] [val2] [key3] [val3]... </code> , so the keys are at every other position (step value of 2 ). Unlike <a href="/docs/latest/commands/mget/"> <code> MGET </code> </a> , which uses a step value of 1 . <h2 id="acl-categories"> ACL categories </h2> This is an array of simple strings that are the ACL categories to which the command belongs. Please refer to the <a href="/operate/oss_and_stack/management/security/acl"> Access Control List </a> page for more information. <h2 id="command-tips"> Command tips </h2> Helpful information about the command. To be used by clients/proxies. Please check the <a href="/develop/reference/command-tips.md"> Command tips </a> page for more information. <h2 id="key-specifications"> Key specifications </h2> This is an array consisting of the command's key specifications. Each element in the array is a map describing a method for locating keys in the command's arguments. For more information please check the <a href="/develop/reference/key-specs.md"> key specifications page </a> . <h2 id="subcommands"> Subcommands </h2> This is an array containing all of the command's subcommands, if any. Some Redis commands have subcommands (e.g., the <code> REWRITE </code> subcommand of <a href="/docs/latest/commands/config/"> <code> CONFIG </code> </a> ). Each element in the array represents one subcommand and follows the same specifications as those of <code> COMMAND </code> 's reply. <h2 id="examples"> Examples </h2> The following is <code> COMMAND </code> 's output for the <a href="/docs/latest/commands/get/"> <code> GET </code> </a> command: <pre tabindex="0"><code>1) 1) "get" 2) (integer) 2 3) 1) readonly 2) fast 4) (integer) 1 5) (integer) 1 6) (integer) 1 7) 1) @read 2) @string 3) @fast 8) (empty array) 9) 1) 1) "flags" 2) 1) read 3) "begin_search" 4) 1) "type" 2) "index" 3) "spec" 4) 1) "index" 2) (integer) 1 5) "find_keys" 6) 1) "type" 2) "range" 3) "spec" 4) 1) "lastkey" 2) (integer) 0 3) "keystep" 4) (integer) 1 5) "limit" 6) (integer) 0 10) (empty array) ... </code></pre> <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> <a href="../../develop/reference/protocol-spec#arrays"> Array reply </a> : a nested list of command details. The order of the commands in the array is random. <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/command/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/requests/proxies/.html

<section class="prose w-full py-12 max-w-none"> <h1> Proxy requests </h1> Proxy requests <table> <thead> <tr> <th> Method </th> <th> Path </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="#get-all-proxies"> GET </a> </td> <td> <code> /v1/proxies </code> </td> <td> Get all proxies </td> </tr> <tr> <td> <a href="#get-proxy"> GET </a> </td> <td> <code> /v1/proxies/{uid} </code> </td> <td> Get a proxy </td> </tr> <tr> <td> <a href="#put-proxy"> PUT </a> </td> <td> <code> /v1/proxies/{uid} </code> </td> <td> Update a proxy </td> </tr> <tr> <td> <a href="#put-all-proxies"> PUT </a> </td> <td> <code> /v1/proxies </code> </td> <td> Update all proxies </td> </tr> </tbody> </table> <h2 id="get-all-proxies"> Get all proxies </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /v1/proxies </code></pre> </div> Get all the proxies in the cluster. <h3 id="permissions"> Permissions </h3> <table> <thead> <tr> <th> Permission name </th> <th> Roles </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_all_proxies_info"> view_all_proxies_info </a> </td> <td> admin cluster_member cluster_viewer db_member db_viewer </td> </tr> </tbody> </table> <h3 id="get-all-request"> Request </h3> <h4 id="example-http-request"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /proxies </code></pre> </div> <h4 id="headers"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> Host </td> <td> cnm.cluster.fqdn </td> <td> Domain name </td> </tr> <tr> <td> Accept </td> <td> application/json </td> <td> Accepted media type </td> </tr> </tbody> </table> <h3 id="get-all-response"> Response </h3> Returns a JSON array of <a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/proxy/"> proxy objects </a> . <h4 id="example-json-body"> Example JSON body </h4> <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">[ { "uid": 1, "client_keepintvl": 30, "max_worker_server_conns": 16384, "client_keepcnt": 6, "max_threads": 64, "ignore_bdb_cconn_output_buff_limits": false, "dynamic_threads_scaling": false, "max_worker_client_conns": 16384, "max_servers": 4096, "client_keepidle": 180, "duration_usage_threshold": 30, "max_worker_txns": 65536, "threads": 3, "max_listeners": 1024, "conns": 500000, "ignore_bdb_cconn_limit": false, "threads_usage_threshold": 80, "backlog": 1024 }, { "uid": 2, "threads": 3, // additional fields... } ] </code></pre> </div> <h3 id="get-all-status-codes"> Status codes </h3> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> No error </td> </tr> </tbody> </table> <h2 id="get-proxy"> Get proxy </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /v1/proxies/{int: uid} </code></pre> </div> Get a single proxy's info. <h3 id="permissions-1"> Permissions </h3> <table> <thead> <tr> <th> Permission name </th> <th> Roles </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_proxy_info"> view_proxy_info </a> </td> <td> admin cluster_member cluster_viewer db_member db_viewer </td> </tr> </tbody> </table> <h3 id="get-request"> Request </h3> <h4 id="example-http-request-1"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /proxies/1 </code></pre> </div> <h4 id="headers-1"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> Host </td> <td> cnm.cluster.fqdn </td> <td> Domain name </td> </tr> <tr> <td> Accept </td> <td> application/json </td> <td> Accepted media type </td> </tr> </tbody> </table> <h4 id="url-parameters"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> uid </td> <td> integer </td> <td> The proxy's unique node ID </td> </tr> </tbody> </table> <h3 id="get-response"> Response </h3> Returns a <a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/proxy/"> proxy object </a> . <h4 id="example-json-body-1"> Example JSON body </h4> <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "uid": 1, "client_keepintvl": 30, "max_worker_server_conns": 16384, "client_keepcnt": 6, "max_threads": 64, "ignore_bdb_cconn_output_buff_limits": false, "dynamic_threads_scaling": false, "max_worker_client_conns": 16384, "max_servers": 4096, "client_keepidle": 180, "duration_usage_threshold": 30, "max_worker_txns": 65536, "threads": 3, "max_listeners": 1024, "conns": 500000, "ignore_bdb_cconn_limit": false, "threads_usage_threshold": 80, "backlog": 1024 } </code></pre> </div> <h3 id="get-status-codes"> Status codes </h3> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> No error </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Proxy UID does not exist </td> </tr> </tbody> </table> <h2 id="put-proxy"> Update proxy </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">PUT /v1/proxies/{int: uid} </code></pre> </div> Updates a proxy object, notifies the proxy, and waits for acknowledgment (ACK) unless the node is dead. Automatically restarts the proxy service if <code> allow_restart </code> is <code> true </code> and any updated parameters require a restart for the changes to take effect. For example, a restart is required if you change <code> threads </code> to a lower number. However, if <code> allow_restart </code> is <code> false </code> , such changes only take effect after the next proxy restart. <h3 id="permissions-2"> Permissions </h3> <table> <thead> <tr> <th> Permission name </th> <th> Roles </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#update_proxy"> update_proxy </a> </td> <td> admin </td> </tr> </tbody> </table> <h3 id="put-request"> Request </h3> <h4 id="example-http-request-2"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">PUT /proxies/1 </code></pre> </div> <h4 id="example-json-body-2"> Example JSON body </h4> <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "allow_restart": true, "proxy": { "threads": 8 } } </code></pre> </div> <h4 id="headers-2"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> Host </td> <td> cnm.cluster.fqdn </td> <td> Domain name </td> </tr> <tr> <td> Accept </td> <td> application/json </td> <td> Accepted media type </td> </tr> <tr> <td> Content-Type </td> <td> application/json </td> <td> Request body media type </td> </tr> </tbody> </table> <h4 id="url-parameters-1"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> uid </td> <td> integer </td> <td> The unique ID of the updated proxy. Corresponds to the node ID. </td> </tr> </tbody> </table> <h4 id="request-body"> Request body </h4> Include a JSON object in the request body. The JSON object can contain the boolean field <code> allow_restart </code> and a <a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/proxy/"> proxy object </a> with updated fields. <h3 id="put-response"> Response </h3> Returns a status code to indicate the success or failure of the proxy update. <h3 id="put-status-codes"> Status codes </h3> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> No error, the request has been processed </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"> 400 Bad Request </a> </td> <td> Bad content provided </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Proxy does not exist </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"> 500 Internal Server Error </a> </td> <td> Error while waiting for confirmation from proxy </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.5"> 504 Gateway Timeout </a> </td> <td> Timeout while waiting for confirmation from proxy </td> </tr> </tbody> </table> <h2 id="put-all-proxies"> Update all proxies </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">PUT /v1/proxies </code></pre> </div> Updates all the proxy objects, notifies the proxies, and waits for acknowledgment (ACK) unless the node is dead. Automatically restarts the relevant proxy services if <code> allow_restart </code> is <code> true </code> and any updated parameters require a restart for the changes to take effect. However, if <code> allow_restart </code> is <code> false </code> , such changes only take effect after the next proxy restart. <h3 id="permissions-3"> Permissions </h3> <table> <thead> <tr> <th> Permission name </th> <th> Roles </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#update_proxy"> update_proxy </a> </td> <td> admin </td> </tr> </tbody> </table> <h3 id="put-all-request"> Request </h3> <h4 id="example-http-request-3"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">PUT /proxies </code></pre> </div> <h4 id="example-json-body-3"> Example JSON body </h4> <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "allow_restart": true, "proxy": { "threads": 8, "max_threads": 12 } } </code></pre> </div> <h4 id="headers-3"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> Host </td> <td> cnm.cluster.fqdn </td> <td> Domain name </td> </tr> <tr> <td> Accept </td> <td> application/json </td> <td> Accepted media type </td> </tr> <tr> <td> Content-Type </td> <td> application/json </td> <td> Request body media type </td> </tr> </tbody> </table> <h4 id="request-body-1"> Request body </h4> Include a JSON object in the request body. The JSON object can contain the boolean field <code> allow_restart </code> and a <a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/proxy/"> proxy object </a> with updated fields. <h3 id="put-all-response"> Response </h3> Returns a status code to indicate the success or failure of the proxy updates. <h3 id="put-all-status-codes"> Status codes </h3> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> No error, the request has been processed </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"> 400 Bad Request </a> </td> <td> Bad content provided </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"> 500 Internal Server Error </a> </td> <td> Error while waiting for confirmation from proxy </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.5"> 504 Gateway Timeout </a> </td> <td> Timeout while waiting for confirmation from proxy </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/rest-api/requests/proxies/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/requests/crdbs/.html

<section class="prose w-full py-12 max-w-none"> <h1> CRDBs requests </h1> Active-Active database requests <table> <thead> <tr> <th> Method </th> <th> Path </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="#get-all-crdbs"> GET </a> </td> <td> <code> /v1/crdbs </code> </td> <td> Get all Active-Active databases </td> </tr> <tr> <td> <a href="#get-crdb"> GET </a> </td> <td> <code> /v1/crdbs/{crdb_guid} </code> </td> <td> Get a specific Active-Active database </td> </tr> <tr> <td> <a href="#patch-crdbs"> PATCH </a> </td> <td> <code> /v1/crdbs/{crdb_guid} </code> </td> <td> Update an Active-Active database </td> </tr> <tr> <td> <a href="#post-crdb"> POST </a> </td> <td> <code> /v1/crdbs </code> </td> <td> Create a new Active-Active database </td> </tr> <tr> <td> <a href="#delete-crdb"> DELETE </a> </td> <td> <code> /v1/crdbs/{crdb_guid} </code> </td> <td> Delete an Active-Active database </td> </tr> </tbody> </table> <h2 id="get-all-crdbs"> Get all Active-Active databases </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /v1/crdbs </code></pre> </div> Get a list of all Active-Active databases on the cluster. <h3 id="get-all-request"> Request </h3> <h4 id="example-http-request"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /crdbs </code></pre> </div> <h4 id="headers"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> X-Task-ID </td> <td> string </td> <td> Specified task ID </td> </tr> <tr> <td> X-Result-TTL </td> <td> integer </td> <td> Time (in seconds) to keep task result </td> </tr> </tbody> </table> <h3 id="get-all-response"> Response </h3> Returns a JSON array of <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb/"> CRDB objects </a> . <h5 id="get-all-status-codes"> Status codes </h5> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> A list of Active-Active database. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"> 401 Unauthorized </a> </td> <td> Unauthorized request. Invalid credentials </td> </tr> </tbody> </table> <h2 id="get-crdb"> Get an Active-Active database </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /v1/crdbs/{crdb_guid} </code></pre> </div> Get a specific Active-Active database. <h3 id="get-request"> Request </h3> <h4 id="example-http-request-1"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh"> GET /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 </code></pre> </div> <h4 id="headers-1"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> X-Task-ID </td> <td> string </td> <td> Specified task ID </td> </tr> <tr> <td> X-Result-TTL </td> <td> integer </td> <td> Time (in seconds) to keep task result </td> </tr> </tbody> </table> <h4 id="url-parameters"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> crdb_guid </td> <td> string </td> <td> Globally unique Active-Active database ID (GUID) </td> </tr> </tbody> </table> <h4 id="query-parameters"> Query parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> instance_id </td> <td> integer </td> <td> Instance from which to get the Active-Active database information </td> </tr> </tbody> </table> <h3 id="get-response"> Response </h3> Returns a <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb/"> CRDB object </a> . <h4 id="get-status-codes"> Status codes </h4> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> Active-Active database information is returned. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"> 401 Unauthorized </a> </td> <td> Unauthorized request. Invalid credentials </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Database or configuration does not exist. </td> </tr> </tbody> </table> <h2 id="patch-crdbs"> Update an Active-Active database </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">PATCH /v1/crdbs/{crdb_guid} </code></pre> </div> Update an Active-Active database's configuration. In order to add or remove instances, use <a href="/docs/latest/operate/rs/references/rest-api/requests/crdbs/updates/#post-crdbs-updates"> <code> POST crdbs/{crdb_guid}/updates </code> </a> instead. <h3 id="patch-request"> Request </h3> <h4 id="example-http-request-2"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh"> PATCH /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 </code></pre> </div> <h4 id="headers-2"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> X-Task-ID </td> <td> string </td> <td> Specified task ID </td> </tr> <tr> <td> X-Result-TTL </td> <td> integer </td> <td> Time (in seconds) to keep task result </td> </tr> </tbody> </table> <h4 id="url-parameters-1"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> crdb_guid </td> <td> string </td> <td> Globally unique Active-Active database ID (GUID) </td> </tr> </tbody> </table> <h4 id="request-body"> Request body </h4> Include a <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb/"> CRDB object </a> with updated fields in the request body. <h3 id="patch-response"> Response </h3> Returns a <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb_task/"> CRDB task object </a> . <h4 id="patch-status-codes"> Status codes </h4> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> The request has been accepted. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"> 400 Bad Request </a> </td> <td> The posted Active-Active database contains invalid parameters. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"> 401 Unauthorized </a> </td> <td> Unauthorized request. Invalid credentials </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Configuration or Active-Active database not found. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"> 406 Not Acceptable </a> </td> <td> The posted Active-Active database cannot be accepted. </td> </tr> </tbody> </table> <h2 id="post-crdb"> Create an Active-Active database </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">POST /v1/crdbs </code></pre> </div> Create a new Active-Active database. <h3 id="post-request"> Request </h3> <h4 id="example-http-request-3"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh"> POST /crdbs </code></pre> </div> <h4 id="headers-3"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> X-Task-ID </td> <td> string </td> <td> Specified task ID </td> </tr> <tr> <td> X-Result-TTL </td> <td> integer </td> <td> Time (in seconds) to keep task result </td> </tr> </tbody> </table> <h4 id="request-body-1"> Request body </h4> Include a <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb/"> CRDB object </a> , which defines the Active-Active database, in the request body. <h5 id="example-body"> Example body </h5> <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "default_db_config": { "name": "sample-crdb", "memory_size": 214748365 }, "instances": [ { "cluster": { "url": "http://<cluster1_FQDN>:9443", "credentials": { "username": "<username>", "password": "<password>" }, "name": "cluster-1" }, "compression": 6 }, { "cluster": { "url": "http://<cluster2_FQDN>:9443", "credentials": { "username": "<username>", "password": "<password>" }, "name": "cluster-2" }, "compression": 6 } ], "name": "sample-crdb" } </code></pre> </div> This JSON body creates an Active-Active database without TLS and with two participating clusters. <h3 id="post-response"> Response </h3> Returns a <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb_task/"> CRDB task object </a> . <h4 id="post-status-codes"> Status codes </h4> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> The request has been accepted. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"> 400 Bad Request </a> </td> <td> The request is invalid or malformed. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"> 401 Unauthorized </a> </td> <td> Unauthorized request. Invalid credentials </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"> 406 Not Acceptable </a> </td> <td> The posted Active-Active database cannot be accepted. </td> </tr> </tbody> </table> <h2 id="delete-crdb"> Delete an Active-Active database </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">DELETE /v1/crdbs/{crdb_guid} </code></pre> </div> Delete an Active-Active database. <h3 id="delete-request"> Request </h3> <h4 id="example-http-request-4"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh"> DELETE /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 </code></pre> </div> <h4 id="headers-4"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> X-Task-ID </td> <td> string </td> <td> Specified task ID </td> </tr> <tr> <td> X-Result-TTL </td> <td> integer </td> <td> Time (in seconds) to keep task result </td> </tr> </tbody> </table> <h4 id="url-parameters-2"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> crdb_guid </td> <td> string </td> <td> Globally unique Active-Active database ID (GUID) </td> </tr> </tbody> </table> <h3 id="delete-response"> Response </h3> Returns a <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb_task/"> CRDB task object </a> . <h4 id="delete-status-codes"> Status codes </h4> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> Action was successful. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"> 401 Unauthorized </a> </td> <td> Unauthorized request. Invalid credentials </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Configuration or Active-Active database not found. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"> 406 Not Acceptable </a> </td> <td> The Active-Active GUID is invalid or the Active-Active database was already deleted. </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/references/rest-api/requests/crdbs/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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-4-4-dec-2016/.html

<section class="prose w-full py-12 max-w-none"> <h1> RLEC 4.4 Release Notes (December 2016) </h1> If you are upgrading from a previous version, make sure to review the <a href="/docs/latest/operate/rs/installing-upgrading/upgrading/"> upgrade instructions </a> before beginning the upgrade process. You can upgrade to this version from any 4.3 version. If you have a version older than 4.3 you must first upgrade to 4.3 and only then upgrade to this version. <h2 id="new-features"> New features </h2> <ul> <li> Databases can now be configured to have multiple proxies for improved performance. Note that when you upgrade the cluster to this version and then upgrade existing databases, the databases will be updated to use the Single proxy policy and Dense shard placement policy. For additional details, refer to <a href="/docs/latest/operate/rs/databases/configure/proxy-policy/"> Multiple active proxies </a> . </li> <li> Support for Redis version 3.2 added. When you install or upgrade the cluster the new default version for Redis databases will be 3.2 and when you upgrade the databases they will be updated to this version. If you would like to change the default version to Redis 3.0, refer to the instruction in the <a href="/docs/latest/operate/rs/installing-upgrading/upgrading/"> Upgrading databases </a> If you would like to upgrade existing databases to the latest 3.0 minor version, refer to the Known Issues section below. </li> <li> The cluster can now be configured to support both private and public IPs to connect to database endpoints through both public and private networks. For additional details, refer to <a href="/docs/latest/operate/rs/networking/private-public-endpoints/"> Private and Public Endpoints </a> . </li> <li> rladmin status command output has been enhanced to include an indication on which node rladmin is running by adding the '*' sign next to the node entry, and to show the host name of the machine the node is running on. </li> <li> Users can now be assigned security roles to control what level of the databases or cluster the users can view and/or edit. </li> </ul> <h2 id="changes"> Changes </h2> <ul> <li> As result of adding the support for multiple proxies for a database, the following changes have been made: <ul> <li> When you upgrade the cluster to this version and then upgrade existing databases, the databases will be updated to use the Single proxy policy and Dense shard placement policy. </li> <li> rladmin status command output has been updated. </li> <li> failover [db <db:id | name>] endpoint <id1 .. idN> and migrate [db <db:id | name> | node <origin node:id>] endpoint <id> target_node <id> commands are no longer relevant for databases using the single | all-master-shards | all-nodes proxy policy. Instead proxies can be bound or unbounded to databases as needed. </li> <li> New rladmin commands were added, such as bind and placement . </li> </ul> </li> <li> RLEC has been updated to remove the need to use sudo in runtime. You still need to be root or use sudo when initially installing RLEC. </li> <li> You no longer need to be root or use sudo to run the rladmin command, now it is preferred to be a non-privileged user that is member of the redislabs group to run the command. </li> <li> All cluster services are now run using the supervisor mechanism. As a result starting, stopping and restarting RLEC services should be done using supervisorctl command from the OS CLI. </li> <li> Linux OS vm.swappiness is now advised to be set to zero, for more information see <a href="/docs/latest/operate/rs/installing-upgrading/configuring/linux-swap/"> Disabling Swap in Linux </a> . </li> </ul> <h2 id="important-fixed-issues-since-430"> Important fixed issues since 4.3.0 </h2> <ul> <li> RLEC-7542 - Add ability to create and manage role based user security </li> <li> RLEC-8283 - The cluster recovery process does not work properly when the cluster that needs to be recovered does not have a node with ID 1. </li> <li> RLEC-8284 - Add functionality to rladmin to mark a node as a quorum only node </li> <li> RLEC-8498 - Backup fails under rare conditions </li> <li> RLEC-8579 - rladmin supports uppercase for external_addr value </li> <li> RLEC-8656 - Fixed conflict with SELinux </li> <li> RLEC-8687 - Fixed issue where strong password requirements were not honored correctly. </li> <li> RLEC-8694 - DMC failed while creating DB with 75 (150 replicated) shards </li> <li> RLEC-8700 - Fixed issue with network split scenario </li> <li> RLEC-8833 - Fixed issue where in some cases endpoint were not getting new IPs after node replacement. </li> <li> RLEC-9069 - Fixed issue related to RHEL 7 and IPv6. </li> <li> RLEC-9156 - Fixed issue causing a full resync of data when a source or destination failure occurred. </li> <li> RLEC-9173 - Issue with writing data after master and replica failed </li> <li> RLEC-9235 - Issue with SSL connection error and self signed certificates </li> <li> RLEC-9491 - Fixed alerting issue due to incorrect measurement </li> <li> RLEC-9534 - Fixed issue with node remove command after RLEC uninstalled </li> <li> RLEC-9658 - Failed to import backup file from FTP server. </li> <li> RLEC-9737 - Fixed issue with backup process to use ephemeral storage when needed </li> <li> RLEC-9761 - UI had incorrect value increments </li> <li> RLEC-9827 - Server with a high number of cores and running RHEL can have issues running systune.sh </li> <li> RLEC-9853 - Fixed issues with logrotate on RHEL 7.1 so it runs as non-privileged user </li> <li> RLEC-9858 - If proxy crashed, in some cases this would prevent completion of redis failover process </li> <li> RLEC-9893 - DB recovery process doesn't recognize original rack name when in uppercase </li> <li> RLEC-9905 - x.509 certificate signed by custom CA cannot be loaded in UI </li> <li> RLEC-9925 - master endpoint and shards goes down if co-hosted with master of the cluster and the node goes down (single proxy policy) </li> <li> RLEC-9926 - Master shard could remain down if on the same node as the master of the cluster and the entire node goes down </li> <li> RLEC-10340 - Fixed a typo that crashed rladmin status output in some cases </li> </ul> Changes in 4.4.2-42: <ul> <li> RLEC-11941 - Upgrade to 4.4.2-35 on RHEL6 - leash failed when python2.6 is installed </li> <li> RLEC-11994 - RLEC 4.4.2-35: the UI doesn't display the DBs with replication </li> </ul> Changes in 4.4.2 - 49 <ul> <li> RLEC-11209 - Unable to run upgrade due to running_actions check </li> <li> RLEC-12647 - Backup to S3 with periods in bucket name are failing in some cases </li> </ul> <h2 id="known-issues"> Known issues </h2> <ul> <li> Issue: When upgrading to this version from a previous RLEC version, rladmin status output will show the database status as having an old version. When you upgrade the Redis database (using rladmin upgrade db command) the Redis version will be updated to 3.2 even if you updated the cluster's Redis default version to 3.0. Workaround: If you would like to cancel the old version indication in rladmin status without upgrading the Redis version to 3.2 you should run the rladmin upgrade db command with the keep_current_version flag which will ensure the database is upgraded to the latest 3.0 version supported by RLEC. </li> <li> Issue: RLEC-9200 - in a database configured with multiple proxies, if a client sends the MONITOR, CLIENT LIST or CLIENT KILL commands, only commands from clients connected from the same proxy are returned instead of all commands from all connections. Workaround: If you would like to get a result across all clients, you need to send the monitor command to all proxies and aggregate them. </li> <li> Issue: RLEC-9296 - Different actions in the cluster, like node failure or taking a node offline, might cause the Proxy policy to change Manual. Workaround: You can use the rladmin bind [db <db:id | name>] endpoint <id> policy <single | all-master-shards | all-nodes> command to set the policy back to the required policy, which will ensure all needed proxies are bounded. Note that existing client connections might disconnected as result of this process. </li> <li> Issue: RLEC-8787 - In some cases when using the replica-of feature, if the source database(s) are larget than the target database, the memory limit on the target database is not enforced and that used memory of the target database can go over the memory limit set. Workaround: You should make sure that the total memory limit of all source databases is not bigger than the memory limit of the target database. </li> <li> Issue: RLEC-8487 - Some Redis processes stay running after purging RLEC from the machine and causes an attempt to reinstall RLEC to fail. Workaround: Run the purge process for a second time and ensure that the Redis processes were removed. </li> <li> Issue: RLEC-8747 - When upgrading to this version, if the UI is open in the browser the UI might not work properly after the upgrade. Workaround: Refresh the browser and the UI will return to work properly. </li> <li> Issue: In the Replica Of process, if the target database does not have replication enabled and it is restarted or fails for any reason, the data on the target database might not be in sync with the source database, although the status of the Replica Of process indicates that it is. Workaround: You must manually stop and restart the synchronization process in order to ensure the databases are in sync. </li> <li> Issue: In the Replica Of process, if the source database is resharded while the Replica Of process is active, the synchronization process will fail. Workaround: You must manually stop and restart the synchronization process after the resharding of the source database is done. </li> <li> Issue: In the Replica Of process, if there is very high traffic on the database the Replica Of process might be restarted frequently due to the "replica buffer" being exceeded. In this case, you will often see the status of the Replica Of process display as "Syncing". Workaround: You must manually increase the "replica buffer" size through rladmin. To find the appropriate buffer size please contact support at: <a href="mailto:[email protected]"> [email protected] </a> . </li> <li> Issue: In a cluster that is configured to support rack-zone awareness, if the user forces migration of a master or replica shard through rladmin to a node on the same rack-zone as its corresponding master or replica shard, and later runs the rebalance process, the rebalance process will not migrate the shards to ensure rack-zone awareness compliance. Workaround: In the scenario described above, you must use rladmin to manually migrate the shard to a node on a valid rack-zone in order to ensure rack-zone awareness compliance. </li> <li> Issue: DNS doesn't change after having removed the external IP address. Workaround: Unbind IP from affected node and then bind it back. </li> <li> Issue : CCS gets an error and won't start if /var/opt/redislabs/persist/ does not exist. Workaround : Make sure this directory is not deleted and continues to exist. </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-4-4-dec-2016/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/objects/action/.html

<section class="prose w-full py-12 max-w-none"> <h1> Action object </h1> An object that represents cluster actions The cluster allows you to invoke general maintenance actions such as rebalancing or taking a node offline by moving all of its entities to other nodes. Actions are implemented as tasks in the cluster. Every task has a unique <code> task_id </code> assigned by the cluster, a task name which describes the task, a status, and additional task-specific parameters. The REST API provides a simplified interface that allows callers to invoke actions and query their status without a specific <code> task_id </code> . The action lifecycle is based on the following status and status transitions: <a href="/docs/latest/images/rs/rest-api-action-cycle.png#no-click" sdata-lightbox="/images/rs/rest-api-action-cycle.png#no-click"> <img alt="Action lifecycle" src="/docs/latest/images/rs/rest-api-action-cycle.png#no-click"/> </a> <table> <thead> <tr> <th> Name </th> <th> Type/Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> progress </td> <td> float (range: 0-100) </td> <td> Represents percent completed (As of v7.4.2, the return value type changed to 'float' to provide improved progress indication) </td> </tr> <tr> <td> status </td> <td> queued </td> <td> Requested operation and added it to the queue to await processing </td> </tr> <tr> <td> </td> <td> starting </td> <td> Picked up operation from the queue and started processing </td> </tr> <tr> <td> </td> <td> running </td> <td> Currently executing operation </td> </tr> <tr> <td> </td> <td> cancelling </td> <td> Operation cancellation is in progress </td> </tr> <tr> <td> </td> <td> cancelled </td> <td> Operation cancelled </td> </tr> <tr> <td> </td> <td> completed </td> <td> Operation completed </td> </tr> <tr> <td> </td> <td> failed </td> <td> Operation failed </td> </tr> </tbody> </table> When a task fails, the <code> error_code </code> and <code> error_message </code> fields describe the error. Possible <code> error_code </code> values: <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> internal_error </td> <td> An internal error that cannot be mapped to a more precise error code </td> </tr> <tr> <td> insufficient_resources </td> <td> The cluster does not have sufficient resources to complete the required operation </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/references/rest-api/objects/action/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/tools/insight/release-notes/v.2.16.0/.html

<section class="prose w-full py-12"> <h1> RedisInsight v2.16.0, December 2022 </h1> RedisInsight v2.16.0 <h2 id="2160-december-2022"> 2.16.0 (December 2022) </h2> This is the General Availability (GA) release of RedisInsight 2.16. <h3 id="highlights"> Highlights </h3> <ul> <li> Bulk import database connections from a file </li> <li> Navigation enhancements for the Tree view </li> <li> Pre-populated host, port, and database alias in the form when adding a new Redis database </li> </ul> <h3 id="details"> Details </h3> Features and improvements <ul> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/1492"> #1492 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/1497"> #1497 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/1500"> #1500 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/1502"> #1502 </a> Migrate your database connections from other Redis GUIs, including RESP.app, with the new feature to bulk import database connections from a file. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/1506"> #1506 </a> Pre-populated host (127.0.0.1), port (6379, or 26379 for <a href="https://redis.io/docs/management/sentinel/"> Sentinel </a> connection type), and database alias in the form when adding a new Redis database </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/1473"> #1473 </a> Browser view is renamed List view to avoid confusion with the Browser tool </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/1464"> #1464 </a> Navigation enhancements for the Tree view, covering cases when filters are applied, the list of keys is refreshed or the view is switched to the Tree view </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/1481"> #1481 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/1482"> #1482 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/1489"> #1489 </a> Indication of new database connections that have been manually added, auto-discovered or imported, but not opened yet </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/1499"> #1499 </a> Display values of <a href="https://redis.io/docs/stack/json/"> JSON </a> keys when <a href="https://redis.io/commands/json.debug-memory/"> JSON.DEBUG MEMORY </a> is not available </li> </ul> Bugs <ul> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/1514"> #1514 </a> Scan the database even when the <a href="https://redis.io/commands/dbsize/"> DBSIZE </a> returns 0 </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/develop/tools/insight/release-notes/v.2.16.0/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/installing-upgrading/install/.html

<section class="prose w-full py-12 max-w-none"> <h1> Install Redis Enterprise Software </h1> Install Redis Enterprise Software on Linux. After you <a href="/docs/latest/operate/rs/installing-upgrading/install/plan-deployment/"> plan your deployment </a> , <a href="/docs/latest/operate/rs/installing-upgrading/install/prepare-install/download-install-package/"> download a Redis Enterprise Software installation package </a> , and finish <a href="/docs/latest/operate/rs/installing-upgrading/install/prepare-install/"> installation preparation </a> : <ol> <li> <a href="/docs/latest/operate/rs/installing-upgrading/install/install-on-linux/"> Install the Redis Enterprise Software package </a> on one of the nodes in the cluster. </li> <li> Repeat this process for each node in the cluster. </li> </ol> For installation on machines without an internet connection, see <a href="/docs/latest/operate/rs/installing-upgrading/install/offline-installation/"> Offline installation </a> . <h2 id="permissions-and-access"> Permissions and access </h2> <ul> <li> Redis Enterprise Software installation creates the <code> redislabs:redislabs </code> user and group. Assigning other users to the <code> redislabs </code> group is optional. Users belonging to the <code> redislabs </code> group have permission to read and execute (e.g. use the <code> rladmin </code> status command) but are not allowed to write (or delete) files or directories. </li> <li> Redis Enterprise Software is certified to run with permissions set to <code> 750 </code> , an industry standard. <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"> Warning: </div> Do not reduce permissions to <code> 700 </code> . This configuration has not been tested and is not supported. </div> </div> </li> </ul> <h2 id="more-info-and-options"> More info and options </h2> If you've already installed Redis Enterprise Software, you can also: <ul> <li> <a href="/docs/latest/operate/rs/installing-upgrading/upgrading/"> Upgrade an existing deployment </a> . </li> <li> <a href="/docs/latest/operate/rs/installing-upgrading/uninstalling/"> Uninstall an existing deployment </a> . </li> </ul> To learn more about customization and find answers to related questions, see: <ul> <li> <a href="/docs/latest/operate/rs/installing-upgrading/configuring/centos-rhel-firewall/"> CentOS/RHEL Firewall configuration </a> </li> <li> <a href="/docs/latest/operate/rs/installing-upgrading/configuring/change-location-socket-files/"> Change socket file location </a> </li> <li> <a href="/docs/latest/operate/rs/networking/cluster-dns/"> Cluster DNS configuration </a> </li> <li> <a href="/docs/latest/operate/rs/networking/cluster-lba-setup/"> Cluster load balancer setup </a> </li> <li> <a href="/docs/latest/operate/rs/installing-upgrading/install/plan-deployment/file-locations/"> File locations </a> </li> <li> <a href="/docs/latest/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms/"> Supported platforms </a> </li> <li> <a href="/docs/latest/operate/rs/installing-upgrading/install/manage-installation-questions/"> Manage installation questions </a> </li> <li> <a href="/docs/latest/operate/rs/networking/mdns/"> mDNS client prerequisites </a> </li> <li> <a href="/docs/latest/operate/rs/installing-upgrading/install/customize-user-and-group/"> User and group ownership </a> </li> </ul> <h2 id="next-steps"> Next steps </h2> After your cluster is set up with nodes, you can: <ul> <li> <a href="/docs/latest/operate/rs/security/access-control/create-users/"> Add users </a> to the cluster with specific permissions. To begin, start with <a href="/docs/latest/operate/rs/security/access-control/"> Access control </a> . </li> <li> <a href="/docs/latest/operate/rs/databases/create/"> Create databases </a> to use with your applications. </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/installing-upgrading/install/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/import-export/replica-of/.html

<section class="prose w-full py-12 max-w-none"> <h1> Replica Of geo-distributed Redis </h1> Replica Of provides read-only access to replicas of the dataset from different geographical locations. In Redis Enterprise, the Replica Of feature provides active-passive geo-distribution to applications for read-only access to replicas of the dataset from different geographical locations. The Redis Enterprise implementation of active-passive replication is called Replica Of. In Replica Of, an administrator designates a database as a replica (destination) of one or more databases (sources). After the initial data load from source to destination is completed, all write commands are synchronized from the sources to the destination. Replica Of lets you distribute the read load of your application across multiple databases or synchronize the database, either within Redis Enterprise or external to Redis Enterprise, to another database. You can <a href="/docs/latest/operate/rs/databases/import-export/replica-of/create/"> create Active-Passive </a> databases on Redis Enterprise Software or Redis Cloud. <a href="/docs/latest/operate/rs/databases/active-active/"> Active-Active Geo-Distribution (CRDB) </a> provides these benefits and also provides write access to all of the database replicas. <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"> Warning: </div> Configuring a database as a replica of the database that it replicates creates a cyclical replication and is not supported. </div> </div> The Replica Of is defined in the context of the destination database by specifying the source databases. A destination database can have a maximum of thirty-two (32) source databases. If only one source is defined, then the command execution order in the source is kept in the destination. However, when multiple sources are defined, commands that are replicated from the source databases are executed in the order in which they reach the destination database. As a result, commands that were executed in a certain order when compared across source databases might be executed in a different order on the destination database. <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> The Replica Of feature should not be confused with the in-memory <a href="/docs/latest/operate/rs/databases/durability-ha/replication/"> Database replication </a> feature, which is used for creating a master / replica configuration that enables ensuring database high-availability. </div> </div> <h2 id="replication-process"> Replication process </h2> When a database is defined as a replica of another database, all its existing data is deleted and replaced by data that is loaded from the source database. Once the initial data load is completed, an ongoing synchronization process takes place to keep the destination always synchronized with its source. During the ongoing synchronization process, there is a certain delay between the time when a command was executed on the source and when it is executed on the destination. This delay is referred to as the Lag . When there is a synchronization error , the process might stop or it might continue running on the assumption that the error automatically resolves. The result depends on the error type. See more details below. In addition, the user can manually stop the synchronization process . When the process is in the stopped state - whether stopped by the user or by the system - the user can restart the process. Restarting the process causes the synchronization process to flush the DB and restart the process from the beginning . <h3 id="replica-of-status"> Replica Of status </h3> The replication process can have the following statuses: <ul> <li> Syncing - indicates that the synchronization process has started from scratch. Progress is indicated in percentages (%). </li> <li> Synced - indicates that the initial synchronization process was completed and the destination is synchronizing changes on an ongoing basis. The Lag delay in synchronization with the source is indicated as a time duration. </li> <li> Sync stopped - indicates that the synchronization process is currently not running and the user needs to restart it in order for it to continue running. This status happens if the user stops the process, or if certain errors arose that prevent synchronization from continuing without manual intervention. See more details below. </li> </ul> The statuses above are shown for the source database. In addition, a timestamp is shown on the source indicating when the last command from the source was executed on the destination. The system also displays the destination database status as an aggregate of the statuses of all the sources. <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> If you encounter issues with the Replica Of process, refer to the troubleshooting section <a href="/docs/latest/operate/rs/databases/import-export/replica-of/replicaof-repeatedly-fails/"> Replica Of repeatedly fails </a> . </div> </div> <h3 id="synchronization-errors"> Synchronization errors </h3> Certain errors that occur during the synchronization process require user intervention for their resolution. When such errors occur, the synchronization process is automatically stopped. For other errors, the synchronization process continues running on the assumption that the error automatically resolves. Examples of errors that require user intervention for their resolution and that stop the synchronization process include: <ul> <li> Error authenticating with the source database. </li> <li> Cross slot violation error while executing a command on a sharded destination database. </li> <li> Out-of-memory error on a source or on the destination database. </li> </ul> Example of an error that does not cause the synchronization process to stop: <ul> <li> Connection error with the source database. A connection error might occur occasionally, for example as result of temporary network issues that get resolved. Depending on the connection error and its duration the process might be able to start syncing from the last point it reached (partial sync) or require a complete resynchronization from scratch across all sources (full sync). </li> </ul> <h2 id="encryption"> Encryption </h2> Replica Of supports the ability to encrypt uni-directional replication communications between source and destination clusters utilizing TLS 1.2 based encryption. <h2 id="data-compression-for-replica-of"> Data compression for Replica Of </h2> When the Replica Of is defined across different Redis Enterprise Software clusters, it may be beneficial to compress the data that flows through the network (depending on where the clusters physically reside and the available network). Compressing the data reduces the traffic and can help: <ul> <li> Resolve throughput issues </li> <li> Reduce network traffic costs </li> </ul> Compressing the data does have trade-offs, which is why it should not always be turned on by default. For example: <ul> <li> It uses CPU and disk resources to compress the data before sending it to the network and decompress it on the other side. </li> <li> It takes time to compress and decompress the data which can increase latency. </li> <li> Replication is disk-based and done gradually, shard by shard in the case of a multi-shard database. This may have an impact on replication times depending on the speed of the disks and load on the database. </li> <li> If traffic is too fast and the compression takes too much time it can cause the replication process to fail and be restarted. </li> </ul> It is advised that you test compression out in a lower environment before enabling it in production. In the Redis Enterprise Software management UI, when designating a Replica Of source from a different Redis Enterprise Software cluster, there is also an option to enable compression. When enabled, gzip compression with level -6 is utilized. <h2 id="database-clustering-sharding-implications"> Database clustering (sharding) implications </h2> If a source database is sharded, that entire database is treated as a single source for the destination database. If the destination database is sharded, when the commands replicated from the source are executed on the destination database, the destination database's hashing function is executed to determine to which shard/s the command refers. The source and destination can have different shard counts and functions for placement of keys. <h3 id="synchronization-in-active-passive-replication"> Synchronization in Active-Passive Replication </h3> In Active-Passive databases, one cluster hosts the source database that receives read-write operations and the other clusters host destination databases that receive synchronization updates from the source database. When there is a significant difference between the source and destination databases, the destination database flushes all of the data from its memory and starts synchronizing the data again. This process is called a full sync . For example, if the database updates for the destination databases that are stored by the destination database in a synchronization backlog exceed their allocated memory, the source database starts a full sync. <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"> Warning: </div> When you failover to the destination database for write operations, make sure that you disable Replica Of before you direct clients to the destination database. This avoids a full sync that can overwrite your data. </div> </div> <h2 id="active-passive-replication-backlog"> Active-Passive replication backlog </h2> In addition to the <a href="/docs/latest/operate/rs/databases/durability-ha/replication/#database-replication-backlog"> database replication backlog </a> , active-passive databases maintain a replication backlog (per shard) to synchronize the database instances between clusters. By default, the replication backlog is set to one percent (1%) of the database size divided by the database number of shards and ranges between 1MB to 250MB per shard. Use the <a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/"> <code> rladmin </code> </a> utility to control the size of the replication backlog. You can set it to <code> auto </code> or set a specific size. For an Active-Passive database: <div class="highlight"> <pre class="chroma"><code class="language-text" data-lang="text">rladmin tune db <db:id | name> repl_backlog <Backlog size in MB or 'auto'> </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> On an Active-Passive database, the replication backlog configuration applies to both the replication backlog for shards synchronization and for synchronization of database instances between clusters. </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/rs/databases/import-export/replica-of/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/integrate/write-behind/architecture/.html

<section class="prose w-full py-12 max-w-none"> <h1> Write-behind architecture </h1> Discover the main components of Write-behind Write-behind lets you integrate Redis Enterprise (as the source of changes to data) and downstream databases or datastores. Write-behind captures any changes to a selected set of key patterns in a Redis keyspace and asynchronously writes them in small batches to the downstream database. This means that your app doesn't need to handle the data remodeling or manage the connection with the downstream database. Write-behind can normalize a key in Redis to several records in one or more tables at the target. To learn more about write-behind declarative jobs and normalization, see the <a href="/docs/latest/integrate/write-behind/quickstart/write-behind-guide/"> write-behind quick start guide </a> . <h2 id="write-behind-topology"> Write-behind topology </h2> Write-behind's CLI and engine are shipped as one product that can run both ingest and write-behind pipelines. However, the two different types of pipeline have different topologies. The Write-behind engine is installed on the Redis database that contains the application data and not on a separate staging Redis database. The Write-behind data streams and its control plane add only a small footprint of a few hundred MB to the Redis database. In the write-behind topology, Write-behind processes data in parallel on each shard and establishes a single connection from each shard to the downstream database. <h3 id="model-translation"> Model translation </h3> Write-behind can track changes to the following Redis types: <ul> <li> <a href="/docs/latest/develop/data-types/hashes/"> Hash </a> </li> <li> <a href="/docs/latest/develop/data-types/json/"> JSON </a> </li> <li> <a href="/docs/latest/develop/data-types/sets/"> Set </a> </li> <li> <a href="/docs/latest/develop/data-types/sorted-sets/"> Sorted Set </a> </li> </ul> Unlike the ingest scenario, write-behind has no default behavior for model translation. You must always create a declarative job to specify the mapping between Redis keys and target database records. The job configuration has <code> keys </code> and <code> mapping </code> sections that help make this an easy task. <h2 id="write-behind-components"> Write-behind components </h2> <h3 id="write-behind-cli"> Write-behind CLI </h3> Write-behind's Python-based CLI is highly intuitive to use and performs validations to help you avoid mistakes. The CLI makes it easy to set up Write-behind and manage it over its entire lifecycle. <h3 id="write-behind-engine"> Write-behind Engine </h3> Write-behind uses Redis Gears as its runtime environment. The Gears and Write-behind engine logic are installed on all source Redis Enterprise database shards, but only primary shards process events and handle the pipeline. The Write-behind Engine reads Redis change events from Redis Streams (one for each tracked key-pattern), processes them, and translates them to SQL or whatever other language the target database uses. Write-behind writes changes to the target in small batches using transactions. Write-behind guarantees at-least once delivery. If any network problems, disconnections, or other temporary failures occur, Write-behind will keep attempting to write the changes to the target. If a hard reject occurs, Write-behind keeps the reject record and the reason in a dead letter queue (DLQ) . <h3 id="write-behind-configuration"> Write-behind configuration </h3> The Write-behind configuration is persisted at the cluster level. The configuration is written by the CLI <a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-deploy/"> <code> deploy </code> </a> command, which saves all changes to the configuration file. This mechanism allows for automatic configuration of new shards whenever you need them, and it can survive shard and node failure. <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/integrate/write-behind/architecture/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/objects/ocsp/.html

<section class="prose w-full py-12 max-w-none"> <h1> OCSP object </h1> An object that represents the cluster's OCSP configuration An API object that represents the cluster's OCSP configuration. <table> <thead> <tr> <th> Name </th> <th> Type/Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> ocsp_functionality </td> <td> boolean (default: false) </td> <td> Enables or turns off OCSP for the cluster </td> </tr> <tr> <td> query_frequency </td> <td> integer (range: 60-86400) (default: 3600) </td> <td> The time interval in seconds between OCSP queries to check the certificate’s status </td> </tr> <tr> <td> recovery_frequency </td> <td> integer (range: 60-86400) (default: 60) </td> <td> The time interval in seconds between retries after the OCSP responder returns an invalid status for the certificate </td> </tr> <tr> <td> recovery_max_tries </td> <td> integer (range: 1-100) (default: 5) </td> <td> The number of retries before the validation query fails and invalidates the certificate </td> </tr> <tr> <td> responder_url </td> <td> string </td> <td> The OCSP server URL embedded in the proxy certificate (if available) (read-only) </td> </tr> <tr> <td> response_timeout </td> <td> integer (range: 1-60) (default: 1) </td> <td> The time interval in seconds to wait for a response before timing out </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/references/rest-api/objects/ocsp/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/clusters/optimize/optimization/.html

<section class="prose w-full py-12 max-w-none"> <h1> Cluster environment optimization </h1> Optimize your cluster environments for better performance. Redis Enterprise Software uses various algorithms to optimize performance. As part of this process, Redis Enterprise Software examines usage and load to adjust its runtime configuration. Depending on your specific usage and load, Redis Enterprise Software might take some time to adjust for optimal performance. To ensure optimal performance, you must run your workload several times and for a long duration until performance stabilizes. <h2 id="failure-detection-sensitivity-policies"> Failure detection sensitivity policies </h2> You can optimize your cluster's thresholds and timeouts for different environments using the <code> failure_detection_sensitivity </code> cluster policy: <ul> <li> <code> high </code> (previously known as <code> local-network watchdog_profile </code> ) – high failure detection sensitivity, lower thresholds, and faster failure detection and failover </li> <li> <code> low </code> (previously known as <code> cloud watchdog_profile </code> ) – low failure detection sensitivity and higher tolerance for latency variance (also called network jitter) </li> </ul> Depending on which policy you choose, Redis Enterprise Software uses different thresholds to make operation-related decisions. The default policy is <code> high </code> failure detection sensitivity for <code> local-network </code> environments. If you are running Redis Enterprise in a cloud environment, you should change the configuration. <h2 id="change-failure-detection-sensitivity"> Change failure detection sensitivity </h2> To change the cluster's <code> failure_detection_sensitivity </code> , run one of the following <a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/tune/#tune-cluster"> <code> rladmin </code> </a> commands. <ul> <li> For Redis Enterprise Software version 6.4.2-69 and later, run: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin tune cluster failure_detection_sensitivity [ low | high ] </code></pre> </div> </li> <li> For Redis Enterprise Software version 6.4.2-61 and earlier, run: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin tune cluster watchdog_profile [ cloud | local-network ] </code></pre> </div> </li> </ul> If Redis Enterprise Software still does not meet your performance expectations after following these instructions, <a href="https://redis.com/company/support/"> contact support </a> for help optimizing your environment. <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/clusters/optimize/optimization/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/cloud-integrations/gcp-marketplace/.html

<section class="prose w-full py-12 max-w-none"> <h1> Sign up for Redis Cloud with Google Cloud Marketplace </h1> Shows how to subscribe to Redis Cloud using Google Cloud Marketplace You can use Google Cloud Marketplace to subscribe to Redis Cloud. This lets you provision according to your needs and pay using your Google Cloud account. Here's how to subscribe to Redis Cloud with Google Cloud Marketplace: <ol> <li> Sign in to the <a href="https://console.cloud.google.com/"> Google Cloud console </a> . </li> <li> Identify the Google Cloud Billing account that will subscribe to Redis Cloud. This account must have one of the following sets of Identity and Access Management (IAM) Roles: <ul> <li> <a href="https://cloud.google.com/billing/docs/how-to/billing-access#overview-of-cloud-billing-roles-in-cloud-iam"> Billing Administrator </a> ( <code> roles/billing.admin </code> ), OR </li> <li> <a href="https://cloud.google.com/billing/docs/how-to/billing-access#overview-of-cloud-billing-roles-in-cloud-iam"> Billing User </a> ( <code> roles/billing.user </code> ) AND <a href="https://cloud.google.com/marketplace/docs/access-control#roles-permissions"> Consumer Procurement Order Administrator </a> </li> </ul> If you don't have the correct roles, request access from your Google Cloud Billing Administrator or Organization Administrator. For more information about granting roles, see <a href="https://cloud.google.com/marketplace/docs/access-control"> Access control for Google Cloud Marketplace </a> . </li> <li> Search Google Cloud Marketplace for <a href="https://console.cloud.google.com/marketplace/product/redis-marketplace-isaas/redis-enterprise-cloud-flexible-plan"> Redis® Cloud Cache and Vector Database </a> . <a href="/docs/latest/images/rc/gcp-marketplace-rc-payg-plan.png" sdata-lightbox="/images/rc/gcp-marketplace-rc-payg-plan.png"> <img alt="The Redis Cloud - Pay as You Go plan listing on Google Cloud Marketplace" src="/docs/latest/images/rc/gcp-marketplace-rc-payg-plan.png"/> </a> Alternatively, in the navigation panel, select View all products and select Redis Cloud under Databases . You can pin Redis Cloud for easy access. Or, click on the URL provided by your Redis seller for a private offer for <a href="https://console.cloud.google.com/marketplace/product/redis-marketplace-isaas/redis-enterprise-cloud-flexible-plan"> Redis® Cloud Cache and Vector Database </a> and accept the private offer. </li> <li> Select the Subscribe button. This redirects you to the subscription details page. </li> <li> Under Purchase Details , select the Google Cloud Billing account that will subscribe to Redis Cloud. Review the subscription details, accept the terms, and select Subscribe . </li> <li> When you subscribe for the first time, select Sign Up with Redis . This will redirect you to the <a href="https://cloud.redis.io"> Redis Cloud console </a> . </li> <li> Create a Redis Cloud account or sign in to an existing account. You must have the Account Owner role. </li> <li> Select the Redis account to be mapped to your GCP Marketplace account and confirm that your Marketplace account will pay for your Redis Cloud resources going forward. <a href="/docs/latest/images/rc/gcp-marketplace-map-account-dialog.png" sdata-lightbox="/images/rc/gcp-marketplace-map-account-dialog.png"> <img alt="Use the GCP Marketplace dialog to map your Redis Cloud account to your Google Cloud Marketplace account." src="/docs/latest/images/rc/gcp-marketplace-map-account-dialog.png" width="75%"/> </a> </li> <li> Select Connect account to confirm your choice. <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 must complete this step to bill your Redis Cloud resources to your Google Cloud Marketplace account. </div> </div> </li> <li> After you connect your Redis account to your Google Cloud Marketplace account, a message appears in the upper left corner of the account panel. <a href="/docs/latest/images/rc/gcp-marketplace-billing-badge.png" sdata-lightbox="/images/rc/gcp-marketplace-billing-badge.png"> <img alt="The Google Cloud Marketplace badge appears when your Redis Cloud account is mapped to a Google Cloud Marketplace account." src="/docs/latest/images/rc/gcp-marketplace-billing-badge.png"/> </a> </li> <li> On the Google Cloud Marketplace listing, select Manage on provider to go to the <a href="https://cloud.redis.io"> Redis Cloud console </a> . <a href="/docs/latest/images/rc/gcp-marketplace-manage-on-provider.png" sdata-lightbox="/images/rc/gcp-marketplace-manage-on-provider.png"> <img alt="The Manage on Provider button" src="/docs/latest/images/rc/gcp-marketplace-manage-on-provider.png"/> </a> </li> </ol> At this point, you can create a new database using the <a href="/docs/latest/operate/rc/databases/create-database/"> standard workflow </a> , with one important change. You don't need to enter a payment method, as it automatically uses your Google Cloud Marketplace account. To confirm this, review the payment method associated with your subscription. Additional users can be added on the Redis Cloud console using the <a href="/docs/latest/operate/rc/security/access-control/access-management/"> Access Management </a> page. If your Google Cloud Marketplace account is deactivated or otherwise unavailable, you can't use your subscription until you update the billing method. For help, <a href="https://redis.io/support/"> contact support </a> . <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/cloud-integrations/gcp-marketplace/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/json.debug-memory/.html

<section class="prose w-full py-12"> <h1 class="command-name"> JSON.DEBUG MEMORY </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">JSON.DEBUG MEMORY key [path]</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/json"> JSON 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(N) when path is evaluated to a single value, where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key </dd> </dl> Report a value's memory usage in bytes <a href="#examples"> Examples </a> <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> key </code> </summary> is key to parse. </details> <h2 id="optional-arguments"> Optional arguments </h2> <details open=""> <summary> <code> path </code> </summary> is JSONPath to specify. Default is root <code> $ </code> . </details> <h2 id="return"> Return </h2> JSON.DEBUG MEMORY returns an integer reply specified as the value size in bytes. For more information about replies, see <a href="/docs/latest/develop/reference/protocol-spec/"> Redis serialization protocol specification </a> . <h2 id="examples"> Examples </h2> <details open=""> <summary> Report a value's memory usage in bytes </summary> Create a JSON document. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.SET item:2 $ '{"name":"Wireless earbuds","description":"Wireless Bluetooth in-ear headphones","connection":{"wireless":true,"type":"Bluetooth"},"price":64.99,"stock":17,"colors":["black","white"], "max_level":[80, 100, 120]}' OK</code></pre> </div> Get the values' memory usage in bytes. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.DEBUG MEMORY item:2 (integer) 253</code></pre> </div> </details> <h2 id="see-also"> See also </h2> <a href="/docs/latest/commands/json.set/"> <code> JSON.SET </code> </a> | <a href="/docs/latest/commands/json.arrlen/"> <code> JSON.ARRLEN </code> </a> <h2 id="related-topics"> Related topics </h2> <ul> <li> <a href="/docs/latest/develop/data-types/json/"> RedisJSON </a> </li> <li> <a href="/docs/latest/develop/interact/search-and-query/indexing/"> Index and search JSON documents </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/commands/json.debug-memory/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/requests/nodes/snapshots/.html

<section class="prose w-full py-12 max-w-none"> <h1> Node snapshot requests </h1> Node snapshot requests <table> <thead> <tr> <th> Method </th> <th> Path </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="#get-snapshots"> GET </a> </td> <td> <code> /v1/nodes/{uid}/snapshots </code> </td> <td> Get node snapshots </td> </tr> <tr> <td> <a href="#delete-snapshot"> DELETE </a> </td> <td> <code> /v1/nodes/{uid}/snapshots/{snapshot_name} </code> </td> <td> Delete a node snapshot </td> </tr> </tbody> </table> <h2 id="get-snapshots"> Get node snapshots </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /v1/nodes/{int: uid}/snapshots </code></pre> </div> Get all cluster node snapshots of the specified node. <h3 id="permissions"> Permissions </h3> <table> <thead> <tr> <th> Permission name </th> <th> Roles </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_node_info"> view_node_info </a> </td> <td> admin cluster_member cluster_viewer db_member db_viewer user_manager </td> </tr> </tbody> </table> <h3 id="get-request"> Request </h3> <h4 id="example-http-request"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /nodes/1/snapshots </code></pre> </div> <h4 id="headers"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> Host </td> <td> cnm.cluster.fqdn </td> <td> Domain name </td> </tr> <tr> <td> Accept </td> <td> application/json </td> <td> Accepted media type </td> </tr> </tbody> </table> <h4 id="url-parameters"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> uid </td> <td> integer </td> <td> The unique ID of the node requested. </td> </tr> </tbody> </table> <h3 id="get-response"> Response </h3> Returns an array of node snapshot JSON objects. <h4 id="example-json-body"> Example JSON body </h4> <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">[ { "created_time": "2024-01-10 20:55:54", "name": "nightly_snapshot_1", "node_uid": "1" }, { "created_time": "2024-01-11 20:55:54", "name": "nightly_snapshot_2", "node_uid": "1" } ] </code></pre> </div> <h3 id="get-status-codes"> Status codes </h3> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> No error </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Node UID does not exist </td> </tr> </tbody> </table> <h2 id="delete-snapshot"> Delete node snapshot </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">DELETE /v1/nodes/{int: uid}/snapshots/{snapshot_name} </code></pre> </div> Delete a cluster node snapshot. Snapshots created by maintenance mode are not deleted. <h3 id="permissions-1"> Permissions </h3> <table> <thead> <tr> <th> Permission name </th> <th> Roles </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/references/rest-api/permissions/#update_node"> update_node </a> </td> <td> admin </td> </tr> </tbody> </table> <h3 id="delete-request"> Request </h3> <h4 id="example-http-request-1"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">DELETE /nodes/1/snapshots/nightly_snapshot_19 </code></pre> </div> <h4 id="request-headers"> Request headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> Host </td> <td> cluster.fqdn </td> <td> Domain name </td> </tr> <tr> <td> Accept </td> <td> application/json </td> <td> Accepted media type </td> </tr> </tbody> </table> <h4 id="url-parameters-1"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> uid </td> <td> integer </td> <td> The unique ID of the updated node. </td> </tr> <tr> <td> snapshot_name </td> <td> string </td> <td> The unique name of the snapshot to delete. </td> </tr> </tbody> </table> <h3 id="delete-response"> Response </h3> Returns a JSON object that represents the deleted node snapshot. <h4 id="example-json-body-1"> Example JSON body </h4> <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "created_time": "2024-01-11 20:55:54", "name": "nightly_snapshot_19", "node_uid": "1" } </code></pre> </div> <h4 id="delete-status-codes"> Status codes </h4> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> No error </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4"> 403 Forbidden </a> </td> <td> Node snapshot is a maintenance snapshot and cannot be deleted </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Node uid does not exist </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Snapshot name does not exist for this node uid </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/references/rest-api/requests/nodes/snapshots/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/requests/crdbs/updates/.html

<section class="prose w-full py-12 max-w-none"> <h1> CRDB updates requests </h1> Update Active-Active configuration requests <table> <thead> <tr> <th> Method </th> <th> Path </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="#post-crdbs-updates"> POST </a> </td> <td> <code> /v1/crdbs/{crdb_guid}/updates </code> </td> <td> Modify Active-Active confgurarion </td> </tr> </tbody> </table> <h2 id="post-crdbs-updates"> Modify Active-Active configuration </h2> <pre><code>POST /v1/crdbs/{crdb_guid}/updates </code></pre> Modify Active-Active configuration. <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"> Warning: </div> This is a very powerful API request and can cause damage if used incorrectly. </div> </div> In order to add or remove instances, you must use this API. For simple configuration updates, it is recommended to use PATCH on /crdbs/{crdb_guid} instead. Updating default_db_config affects both existing and new instances that may be added. When you update db_config, it changes the configuration of the database that you specify. This field overrides corresponding fields (if any) in default_db_config. <h3 id="post-request"> Request </h3> <h4 id="example-http-request"> Example HTTP request </h4> <pre><code>POST /crdbs/1/updates </code></pre> <h4 id="request-headers"> Request headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> X-Task-ID </td> <td> string </td> <td> Specified task ID </td> </tr> <tr> <td> X-Result-TTL </td> <td> integer </td> <td> Time (in seconds) to keep task result </td> </tr> </tbody> </table> <h4 id="url-parameters"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> crdb_guid </td> <td> string </td> <td> Globally unique Active-Active database ID (GUID) </td> </tr> </tbody> </table> <h4 id="request-body"> Request body </h4> Include a <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb/modify_request/"> CRDB modify_request object </a> with updated fields in the request body. <h3 id="post-response"> Response </h3> Returns a <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb_task/"> CRDB task object </a> . <h3 id="post-status-codes"> Status codes </h3> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> The request has been accepted. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"> 400 Bad Request </a> </td> <td> The posted Active-Active database contains invalid parameters. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"> 401 Unauthorized </a> </td> <td> Unauthorized request. Invalid credentials </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Configuration, instance or Active-Active database not found. </td> </tr> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"> 406 Not Acceptable </a> </td> <td> The posted Active-Active database cannot be accepted. </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/references/rest-api/requests/crdbs/updates/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/groupstream.html

<section class="prose w-full py-12"> <h1> Commands </h1> </section>

https://redis.io/docs/latest/operate/rs/7.4/databases/migrate-shards/.html

<section class="prose w-full py-12 max-w-none"> <h1> Migrate database shards </h1> How to migrate database shards to other nodes in a Redis Software cluster. To migrate database shards to other nodes in the cluster, you can use the <a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/migrate/"> <code> rladmin migrate </code> </a> command or <a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate/"> REST API requests </a> . <h2 id="use-cases-for-shard-migration"> Use cases for shard migration </h2> Migrate database shards to a different node in the following scenarios: <ul> <li> Before node removal. </li> <li> To balance the database manually in case of latency issues or uneven load distribution across nodes. </li> <li> To manage node resources, such as memory usage. </li> </ul> <h2 id="considerations-for-shard-migration"> Considerations for shard migration </h2> For databases with replication: <ul> <li> Migrating a shard will not cause disruptions since a primary shard will still be available. </li> <li> If you try to migrate a primary shard, it will be demoted to a replica shard and a replica shard will be promoted to primary before the migration. If you set <code> "preserve_roles": true </code> in the request, a second failover will occur after the migration finishes to change the migrated shard's role back to primary. </li> </ul> For databases without replication, the migrated shard will not be available until the migration is done. Connected clients shouldn't be disconnected in either case. If too many primary shards are placed on the same node, it can impact database performance. <h2 id="migrate-specific-shard"> Migrate specific shard </h2> To migrate a specific database shard, use one of the following methods: <ul> <li> <a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/migrate/#migrate-shard"> <code> rladmin migrate shard </code> </a> : <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin migrate shard <shard_id> target_node <node_id> </code></pre> </div> </li> <li> <a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate/#post-shard"> Migrate shard </a> REST API request: Specify the ID of the shard to migrate in the request path and the destination node's ID as the <code> target_node_uid </code> in the request body. See the <a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate/#post-request-body"> request reference </a> for more options. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">POST /v1/shards/<shard_id>/actions/migrate { "target_node_uid": <node_id> } </code></pre> </div> Example JSON response body: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "action_uid": "<action_id>", "description": "Migrate was triggered" } </code></pre> </div> You can track the action's progress with a <a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/actions/#get-action"> <code> GET /v1/actions/<action_uid> </code> </a> request. </li> </ul> <h2 id="migrate-multiple-shards"> Migrate multiple shards </h2> To migrate multiple database shards, use one of the following methods: <ul> <li> <a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/migrate/#migrate-shard"> <code> rladmin migrate shard </code> </a> : <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin migrate shard <shard_id1> <shard_id2> <shard_id3> target_node <node_id> </code></pre> </div> </li> <li> <a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate/#post-multi-shards"> Migrate multiple shards </a> REST API request: Specify the IDs of the shards to migrate in the <code> shard_uids </code> list and the destination node's ID as the <code> target_node_uid </code> in the request body. See the <a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate/#post-multi-request-body"> request reference </a> for more options. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">POST /v1/shards/actions/migrate { "shard_uids": ["<shard_id1>","<shard_id2>","<shard_id3>"], "target_node_uid": <node_id> } </code></pre> </div> Example JSON response body: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "action_uid": "<action_id>", "description": "Migrate was triggered" } </code></pre> </div> You can track the action's progress with a <a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/actions/#get-action"> <code> GET /v1/actions/<action_uid> </code> </a> request. </li> </ul> <h2 id="migrate-all-shards-from-a-node"> Migrate all shards from a node </h2> To migrate all shards from a specific node to another node, run <a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/migrate/#migrate-all_shards"> <code> rladmin migrate all_shards </code> </a> : <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin migrate node <origin_node_id> all_shards target_node <node_id> </code></pre> </div> <h2 id="migrate-primary-shards"> Migrate primary shards </h2> You can use the <a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/migrate/#migrate-all_master_shards"> <code> rladmin migrate all_master_shards </code> </a> command to migrate all primary shards for a specific database or node to another node in the cluster. To migrate a specific database's primary shards: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin migrate db db:<id> all_master_shards target_node <node_id> </code></pre> </div> To migrate all primary shards from a specific node: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin migrate node <origin_node_id> all_master_shards target_node <node_id> </code></pre> </div> <h2 id="migrate-replica-shards"> Migrate replica shards </h2> You can use the <a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/migrate/#migrate-all_slave_shards"> <code> rladmin migrate all_slave_shards </code> </a> command to migrate all replica shards for a specific database or node to another node in the cluster. To migrate a specific database's replica shards: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin migrate db db:<id> all_slave_shards target_node <node_id> </code></pre> </div> To migrate all replica shards from a specific node: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin migrate node <origin_node_id> all_slave_shards target_node <node_id> </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/7.4/databases/migrate-shards/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/tools/insight/release-notes/v2.2.0/.html

<section class="prose w-full py-12"> <h1> RedisInsight v2.2.0, May 2022 </h1> RedisInsight v2.2.0 <h2 id="220-may-2022"> 2.2.0 (May 2022) </h2> This is the General Availability (GA) release of RedisInsight 2.2.0 <h3 id="headlines"> Headlines: </h3> <ul> <li> SlowLog: New tool based on results of the <a href="https://redis.io/commands/slowlog/"> Slowlog </a> command to analyze slow operations in Redis instances </li> <li> Streams: Added support for <a href="https://redis.io/docs/manual/data-types/streams/"> Redis Streams </a> </li> <li> Open the list of keys or key details in full screen </li> <li> Automatically refresh the list of keys and key values with a timer </li> </ul> <h3 id="details"> Details </h3> Features and improvements: <ul> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/621"> #621 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/645"> #645 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/649"> #649 </a> Added SlowLog, a tool that displays the list of logs captured by the <a href="https://redis.io/commands/slowlog/"> Slowlog </a> command to analyze all commands that exceed a specified runtime, which helps in troubleshooting performance issues. Specify both the runtime and the maximum length of SlowLog (which are server configurations) to configure the list of commands logged and set the auto-refresh interval to automatically update the list of commands displayed. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/597"> #597 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/598"> #598 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/601"> #601 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/603"> #603 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/608"> #608 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/613"> #613 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/614"> #614 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/632"> #632 </a> Support for <a href="https://redis.io/docs/manual/data-types/streams/"> Redis Streams </a> , including creation and deletion of Streams, addition and deletion of entries, and filtration of entries per timestamp. <a href="https://redis.io/docs/manual/data-types/streams/#consumer-groups"> Consumer groups </a> will be added in a future release. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/643"> #643 </a> List of keys or key details are supported in full screen mode. To open the key list in full screen, close the key details. To open key details in full screen, use the new Full Screen control in key details section. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/633"> #633 </a> Automatically refresh the list of keys and key values with a timer. To do so, enable the Auto Refresh mode by clicking the control next to the Refresh button and set the refresh rate. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/634"> #634 </a> Removed the max value limitation in the Database Index field of the form for adding a new database. </li> </ul> Bugs Fixed: <ul> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/656"> #656 </a> Binary key names will not trigger errors in databases with enabled OSS Cluster API. Data type, TTL, and size of such keys are displayed in the list of keys in all Redis instances. Key details are currently not available. </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/develop/tools/insight/release-notes/v2.2.0/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/json.set.html

<section class="prose w-full py-12"> <h1 class="command-name"> JSON.SET </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">JSON.SET key path value [NX | XX]</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/json"> JSON 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(M+N) when path is evaluated to a single value where M is the size of the original value (if it exists) and N is the size of the new value, O(M+N) when path is evaluated to multiple values where M is the size of the key and N is the size of the new value * the number of original values in the key </dd> </dl> Set the JSON value at <code> path </code> in <code> key </code> <a href="#examples"> Examples </a> <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> key </code> </summary> is key to modify. </details> <details open=""> <summary> <code> path </code> </summary> is JSONPath to specify. Default is root <code> $ </code> . For new Redis keys the <code> path </code> must be the root. For existing keys, when the entire <code> path </code> exists, the value that it contains is replaced with the <code> json </code> value. For existing keys, when the <code> path </code> exists, except for the last element, a new child is added with the <code> json </code> value. Adds a key (with its respective value) to a JSON Object (in a RedisJSON data type key) only if it is the last child in the <code> path </code> , or it is the parent of a new child being added in the <code> path </code> . Optional arguments <code> NX </code> and <code> XX </code> modify this behavior for both new RedisJSON data type keys as well as the JSON Object keys in them. </details> <details open=""> <summary> <code> value </code> </summary> is value to set at the specified path </details> <h2 id="optional-arguments"> Optional arguments </h2> <details open=""> <summary> <code> NX </code> </summary> sets the key only if it does not already exist. </details> <details open=""> <summary> <code> XX </code> </summary> sets the key only if it already exists. </details> <h2 id="return-value"> Return value </h2> JSET.SET returns a simple string reply: <code> OK </code> if executed correctly or <code> nil </code> if the specified <code> NX </code> or <code> XX </code> conditions were not met. For more information about replies, see <a href="/docs/latest/develop/reference/protocol-spec/"> Redis serialization protocol specification </a> . <h2 id="examples"> Examples </h2> <details open=""> <summary> Replace an existing value </summary> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.SET doc $ '{"a":2}' OK redis> JSON.SET doc $.a '3' OK redis> JSON.GET doc $ "[{\"a\":3}]"</code></pre> </div> </details> <details open=""> <summary> Add a new value </summary> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.SET doc $ '{"a":2}' OK redis> JSON.SET doc $.b '8' OK redis> JSON.GET doc $ "[{\"a\":2,\"b\":8}]"</code></pre> </div> </details> <details open=""> <summary> Update multi-paths </summary> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.SET doc $ '{"f1": {"a":1}, "f2":{"a":2}}' OK redis> JSON.SET doc $..a 3 OK redis> JSON.GET doc "{\"f1\":{\"a\":3},\"f2\":{\"a\":3}}"</code></pre> </div> </details> <h2 id="see-also"> See also </h2> <a href="/docs/latest/commands/json.get/"> <code> JSON.GET </code> </a> | <a href="/docs/latest/commands/json.mget/"> <code> JSON.MGET </code> </a> <h2 id="related-topics"> Related topics </h2> <ul> <li> <a href="/docs/latest/develop/data-types/json/"> RedisJSON </a> </li> <li> <a href="/docs/latest/develop/interact/search-and-query/indexing/"> Index and search JSON documents </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/commands/json.set/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/objects/shard/backup/.html

<section class="prose w-full py-12 max-w-none"> <h1> Backup object </h1> Documents the backup object used with Redis Enterprise Software REST API calls. <table> <thead> <tr> <th> Name </th> <th> Type/Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> progress </td> <td> number, (range: 0-100) </td> <td> Shard backup progress (percentage) </td> </tr> <tr> <td> status </td> <td> 'exporting' 'succeeded' 'failed' </td> <td> Status of scheduled periodic backup process </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/rest-api/objects/shard/backup/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/blmpop/.html

<section class="prose w-full py-12"> <h1 class="command-name"> BLMPOP </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">BLMPOP timeout numkeys key [key ...] <LEFT | RIGHT> [COUNT count]</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+M) where N is the number of provided keys and M is the number of elements returned. </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @write </code> , <code> @list </code> , <code> @slow </code> , <code> @blocking </code> , </dd> </dl> <code> BLMPOP </code> is the blocking variant of <a href="/docs/latest/commands/lmpop/"> <code> LMPOP </code> </a> . When any of the lists contains elements, this command behaves exactly like <a href="/docs/latest/commands/lmpop/"> <code> LMPOP </code> </a> . When used inside a <a href="/docs/latest/commands/multi/"> <code> MULTI </code> </a> / <a href="/docs/latest/commands/exec/"> <code> EXEC </code> </a> block, this command behaves exactly like <a href="/docs/latest/commands/lmpop/"> <code> LMPOP </code> </a> . When all lists are empty, Redis will block the connection until another client pushes to it or until the <code> timeout </code> (a double value specifying the maximum number of seconds to block) elapses. A <code> timeout </code> of zero can be used to block indefinitely. See <a href="/docs/latest/commands/lmpop/"> <code> LMPOP </code> </a> for more information. <h2 id="resp2-reply"> RESP2 Reply </h2> One of the following: <ul> <li> <a href="../../develop/reference/protocol-spec#bulk-strings"> Nil reply </a> : when no element could be popped and the timeout is reached. </li> <li> <a href="../../develop/reference/protocol-spec#arrays"> Array reply </a> : a two-element array with the first element being the name of the key from which elements were popped, and the second element being an array of the popped elements. </li> </ul> <h2 id="resp3-reply"> RESP3 Reply </h2> One of the following: <ul> <li> <a href="../../develop/reference/protocol-spec#nulls"> Null reply </a> : when no element could be popped and the timeout is reached. </li> <li> <a href="../../develop/reference/protocol-spec#arrays"> Array reply </a> : a two-element array with the first element being the name of the key from which elements were popped, and the second element being an array of the popped elements. </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/commands/blmpop/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/hpersist/.html

<section class="prose w-full py-12"> <h1 class="command-name"> HPERSIST </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">HPERSIST key FIELDS numfields field [field ...]</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.4.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 number of arguments to the command </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @read </code> , <code> @hash </code> , <code> @fast </code> , </dd> </dl> Remove the existing expiration on a hash key's field(s), turning the field(s) from volatile (a field with expiration set) to persistent (a field that will never expire as no TTL (time to live) is associated). <h2 id="examples"> Examples </h2> <pre tabindex="0"><code>redis> HSET mykey field1 "hello" field2 "world" (integer 2) redis> HEXPIRE mykey 300 FIELDS 2 field1 field2 1) (integer) 1 2) (integer) 1 redis> HTTL mykey FIELDS 2 field1 field2 1) (integer) 283 2) (integer) 283 redis> HPERSIST mykey FIELDS 1 field2 1) (integer) 1 redis> HTTL mykey FIELDS 2 field1 field2 1) (integer) 268 2) (integer) -1 </code></pre> <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> <ul> <li> <a href="../../develop/reference/protocol-spec#arrays"> Array reply </a> . For each field: <ul> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> -2 </code> if no such field exists in the provided hash key, or the provided key does not exist. </li> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> -1 </code> if the field exists but has no associated expiration set. </li> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> 1 </code> the expiration was removed. </li> </ul> </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/commands/hpersist/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/objects/bootstrap/node_identity/.html

<section class="prose w-full py-12 max-w-none"> <h1> Node identity object </h1> Documents the node_identity object used with Redis Enterprise Software REST API calls. <table> <thead> <tr> <th> Name </th> <th> Type/Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> bigstore_driver </td> <td> 'rocksdb' </td> <td> Bigstore driver name or none (deprecated) </td> </tr> <tr> <td> bigstore_enabled </td> <td> boolean </td> <td> Bigstore enabled or disabled </td> </tr> <tr> <td> identity </td> <td> <a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bootstrap/identity/"> identity </a> object </td> <td> Node identity </td> </tr> <tr> <td> limits </td> <td> <a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bootstrap/limits/"> limits </a> object </td> <td> Node limits </td> </tr> <tr> <td> paths </td> <td> <a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bootstrap/paths/"> paths </a> object </td> <td> Storage paths object </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/rest-api/objects/bootstrap/node_identity/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/hexpireat/.html

<section class="prose w-full py-12"> <h1 class="command-name"> HEXPIREAT </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">HEXPIREAT key unix-time-seconds [NX | XX | GT | LT] FIELDS numfields field [field ...]</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.4.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 number of arguments to the command </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @write </code> , <code> @hash </code> , <code> @fast </code> , </dd> </dl> <code> HEXPIREAT </code> has the same effect and semantics as <a href="/docs/latest/commands/hexpire/"> <code> HEXPIRE </code> </a> , but instead of specifying the number of seconds for the TTL (time to live), it takes an absolute <a href="http://en.wikipedia.org/wiki/Unix_time"> Unix timestamp </a> in seconds since Unix epoch. A timestamp in the past will delete the field immediately. For the specific semantics of the command, see <a href="/docs/latest/commands/hexpire/"> <code> HEXPIRE </code> </a> . <h2 id="options"> Options </h2> The <code> HEXPIREAT </code> command supports a set of options: <ul> <li> <code> NX </code> -- For each specified field, set expiration only when the field has no expiration. </li> <li> <code> XX </code> -- For each specified field, set expiration only when the field has an existing expiration. </li> <li> <code> GT </code> -- For each specified field, set expiration only when the new expiration is greater than current one. </li> <li> <code> LT </code> -- For each specified field, set expiration only when the new expiration is less than current one. </li> </ul> A non-volatile key is treated as an infinite TTL for the purposes of <code> GT </code> and <code> LT </code> . The <code> NS </code> , <code> XX </code> , <code> GT </code> , and <code> LT </code> options are mutually exclusive. <h2 id="example"> Example </h2> <pre tabindex="0"><code>redis> HSET mykey field1 "hello" field2 "world" (integer 2) redis> HEXPIREAT mykey 1715704971 FIELDS 2 field1 field2 1) (integer) 1 2) (integer) 1 redis> HTTL mykey FIELDS 2 field1 field2 1) (integer) 567 2) (integer) 567 </code></pre> <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> One of the following: <ul> <li> <a href="../../develop/reference/protocol-spec#arrays"> Array reply </a> . For each field: <ul> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> -2 </code> if no such field exists in the provided hash key, or the provided key does not exist. </li> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> 0 </code> if the specified NX, XX, GT, or LT condition has not been met. </li> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> 1 </code> if the expiration time was set/updated. </li> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> 2 </code> when <code> HEXPIRE </code> or <code> HPEXPIRE </code> is called with 0 seconds or milliseconds, or when <code> HEXPIREAT </code> or <code> HPEXPIREAT </code> is called with a past Unix time in seconds or milliseconds. </li> </ul> </li> <li> <a href="../../develop/reference/protocol-spec#simple-errors"> Simple error reply </a> : <ul> <li> if parsing failed, mandatory arguments are missing, unknown arguments are specified, or argument values are of the wrong type or out of range. </li> <li> if the provided key exists but is not a hash. </li> </ul> </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/commands/hexpireat/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/installing-upgrading/install/plan-deployment/configuring-aws-instances/.html

<section class="prose w-full py-12 max-w-none"> <h1> Configure AWS EC2 instances for Redis Enterprise Software </h1> Considerations for installing and running Redis Enterprise Software on Amazon Elastic Cloud Compute (EC2) instances. There are some special considerations for installing and running Redis Enterprise Software on Amazon Elastic Cloud Compute (EC2) instances. These include: <ul> <li> <a href="#storage"> Storage considerations </a> </li> <li> <a href="#instance-types"> Instance types </a> </li> <li> <a href="#security"> Security group configuration </a> </li> </ul> <h2 id="storage"> Storage considerations </h2> AWS EC2 instances are ephemeral, but your persistent database storage should not be. If you require a persistent storage location for your database, the storage must be located outside of the instance. When you set up an instance, make sure it has a properly sized EBS-backed volume connected. When you set up Redis Enterprise Software on the instance, make sure that <a href="/docs/latest/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage/"> the persistence storage </a> is configured to use this volume. <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> After <a href="/docs/latest/operate/rs/installing-upgrading/"> installing the Redis Enterprise Software package </a> on the instance and before running through <a href="/docs/latest/operate/rs/clusters/new-cluster-setup/"> the setup process </a> , you must give the group <code> redislabs </code> permission to the EBS volume by running the following command from the OS command-line interface (CLI): <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">chown redislabs:redislabs /< ebs folder name> </code></pre> </div> </div> </div> Another feature that may be of importance to you is the use of Provisioned IOPS for EBS-backed volumes. Provisioned IOPS guarantee a certain level of disk performance. There are two features in Redis Enterprise Software where this feature could be critical to use: <ol> <li> When using <a href="/docs/latest/operate/rs/databases/auto-tiering/"> Auto Tiering </a> </li> <li> When using AOF on every write and there is a high write load. In this case, the provisioned IOPS should be on the nodes used as replicas in the cluster. </li> </ol> <h2 id="instance-types"> Instance types </h2> Choose an instance type that has (at minimum) enough free memory and disk space to meet the Redis Enterprise Software <a href="/docs/latest/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements/"> hardware requirements </a> . In addition, some instance types are optimized for EBS-backed volumes and some are not. If you are using persistent storage, you should use an instance type that is, especially if disk drain rate matters to your database implementation. <h2 id="security"> Security group configuration </h2> When configuring the security group: <ul> <li> Define a custom TCP rule for port 8443 to allow web browser access to the Redis Enterprise Software Cluster Manager UI from the IP address range you use to access the Cluster Manager UI. </li> <li> If you are using the DNS resolving option with Redis Enterprise Software, define a DNS UDP rule for port 53 to allow access to the databases' endpoints by using the <a href="/docs/latest/operate/rs/networking/cluster-dns/"> DNS resolving mechanism </a> . </li> <li> To create a cluster that has multiple nodes all running as instances on AWS, you need to define a security group that has an All TCP rule for all ports, 0 - 65535, and add it to all instances that are part of the cluster. This ensures that all nodes are able to communicate with each other. To limit the number of open ports, you can open only the <a href="/docs/latest/operate/rs/networking/port-configurations/"> ports used by Redis Enterprise Software </a> . </li> </ul> After successfully launching the instances: <ol> <li> Install Redis Enterprise Software from the <a href="/docs/latest/operate/rs/installing-upgrading/"> Linux package or AWS AMI </a> . </li> <li> <a href="/docs/latest/operate/rs/clusters/new-cluster-setup/"> Set up the cluster </a> . </li> </ol> <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/installing-upgrading/install/plan-deployment/configuring-aws-instances/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/pubsub-channels/.html

<section class="prose w-full py-12"> <h1 class="command-name"> PUBSUB CHANNELS </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">PUBSUB CHANNELS [pattern]</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"> 2.8.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 number of active channels, and assuming constant time pattern matching (relatively short channels and patterns) </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @pubsub </code> , <code> @slow </code> , </dd> </dl> Lists the currently active channels . An active channel is a Pub/Sub channel with one or more subscribers (excluding clients subscribed to patterns). If no <code> pattern </code> is specified, all the channels are listed, otherwise if pattern is specified only channels matching the specified glob-style pattern are listed. Cluster note: in a Redis Cluster clients can subscribe to every node, and can also publish to every other node. The cluster will make sure that published messages are forwarded as needed. That said, <a href="/docs/latest/commands/pubsub/"> <code> PUBSUB </code> </a> 's replies in a cluster only report information from the node's Pub/Sub context, rather than the entire cluster. <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> <a href="../../develop/reference/protocol-spec#arrays"> Array reply </a> : a list of active channels, optionally matching the specified pattern. <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/pubsub-channels/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/cloud-integrations/aws-cloud-accounts/iam-resources/.html

<section class="prose w-full py-12 max-w-none"> <h1> Create IAM resources for AWS cloud accounts </h1> <div class="banner-article rounded-md"> Self-managed AWS accounts are deprecated, so this article has been archived. </div> For most Redis Cloud Pro databases deployed to Amazon Web Services (AWS), we manage the supporting infrastructure for you in dedicated AWS accounts. You can manage this infrastructure with your own AWS accounts. You'll want these accounts to be separate from any AWS application accounts and you'll need to create dedicated <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html"> identity and access management </a> (IAM) resources to allow us to manage the infrastructure. In the new AWS account, you need to create: <ul> <li> An instance role </li> <li> A user with an access key </li> <li> A role that grants AWS console access </li> </ul> Save the access key in a secure location so that you can enter it when you <a href="/docs/latest/operate/rc/cloud-integrations/aws-cloud-accounts/"> register the cloud account </a> with your the Redis Cloud subscription. <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"> Warning: </div> We use the provided credentials to configure your AWS environment and provision required resources. To make sure that we can manage your AWS resources, you must not: <ul> <li> Manually change the configurations of provisioned resources, such as security groups </li> <li> Manually stop or terminate provisioned instances </li> </ul> </div> </div> For help creating an AWS user, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html"> AWS IAM documentation </a> . You can use one of the following tools to create IAM resources: <ul> <li> <a href="/docs/latest/operate/rc/cloud-integrations/aws-cloud-accounts/iam-resources/cloudformation/"> CloudFormation </a> - The AWS automation tool </li> <li> <a href="/docs/latest/operate/rc/cloud-integrations/aws-cloud-accounts/iam-resources/terraform/"> Terraform </a> - Widely supported in the Redis community for additional automation </li> <li> The <a href="/docs/latest/operate/rc/cloud-integrations/aws-cloud-accounts/iam-resources/aws-console/"> AWS Console </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/rc/cloud-integrations/aws-cloud-accounts/iam-resources/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/cli-utilities/crdb-cli/crdb/create/.html

<section class="prose w-full py-12 max-w-none"> <h1> crdb-cli crdb create </h1> Creates an Active-Active database. Creates an Active-Active database. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">crdb-cli crdb create --name <name> --memory-size <maximum_memory> --instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=<url>,replication_endpoint=<endpoint>] --instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=<url>,replication_endpoint=<endpoint>] [--port <port_number>] [--no-wait] [--default-db-config <configuration>] [--default-db-config-file <filename>] [--compression <0-6>] [--causal-consistency { true | false } ] [--password <password>] [--replication { true | false } ] [--encryption { true | false } ] [--sharding { false | true } ] [--shards-count <number_of_shards>] [--shard-key-regex <regex_rule>] [--oss-cluster { true | false } ] [--bigstore { true | false }] [--bigstore-ram-size <maximum_memory>] [--with-module name=<module_name>,version=<module_version>,args=<module_args>] </code></pre> </div> <h3 id="prerequisites"> Prerequisites </h3> Before you create an Active-Active database, you must have: <ul> <li> At least two participating clusters </li> <li> <a href="/docs/latest/operate/rs/7.4/networking/port-configurations/"> Network connectivity </a> between the participating clusters </li> </ul> <h3 id="parameters"> Parameters </h3> <table> <thead> <tr> <th> Parameter & options(s) </th> <th> Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> name <CRDB_name> </td> <td> string </td> <td> Name of the Active-Active database (required) </td> </tr> <tr> <td> memory-size <maximum_memory> </td> <td> size in bytes, kilobytes (KB), or gigabytes (GB) </td> <td> Maximum database memory (required) </td> </tr> <tr> <td> instance fqdn=<cluster_fqdn>, username=<username>, password=<password> </td> <td> strings </td> <td> The connection information for the participating clusters (required for each participating cluster) </td> </tr> <tr> <td> port <port_number> </td> <td> integer </td> <td> TCP port for the Active-Active database on all participating clusters </td> </tr> <tr> <td> default-db-config <configuration> </td> <td> string </td> <td> Default database configuration options </td> </tr> <tr> <td> default-db-config-file <filename> </td> <td> filepath </td> <td> Default database configuration options from a file </td> </tr> <tr> <td> no-wait </td> <td> </td> <td> Prevents <code> crdb-cli </code> from running another command before this command finishes </td> </tr> <tr> <td> compression </td> <td> 0-6 </td> <td> The level of data compression: 0 = No compression 6 = High compression and resource load (Default: 3) </td> </tr> <tr> <td> causal-consistency </td> <td> true false ( default ) </td> <td> <a href="/docs/latest/operate/rs/7.4/databases/active-active/causal-consistency/"> Causal consistency </a> applies updates to all instances in the order they were received </td> </tr> <tr> <td> password <password> </td> <td> string </td> <td> Password for access to the database </td> </tr> <tr> <td> replication </td> <td> true false ( default ) </td> <td> Activates or deactivates <a href="/docs/latest/operate/rs/7.4/databases/durability-ha/replication/"> database replication </a> where every master shard replicates to a replica shard </td> </tr> <tr> <td> encryption </td> <td> true false ( default ) </td> <td> Activates or deactivates encryption </td> </tr> <tr> <td> sharding </td> <td> true false ( default ) </td> <td> Activates or deactivates sharding (also known as <a href="/docs/latest/operate/rs/7.4/databases/durability-ha/replication/"> database clustering </a> ). Cannot be updated after the database is created </td> </tr> <tr> <td> shards-count <number_of_shards> </td> <td> integer </td> <td> If sharding is enabled, this specifies the number of Redis shards for each database instance </td> </tr> <tr> <td> oss-cluster </td> <td> true false ( default ) </td> <td> Activates <a href="/docs/latest/operate/rs/7.4/clusters/optimize/oss-cluster-api/"> OSS cluster API </a> </td> </tr> <tr> <td> shard-key-regex <regex_rule> </td> <td> string </td> <td> If clustering is enabled, this defines a regex rule (also known as a <a href="/docs/latest/operate/rs/7.4/databases/durability-ha/clustering/#custom-hashing-policy"> hashing policy </a> ) that determines which keys are located in each shard (defaults to <code> {u'regex': u'.*\\{(?<tag>.*)\\}.*'}, {u'regex': u'(?<tag>.*)'} </code> ) </td> </tr> <tr> <td> bigstore </td> <td> true false ( default ) </td> <td> If true, the database uses Auto Tiering to add flash memory to the database </td> </tr> <tr> <td> bigstore-ram-size <size> </td> <td> size in bytes, kilobytes (KB), or gigabytes (GB) </td> <td> Maximum RAM limit for databases with Auto Tiering enabled </td> </tr> <tr> <td> with-module name=<module_name>, version=<module_version>, args=<module_args> </td> <td> strings </td> <td> Creates a database with a specific module </td> </tr> <tr> <td> eviction-policy </td> <td> noeviction ( default ) allkeys-lru allkeys-lfu allkeys-random volatile-lru volatile-lfu volatile-random volatile-ttl </td> <td> Sets <a href="/docs/latest/operate/rs/7.4/databases/memory-performance/eviction-policy/"> eviction policy </a> </td> </tr> <tr> <td> proxy-policy </td> <td> all-nodes all-master-shards single </td> <td> Sets proxy policy </td> </tr> </tbody> </table> <h3 id="returns"> Returns </h3> Returns the task ID of the task that is creating the database. If <code> --no-wait </code> is specified, the command exits. Otherwise, it will wait for the database to be created and then return the CRDB GUID. <h3 id="examples"> Examples </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ crdb-cli crdb create --name database1 --memory-size 1GB --port 12000 \ --instance fqdn=cluster1.redis.local,username=[email protected],password=admin \ --instance fqdn=cluster2.redis.local,username=[email protected],password=admin Task 633aaea3-97ee-4bcb-af39-a9cb25d7d4da created ---> Status changed: queued -> started ---> CRDB GUID Assigned: crdb:d84f6fe4-5bb7-49d2-a188-8900e09c6f66 ---> Status changed: started -> finished </code></pre> </div> To create an Active-Active database with two shards in each instance and with encrypted traffic between the clusters: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">crdb-cli crdb create --name mycrdb --memory-size 100mb --port 12000 --instance fqdn=cluster1.redis.local,username=[email protected],password=admin --instance fqdn=cluster2.redis.local,username=[email protected],password=admin --shards-count 2 --encryption true </code></pre> </div> To create an Active-Active database with two shards and with RediSearch 2.0.6 module: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">crdb-cli crdb create --name mycrdb --memory-size 100mb --port 12000 --instance fqdn=cluster1.redis.local,username=[email protected],password=admin --instance fqdn=cluster2.redis.local,username=[email protected],password=admin --shards-count 2 --with-module name=search,version="2.0.6",args="PARTITIONS AUTO" </code></pre> </div> To create an Active-Active database with two shards and with encrypted traffic between the clusters: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">crdb-cli crdb create --name mycrdb --memory-size 100mb --port 12000 --instance fqdn=cluster1.redis.local,username=[email protected],password=admin --instance fqdn=cluster2.redis.local,username=[email protected],password=admin --encryption true --shards-count 2 </code></pre> </div> To create an Active-Active database with 1 shard in each instance and not wait for the response: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">crdb-cli crdb create --name mycrdb --memory-size 100mb --port 12000 --instance fqdn=cluster1.redis.local,username=[email protected],password=admin --instance fqdn=cluster2.redis.local,username=[email protected],password=admin --no-wait </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/7.4/references/cli-utilities/crdb-cli/crdb/create/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rs-5-6-0-april-2020/.html

<section class="prose w-full py-12 max-w-none"> <h1> Redis Enterprise Software Release Notes 5.6.0 (April 2020) </h1> Install improvements for RHEL 6 and 7. Active-Active support for HyperLogLog. Auto Tiering now supports RedisJSON. Active-Active default changes for high availability and OSS Cluster API support. Backup support for Google Cloud Storage and Azure Blob storage. <a href="https://redislabs.com/download-center/"> Redis Enterprise Software (RS) 5.6.0 </a> is now available. This major version release includes: <ul> <li> Improved installation process to be customizable </li> <li> Support for the HyperLogLog data type in Active-Active databases </li> <li> RedisJSON support in databases with Auto Tiering enabled </li> <li> Support for Redis OSS Cluster API for Active-Active and Replica Of databases </li> <li> Replica HA enabled by default for Active-Active databases </li> <li> Cloud backup locations support </li> <li> Support for Red Hat Enterprise Linux version 7.7, 7.8 </li> <li> Additional enhancements, and minor bug fixes </li> </ul> <h2 id="information"> Information </h2> <h3 id="upgrade"> Upgrade </h3> <ul> <li> Follow <a href="/docs/latest/operate/rs/installing-upgrading/upgrading/"> these instructions </a> for upgrading to RS 5.6.0 from RS 5.0.2 and above. </li> <li> For Active-Active databases, you must upgrade the <a href="/docs/latest/operate/rs/installing-upgrading/upgrading/#upgrade-activeactive-databases"> feature set version </a> . </li> </ul> <h3 id="end-of-life"> End of life </h3> <ul> <li> End of Life (EOL) for Redis Enterprise Software 5.6 and previous RS versions can be found <a href="/docs/latest/operate/rs/installing-upgrading/product-lifecycle/"> here </a> . EOL for Redis Modules can be found <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/modules-lifecycle/#modules-endoflife-schedule"> here </a> . </li> <li> Support of Red Hat Enterprise Linux 6 and Oracle Linux 6 <a href="/docs/latest/operate/rs/references/supported-platforms/"> operating systems platforms </a> will end on November 30, 2020. </li> <li> Support of OpenStack Object Storage ("Swift") for <a href="https://docs.redis.com/latest/rs/databases/import-export/import-data/"> backup, import and export location </a> will end on November 30, 2020. </li> </ul> <h2 id="new-features"> New features </h2> <h3 id="redis-software-installer"> Redis Software installer </h3> Redis Enterprise Software installer adds the ability to specify custom installation paths and a custom installation user, group, or both on RHEL versions 6 and 7. When you run the installer you can specify the installation, the configuration and the var as well as the user and the group: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">sudo ./install.sh --install-dir <path> --config-dir <path> --var-dir <path> --os-user <user> --os-group <group> </code></pre> </div> For more information, check out the <a href="https://docs.redis.com/latest/rs/installing-upgrading/"> Redis Enterprise Software installer documentation </a> . <h3 id="hyperloglog-on-active-active"> Hyperloglog on Active-Active </h3> RS 5.6.0 adds the support of <a href="http://www.antirez.com/news/75"> HyperLogLog </a> data structure for <a href="/docs/latest/operate/rs/databases/import-export/replica-of/"> Active-Active Redis </a> databases. Because HyperLogLog is a counting data structure by nature, conflicts can occur when deleting entries. For efficiency, performance and memory considerations, conflicts between instances are resolved with DEL (delete) operations winning over ADD operations that took place in concurrent or before the DEL operation. For more information, check out the <a href="/docs/latest/operate/rs/databases/active-active/develop/hyperloglog-active-active.md"> HyperLogLog on Active-Active documentation </a> . <h3 id="redisjson-on-auto-tiering"> RedisJSON on Auto Tiering </h3> RS 5.6.0 adds support for <a href="/docs/latest/operate/rs/databases/auto-tiering/"> Auto Tiering </a> databases with <a href="https://docs.redis.com/latest/modules"> Redis Modules </a> . <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/json/"> RedisJSON </a> is the first module to be available to run on a database with Auto Tiering enabled. Using RedisJSON on Auto Tiering allows you to benefit from high performance redis with high data volume at lower costs. <h3 id="oss-cluster-api-support"> OSS Cluster API support </h3> For more information, check out the <a href="/docs/latest/operate/rs/databases/configure/oss-cluster-api/"> OSS Cluster API documentation </a> . Support for Active-Active and Replica Of databases You can configure <a href="/docs/latest/operate/rs/databases/import-export/replica-of/"> Active-Active </a> databases to use the <a href="https://docs.redis.com/latest/rs/clusters/optimize/oss-cluster-api/"> OSS Cluster API </a> using the admin console. The OSS Cluster API improves the performance of user operations against your database. You can also create or modify an Active-Active Redis database in OSS Cluster mode using the <code> crdb-cli </code> tool with the <code> --oss-cluster </code> option to apply the changes to all of the instances. Create and edit database using the admin console You can configure OSS Cluster API for databases using the admin console. For Active-Active databases, you can create the database with OSS Cluster API enabled for all of its instances. When you enable OSS Cluster after the Active-Active database is created, the change applies only to the local instance. <h3 id="replica-ha-defaults-for-active-active"> Replica HA defaults for Active-Active </h3> To enhance the availability and the consistency of <a href="/docs/latest/operate/rs/databases/active-active/"> Active-Active geo-distributed Redis </a> , <a href="/docs/latest/operate/rs/databases/configure/replica-ha/"> Replica HA </a> is enabled by default for all existing and new Active-Active Redis Databases. To disable Replica HA for for a local instance of an Active-Active database, run this command on the instance: <code> rladmin tune db <bdb_uid> slave_ha disabled </code> <h3 id="cloud-backup-locations-support"> Cloud backup locations support </h3> Redis Enterprise 5.6.0 adds the ability to configure Azure Blob Storage and Google Cloud Storage as backup, import, and export locations. <h3 id="red-hat-enterprise-linux-77-78"> Red Hat Enterprise Linux 7.7, 7.8 </h3> Redis Enterprise 5.6.0 adds RHEL 7.7, 7.8 to its <a href="/docs/latest/operate/rs/references/supported-platforms/"> supported platforms </a> . <h2 id="redis-modules"> Redis modules </h2> The following GA releases of Redis Modules are bundled in RS 5.6.0: <ul> <li> <a href="https://redislabs.com/redis-enterprise/redis-bloom/"> RedisBloom </a> , version <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.2-release-notes"> 2.2.1 </a> </li> <li> <a href="https://redislabs.com/redis-enterprise/redis-graph/"> RedisGraph </a> , version <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.0-release-notes"> 2.0.10 </a> </li> <li> <a href="https://redislabs.com/redis-enterprise/redis-json/"> RedisJson </a> , version <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-1.0-release-notes"> 1.0.4 </a> </li> <li> <a href="https://redislabs.com/redis-enterprise/redis-search/"> RediSearch </a> , version <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-1.6-release-notes"> 1.6.11 </a> (updated) </li> <li> <a href="https://redislabs.com/redis-enterprise/redis-time-series/"> RedisTimeSeries </a> , version <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.2-release-notes"> 1.2.3 </a> </li> </ul> <h2 id="additional-capabilities"> Additional capabilities </h2> <ul> <li> OSS Redis version <a href="https://raw.githubusercontent.com/antirez/redis/5.0/00-RELEASENOTES"> 5.0.8 </a> is merged into RS 5.6.0. </li> <li> Starting RS 5.6.0, to upgrade modules during database upgrade you must use the module_args option instead of keep_module_args or <argument> or “ ” (for no arguments). The module_args option must follow with one of the following (Always in quotation marks): “keep_args” or “ “ or “ <argument> ”. For more info and examples, check out <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module/"> upgrading Redis Modules documentation </a> . </argument> </argument> </li> <li> rladmin adds the ability to demote the cluster master node when setting it to <a href="/docs/latest/operate/rs/clusters/maintenance-mode/"> maintenance mode </a> by using the <code> demote_node </code> option: </li> </ul> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin node <node_uid> maintenance_mode on demote_node </code></pre> </div> <ul> <li> The <code> SENTINEL MASTER </code> command output format was updated to be aligned with OSS equivalent output. </li> </ul> <h2 id="important-fixes"> Important fixes </h2> <ul> <li> RS38315, RS33747 - Added the LUA script name (SHA) and its arguments to the warning message indicating the LUA script has been running for more than 5 seconds. </li> <li> RS38706 - Fixed a bug which caused a stuck state machine in some scenarios of restoring DB from RDB. </li> <li> RS34309 - Improved internal passwords handling. </li> <li> RS38498 - Fixed a bug in the upgrade process of a database to avoid failure when saving large RDB (Redis Database Backup) file. </li> <li> RS38706 - Fixed a bug that caused a stuck state machine after restoring a snapshot of an Active-Active database. </li> <li> RS43996 - Fixed a bug in the upgrade process when using ./install.sh -y and firewalld is not running. </li> <li> RS45777 - Fixed a bug that caused clients on a shared connection to the proxy to get disonnected. Disconnections occured in case a response for a request of an already disconnected client was received. With build 5.6.0-39: </li> <li> RS45627, RS47382 - Fixed bugs causing clients to disconnect when using XREAD and XREADGROUP commands in blocking mode on other clients’ connections. </li> <li> RS44656 - Fixed a bug causing TLS mode for clients connections to toggle between ‘all communication’ to ‘for crdb communication only’ when performing a global configuration change. </li> </ul> <h2 id="known-limitations"> Known limitations </h2> <h3 id="active-active-databases"> Active-Active databases </h3> <ul> <li> RS51359 - Active-Active databases, using replication and Append Only File (AOF) for <a href="/docs/latest/operate/rs/databases/configure/database-persistence/"> database persistence </a> , are suffering from memory leaks on replica shards, causing them to grow bigger than the master shards. Customers are advised to upgrade to RS 6.0.12. Meanwhile, you can use a snapshot for database persistence or restart the replica shards. </li> </ul> <h3 id="upgrade-notes"> Upgrade notes </h3> <ul> <li> <a href="/docs/latest/operate/rs/release-notes/legacy-release-notes/rs-5-4-2-april-2019/"> RS 5.4.2 </a> introduced new Active-Active Redis Database capabilities that improve its compatibility with open source Redis. Now the string data-type in Active-Active Redis Database is implicitly and dynamically typed, just like open source Redis. To use the new capabilities on nodes that are upgraded from version RS 5.4.2 or lower, you must <a href="/docs/latest/operate/rs/installing-upgrading/upgrading/#upgrading-crdbs"> upgrade the Active-Active Redis Database protocol </a> . </li> <li> When you upgrade an Active-Active Redis with active AOF from version <a href="/docs/latest/operate/rs/release-notes/legacy-release-notes/rs-5-4-2-april-2019/"> RS 5.4.2 </a> or lower to version <a href="/docs/latest/operate/rs/release-notes/legacy-release-notes/rs-5-4-4-june-2019/"> RS 5.4.4 </a> or higher: <ul> <li> If replication is enabled, you must run the BGREWRITEAOF command on all replica shards after the upgrade. </li> <li> If replication is not enabled, you must run the BGREWRITEAOF command on all shards after the upgrade. </li> </ul> </li> <li> Node upgrade fails if the SSL certificates were configured in version 5.0.2 or above by manually updating the certificates on the disk instead of <a href="/docs/latest/operate/rs/security/certificates/updating-certificates/"> updating them through the API </a> . For assistance with this issue, contact Support. </li> <li> Starting from <a href="/docs/latest/operate/rs/release-notes/legacy-release-notes/rs-5-4-2-april-2019/"> RS 5.4.2 </a> , to preserve the current Redis major.minor version during database upgrade you must use the keep_redis_version option instead of keep_current_version. </li> <li> Google Chrome browser on macOS Catalina requires a self-signed certificate generated after June 2019 to include the extendedKeyUsage field in order to connect to the RS admin console. If you use a self-signed certificate that does not include this field, <a href="/docs/latest/operate/rs/security/certificates/updating-certificates/"> update the self-signed certificate </a> . </li> </ul> <h3 id="modules-upgrade"> Modules upgrade </h3> <ul> <li> We recommend that you test module upgrade commands in a test environment before you upgrade modules in a production environment. The module upgrade arguments are not validated during the upgrade process and incorrect arguments can cause unexpected downtime. </li> <li> Before you upgrade a database with RediSearch Module to Redis 5.0, you must <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module/"> upgrade the RediSearch Module </a> to version 1.4.2 or above. </li> </ul> <h3 id="cluster-api"> Cluster API </h3> <ul> <li> The API for removing a node is updated in <a href="/docs/latest/operate/rs/release-notes/legacy-release-notes/rs-5-4-2-april-2019/"> RS 5.4.2 </a> or higher. The API call must include json data and the "Content-Type: application/json" header. For example: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">curl -X POST -H "Content-Type: application/json" -i -k -u [email protected]:password https://localhost:9443/v1/nodes/3/actions/remove --data "{}" </code></pre> </div> </li> </ul> <h3 id="discover-service"> Discover service </h3> <ul> <li> For <a href="/docs/latest/operate/rs/databases/durability-ha/discovery-service/"> Redis Sentinel (Discovery Service) </a> , every database name must be unique across the cluster. </li> </ul> <h3 id="redis-commands"> Redis commands </h3> <ul> <li> The capability of disabling specific Redis commands does not work on commands specific to Redis Modules. </li> <li> The CLIENT ID command cannot guarantee incremental IDs between clients that connect to different nodes under multi proxy policies. </li> <li> CLIENT UNBLOCK command is not supported in RS 5.4 and above </li> <li> Starting from RS 5.4.2 and after upgrading the CRDB, TYPE commands for string data-type in CRDBs return "string" (OSS Redis standard). </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/rs-5-6-0-april-2020/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/object-encoding/.html

<section class="prose w-full py-12"> <h1 class="command-name"> OBJECT ENCODING </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">OBJECT ENCODING key</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"> 2.2.3 </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> @keyspace </code> , <code> @read </code> , <code> @slow </code> , </dd> </dl> Returns the internal encoding for the Redis object stored at <code> <key> </code> Redis objects can be encoded in different ways: <ul> <li> Strings can be encoded as: <ul> <li> <code> raw </code> , normal string encoding. </li> <li> <code> int </code> , strings representing integers in a 64-bit signed interval, encoded in this way to save space. </li> <li> <code> embstr </code> , an embedded string, which is an object where the internal simple dynamic string, <code> sds </code> , is an unmodifiable string allocated in the same chuck as the object itself. <code> embstr </code> can be strings with lengths up to the hardcoded limit of <code> OBJ_ENCODING_EMBSTR_SIZE_LIMIT </code> or 44 bytes. </li> </ul> </li> <li> Lists can be encoded as: <ul> <li> <code> linkedlist </code> , simple list encoding. No longer used, an old list encoding. </li> <li> <code> ziplist </code> , Redis <= 6.2, a space-efficient encoding used for small lists. </li> <li> <code> listpack </code> , Redis >= 7.0, a space-efficient encoding used for small lists. </li> <li> <code> quicklist </code> , encoded as linkedlist of ziplists or listpacks. </li> </ul> </li> <li> Sets can be encoded as: <ul> <li> <code> hashtable </code> , normal set encoding. </li> <li> <code> intset </code> , a special encoding used for small sets composed solely of integers. </li> <li> <code> listpack </code> , Redis >= 7.2, a space-efficient encoding used for small sets. </li> </ul> </li> <li> Hashes can be encoded as: <ul> <li> <code> zipmap </code> , no longer used, an old hash encoding. </li> <li> <code> hashtable </code> , normal hash encoding. </li> <li> <code> ziplist </code> , Redis <= 6.2, a space-efficient encoding used for small hashes. </li> <li> <code> listpack </code> , Redis >= 7.0, a space-efficient encoding used for small hashes. </li> </ul> </li> <li> Sorted Sets can be encoded as: <ul> <li> <code> skiplist </code> , normal sorted set encoding. </li> <li> <code> ziplist </code> , Redis <= 6.2, a space-efficient encoding used for small sorted sets. </li> <li> <code> listpack </code> , Redis >= 7.0, a space-efficient encoding used for small sorted sets. </li> </ul> </li> <li> Streams can be encoded as: <ul> <li> <code> stream </code> , encoded as a radix tree of listpacks. </li> </ul> </li> </ul> All the specially encoded types are automatically converted to the general type once you perform an operation that makes it impossible for Redis to retain the space saving encoding. <h2 id="resp2-reply"> RESP2 Reply </h2> One of the following: <ul> <li> <a href="../../develop/reference/protocol-spec#bulk-strings"> Nil reply </a> : if the key doesn't exist. </li> <li> <a href="../../develop/reference/protocol-spec#bulk-strings"> Bulk string reply </a> : the encoding of the object. </li> </ul> <h2 id="resp3-reply"> RESP3 Reply </h2> One of the following: <ul> <li> <a href="../../develop/reference/protocol-spec#nulls"> Null reply </a> : if the key doesn't exist. </li> <li> <a href="../../develop/reference/protocol-spec#bulk-strings"> Bulk string reply </a> : the encoding of the object. </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/commands/object-encoding/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.0-release-notes/redisearch.io.html

<section class="prose w-full py-12 max-w-none"> <h1> Graph </h1> RedisGraph is a queryable graph database built on Redis. <div class="banner-article rounded-md"> Redis, Inc. has announced the end of life of RedisGraph. We will carry out the process gradually and in accordance with our commitment to our customers. See <a href="https://redis.io/blog/redisgraph-eol/"> details </a> . </div> RedisGraph is the first queryable <a href="https://github.com/opencypher/openCypher/blob/master/docs/property-graph-model.adoc"> Property Graph </a> database to use <a href="https://en.wikipedia.org/wiki/Sparse_matrix"> sparse matrices </a> to represent the <a href="https://en.wikipedia.org/wiki/Adjacency_matrix"> adjacency matrix </a> in graphs and <a href="http://faculty.cse.tamu.edu/davis/GraphBLAS.html"> linear algebra </a> to query the graph. <h2 id="primary-features"> Primary features </h2> <ul> <li> Based on the <a href="https://github.com/opencypher/openCypher/blob/master/docs/property-graph-model.adoc"> Property Graph Model </a> <ul> <li> Nodes (vertices) and Relationships (edges) that may have attributes </li> <li> Nodes that can be labeled </li> <li> Relationships have a relationship type </li> </ul> </li> <li> Graphs represented as sparse adjacency matrices </li> <li> <a href="http://www.opencypher.org/"> Cypher </a> as query language <ul> <li> Cypher queries translated into linear algebra expressions </li> </ul> </li> </ul> <h2 id="commands"> Commands </h2> See <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/commands/"> Graph commands </a> for a list of graph commands that are supported in Redis Enterprise. <h2 id="clients"> Clients </h2> For a list of available RedisGraph clients, see <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/clients.md"> RedisGraph client libraries </a> . <h2 id="configuration"> Configuration </h2> See <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/configuration.md"> Configuration parameters </a> for the complete list of RedisGraph configuration parameters. To learn which configuration parameters are supported in Redis Enterprise, see <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/config/"> Graph configuration compatibility with Redis Enterprise </a> . <h2 id="design"> Design </h2> For an overview of RedisGraph's design, see <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/design/_index.md"> RedisGraph: A High Performance In-Memory Graph Database </a> . <h3 id="client-specification"> Client specification </h3> RedisGraph client libraries should follow the <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/design/client_spec.md"> Technical specification for writing RedisGraph client libraries </a> . <h3 id="result-set-structure"> Result set structure </h3> <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/design/result_structure.md"> RedisGraph result set structure </a> describes the format RedisGraph uses to print data when using <code> redis-cli </code> . <h3 id="graphbulk-endpoint"> GRAPH.BULK endpoint </h3> You can import new graphs from CSV files using <code> redisgraph-bulk-loader </code> . See the <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/design/bulk_spec.md"> <code> GRAPH.BULK </code> implementation details </a> for more information. <h2 id="data-types"> Data types </h2> RedisGraph supports a number of distinct data types, including: <ul> <li> Graph types: <ul> <li> Nodes </li> <li> Relationships </li> <li> Paths </li> </ul> </li> <li> Scalar types: <ul> <li> Strings </li> <li> Booleans </li> <li> Integers </li> <li> Floating-point values </li> <li> Geospatial points </li> <li> Null </li> </ul> </li> <li> Collection types: <ul> <li> Arrays </li> <li> Maps </li> </ul> </li> </ul> See <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/datatypes.md"> RedisGraph data types </a> for details. <h2 id="cypher-coverage"> Cypher coverage </h2> RedisGraph implements a subset of the Cypher language. See <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/cypher_support.md"> Cypher coverage </a> for more information. <h2 id="path-algorithms"> Path algorithms </h2> To learn how to find single-pair and single-source paths using <code> algo.SPpaths </code> and <code> algo.SSpaths </code> , see <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/path_algorithm.md"> Path algorithms </a> . <h2 id="known-limitations"> Known limitations </h2> RedisGraph has several <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/known_limitations.md"> known limitations </a> . <h2 id="more-info"> More info </h2> <ul> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/graph-quickstart/"> Graph quick start </a> </li> <li> <a href="https://github.com/RedisGraph/RedisGraph/tree/master/docs/docs"> RedisGraph documentation on GitHub </a> </li> <li> <a href="https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/References.md"> References </a> </li> <li> <a href="https://github.com/RedisGraph/RedisGraph/"> RedisGraph source </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/oss_and_stack/stack-with-enterprise/deprecated-features/graph/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/restore-asking/.html

<section class="prose w-full py-12"> <h1 class="command-name"> RESTORE-ASKING </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">RESTORE-ASKING key ttl serialized-value [REPLACE] [ABSTTL] [IDLETIME seconds] [FREQ frequency]</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"> 3.0.0 </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(1) to create the new key and additional O(N*M) to reconstruct the serialized value, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1*M) where M is small, so simply O(1). However for sorted set values the complexity is O(N*M*log(N)) because inserting values into sorted sets is O(log(N)). </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @keyspace </code> , <code> @write </code> , <code> @slow </code> , <code> @dangerous </code> , </dd> </dl> The <code> RESTORE-ASKING </code> command is an internal command. It is used by a Redis cluster master during slot migration. <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> <a href="../../develop/reference/protocol-spec#simple-strings"> Simple string reply </a> : <code> OK </code> . <h2> History </h2> <ul> <li> Starting with Redis version 3.0.0: Added the <code> REPLACE </code> modifier. </li> <li> Starting with Redis version 5.0.0: Added the <code> ABSTTL </code> modifier. </li> <li> Starting with Redis version 5.0.0: Added the <code> IDLETIME </code> and <code> FREQ </code> options. </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/commands/restore-asking/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.10-release-notes.html

<section class="prose w-full py-12 max-w-none"> <h1> RedisTimeSeries 1.10 release notes </h1> RESP3 support. Performance improvements. <h2 id="requirements"> Requirements </h2> RedisTimeSeries v1.10.12 requires: <ul> <li> Minimum Redis compatibility version (database): 7.2 </li> <li> Minimum Redis Enterprise Software version (cluster): 7.2.4 </li> </ul> <h2 id="v11012-march-2024"> v1.10.12 (March 2024) </h2> This is a maintenance release for RedisTimeSeries 1.10. Update urgency: <code> LOW </code> : No need to upgrade unless there are new features you want to use. Details: <ul> <li> Improvements: <ul> <li> <a href="https://github.com/RedisTimeSeries/RedisTimeSeries/pull/1593"> #1593 </a> More detailed LibMR error messages </li> </ul> </li> </ul> <h2 id="v11011-october-2023"> v1.10.11 (October 2023) </h2> This is a maintenance release for RedisTimeSeries 1.10. Update urgency: <code> LOW </code> : No need to upgrade unless there are new features you want to use. Details: <ul> <li> Bug fixes: <ul> <li> <a href="https://github.com/RedisGears/LibMR/pull/51"> LibMR#51 </a> Crash on SSL initialization failure (MOD-5647) </li> <li> <a href="https://github.com/RedisTimeSeries/RedisTimeSeries/pull/1538"> #1538 </a> Amazon Linux 2: crash on SSL initialization. We now use openssl11-devel instead of openssl-devel (MOD-6015) </li> </ul> </li> </ul> <h2 id="v1109-october-2023"> v1.10.9 (October 2023) </h2> This is a maintenance release for RedisTimeSeries 1.10. Update urgency: <code> LOW </code> : No need to upgrade unless there are new features you want to use. Details: <ul> <li> Improvements: <ul> <li> <a href="https://github.com/RedisTimeSeries/RedisTimeSeries/pull/1516"> #1516 </a> Added support for CBL-Mariner 2 </li> <li> <a href="https://github.com/RedisTimeSeries/RedisTimeSeries/pull/1514"> #1514 </a> Added support for Rocky Linux 9 and RHEL9 </li> </ul> </li> </ul> <h2 id="v1106-september-2023"> v1.10.6 (September 2023) </h2> This is a maintenance release for RedisTimeSeries 1.10. Update urgency: <code> SECURITY </code> : There are security fixes in the release. Details: <ul> <li> Security and privacy: <ul> <li> <a href="https://github.com/RedisTimeSeries/RedisTimeSeries/pull/1506"> #1506 </a> Don’t expose internal commands (MOD-5643) </li> </ul> </li> </ul> <h2 id="v110-ga-v1104-july-2023"> v1.10 GA (v1.10.4) (July 2023) </h2> This is the General Availability release of RedisTimeSeries 1.10. <h3 id="headlines"> Headlines </h3> RedisTimeSeries 1.10 introduces support for RESP3, performance improvements, and bug fixes. <h3 id="details"> Details </h3> Bug fixes (since 1.10-RC3): <ul> <li> <a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/1494"> #1494 </a> Potential crash when using an invalid argument value </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"> Note: </div> <ul> <li> The version inside Redis will be 1.10.4 in semantic versioning. Since the version of a module in Redis is numeric, we could not add a GA flag. </li> <li> Minimal Redis version: 7.2 </li> </ul> </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/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.10-release-notes/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/cli-utilities/rladmin/cluster/config/.html

<section class="prose w-full py-12 max-w-none"> <h1> rladmin cluster config </h1> Updates the cluster's configuration. Updates the cluster configuration. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh"> rladmin cluster config [ auditing db_conns audit_protocol { TCP | local } audit_address <audit_address> audit_port <audit_port> ] [bigstore_driver {speedb | rocksdb} ] [ control_cipher_suites <BoringSSL cipher list> ] [ cm_port <number> ] [ cm_session_timeout_minutes <minutes> ] [ cnm_http_port <number> ] [ cnm_https_port <number> ] [ crdb_coordinator_port <number> ] [ data_cipher_list <openSSL cipher list> ] [ data_cipher_suites_tls_1_3 <openSSL cipher list> ] [ debuginfo_path <filepath> ] [ encrypt_pkeys { enabled | disabled } ] [ envoy_admin_port <new-port> ] [ envoy_mgmt_server_port <new-port> ] [ gossip_envoy_admin_port <new-port> ] [ handle_redirects { enabled | disabled } ] [ handle_metrics_redirects { enabled | disabled } ] [ http_support { enabled | disabled } ] [ ipv6 { enabled | disabled } ] [ min_control_TLS_version { 1.2 | 1.3 } ] [ min_data_TLS_version { 1.2 | 1.3 } ] [ min_sentinel_TLS_version { 1.2 | 1.3 } ] [ reserved_ports <list of ports/port ranges> ] [ s3_url <URL> ] [ s3_ca_cert <filepath> ] [ saslauthd_ldap_conf </tmp/ldap.conf> ] [ sentinel_tls_mode { allowed | required | disabled } ] [ sentinel_cipher_suites <golang cipher list> ] [ services { cm_server | crdb_coordinator | crdb_worker | mdns_server | pdns_server | saslauthd | stats_archiver } { enabled | disabled } ] [ upgrade_mode { enabled | disabled } ] </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> audit_address </td> <td> string </td> <td> TCP/IP address where a listener can capture <a href="/docs/latest/operate/rs/7.4/security/audit-events/"> audit event notifications </a> </td> </tr> <tr> <td> audit_port </td> <td> string </td> <td> Port where a listener can capture <a href="/docs/latest/operate/rs/7.4/security/audit-events/"> audit event notifications </a> </td> </tr> <tr> <td> audit_protocol </td> <td> <code> tcp </code> <code> local </code> </td> <td> Protocol used for <a href="/docs/latest/operate/rs/7.4/security/audit-events/"> audit event notifications </a> For production systems, only <code> tcp </code> is supported. </td> </tr> <tr> <td> control_cipher_suites </td> <td> list of ciphers </td> <td> Cipher suites used for TLS connections to the Cluster Manager UI (specified in the format understood by the BoringSSL library) (previously named <code> cipher_suites </code> ) </td> </tr> <tr> <td> cm_port </td> <td> integer </td> <td> UI server listening port </td> </tr> <tr> <td> cm_session_timeout_minutes </td> <td> integer </td> <td> Timeout in minutes for the CM session </td> </tr> <tr> <td> cnm_http_port </td> <td> integer </td> <td> HTTP REST API server listening port </td> </tr> <tr> <td> cnm_https_port </td> <td> integer </td> <td> HTTPS REST API server listening port </td> </tr> <tr> <td> crdb_coordinator_port </td> <td> integer, (range: 1024-65535) (default: 9081) </td> <td> CRDB coordinator port </td> </tr> <tr> <td> data_cipher_list </td> <td> list of ciphers </td> <td> Cipher suites used by the the data plane (specified in the format understood by the OpenSSL library) </td> </tr> <tr> <td> data_cipher_suites_tls_1_3 </td> <td> list of ciphers </td> <td> Specifies the enabled TLS 1.3 ciphers for the data plane </td> </tr> <tr> <td> debuginfo_path </td> <td> filepath </td> <td> Local directory to place generated support package files </td> </tr> <tr> <td> encrypt_pkeys </td> <td> <code> enabled </code> <code> disabled </code> </td> <td> Enable or turn off encryption of private keys </td> </tr> <tr> <td> envoy_admin_port </td> <td> integer, (range: 1024-65535) </td> <td> Envoy admin port. Changing this port during runtime might result in an empty response because envoy serves as the cluster gateway. </td> </tr> <tr> <td> envoy_mgmt_server_port </td> <td> integer, (range: 1024-65535) </td> <td> Envoy management server port </td> </tr> <tr> <td> gossip_envoy_admin_port </td> <td> integer, (range: 1024-65535) </td> <td> Gossip envoy admin port </td> </tr> <tr> <td> handle_redirects </td> <td> <code> enabled </code> <code> disabled </code> </td> <td> Enable or turn off handling DNS redirects when DNS is not configured and running behind a load balancer </td> </tr> <tr> <td> handle_metrics_redirects </td> <td> <code> enabled </code> <code> disabled </code> </td> <td> Enable or turn off handling cluster redirects internally for Metrics API </td> </tr> <tr> <td> http_support </td> <td> <code> enabled </code> <code> disabled </code> </td> <td> Enable or turn off using HTTP for REST API connections </td> </tr> <tr> <td> ipv6 </td> <td> <code> enabled </code> <code> disabled </code> </td> <td> Enable or turn off IPv6 connections to the Cluster Manager UI </td> </tr> <tr> <td> min_control_TLS_version </td> <td> <code> 1.2 </code> <code> 1.3 </code> </td> <td> The minimum TLS protocol version that is supported for the control path </td> </tr> <tr> <td> min_data_TLS_version </td> <td> <code> 1.2 </code> <code> 1.3 </code> </td> <td> The minimum TLS protocol version that is supported for the data path </td> </tr> <tr> <td> min_sentinel_TLS_version </td> <td> <code> 1.2 </code> <code> 1.3 </code> </td> <td> The minimum TLS protocol version that is supported for the discovery service </td> </tr> <tr> <td> reserved_ports </td> <td> list of ports/port ranges </td> <td> List of reserved ports and/or port ranges to avoid using for database endpoints (for example <code> reserved_ports 11000 13000-13010 </code> ) </td> </tr> <tr> <td> s3_url </td> <td> string </td> <td> The URL of S3 export and import </td> </tr> <tr> <td> s3_ca_cert </td> <td> string </td> <td> The CA certificate filepath for S3 export and import </td> </tr> <tr> <td> saslauthd_ldap_conf </td> <td> filepath </td> <td> Updates LDAP authentication configuration for the cluster </td> </tr> <tr> <td> sentinel_cipher_suites </td> <td> list of ciphers </td> <td> Cipher suites used by the discovery service (supported ciphers are implemented by the <a href="https://golang.org/src/crypto/tls/cipher_suites.go"> cipher_suites.go </a> package) </td> </tr> <tr> <td> sentinel_tls_mode </td> <td> <code> allowed </code> <code> required </code> <code> disabled </code> </td> <td> Define the SSL policy for the discovery service (previously named <code> sentinel_ssl_policy </code> ) </td> </tr> <tr> <td> services </td> <td> <code> cm_server </code> <code> crdb_coordinator </code> <code> crdb_worker </code> <code> mdns_server </code> <code> pdns_server </code> <code> saslauthd </code> <code> stats_archiver </code> <code> enabled </code> <code> disabled </code> </td> <td> Enable or turn off selected cluster services </td> </tr> <tr> <td> upgrade_mode </td> <td> <code> enabled </code> <code> disabled </code> </td> <td> Enable or turn off upgrade mode on the cluster </td> </tr> </tbody> </table> <h3 id="returns"> Returns </h3> Reports whether the cluster was configured successfully. Displays an error message if the configuration attempt fails. <h3 id="example"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin cluster config cm_session_timeout_minutes 20 Cluster configured successfully </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/7.4/references/cli-utilities/rladmin/cluster/config/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears/.html

<section class="prose w-full py-12 max-w-none"> <h1> Install RedisGears </h1> Before you can use RedisGears, you have to install the RedisGears module on your Redis Enterprise cluster. <h2 id="minimum-requirements"> Minimum requirements </h2> <ul> <li> Redis Enterprise 6.0.12 or later </li> <li> The <a href="/docs/latest/operate/rs/clusters/new-cluster-setup/"> cluster is setup </a> and all of the nodes are joined to the cluster </li> </ul> <h2 id="install-redisgears"> Install RedisGears </h2> If your cluster uses Redis Enterprise v6.0.12 or later and has internet access, you only need to download the RedisGears package. It automatically fetches dependencies like the Python and JVM plugins during online installation. Offline installation requires you to manually upload dependencies to the master node. <h3 id="install-redisgears-and-dependencies"> Install RedisGears and dependencies </h3> <ol> <li> Download the RedisGears package from the Redis Enterprise <a href="https://cloud.redis.io/#/rlec-downloads"> download center </a> . <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> For offline installation of RedisGears v1.2 and later, you also need to download the RedisGears Dependencies packages for both Python and Java. For RedisGears v1.0, you only need the Python dependency package. </div> </div> </li> <li> Upload the RedisGears package to a node in the cluster. </li> <li> For offline installation only, copy the dependencies to the following directory on the master node: <code> $modulesdatadir/rg/<version-integer>/deps/ </code> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ cp redisgears-jvm.<OS>.<version>.tgz $modulesdatadir/rg/<version-integer>/deps/ </code></pre> </div> Replace these fields with your own values: <ul> <li> <code> <OS> </code> : the operating system running Redis Enterprise </li> <li> <code> <version> </code> : the RedisGears version <code> (x.y.z) </code> </li> <li> <code> <version-integer> </code> : the RedisGears version as an integer, calculated as <code> (x*10000 + y*100 + z) </code> For example, the <code> <version-integer> </code> for RedisGears version 1.2.5 is 10205. </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"> Note: </div> Skip this step unless your cluster does not have internet access. </div> </div> </li> <li> Add RedisGears to the cluster with a <code> POST </code> request to the master node's <a href="/docs/latest/operate/rs/references/rest-api/requests/modules/#post-module-v2"> <code> /v2/modules </code> </a> REST API endpoint: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">POST https://[host][:port]/v2/modules {"module=@/tmp/redisgears.<OS>.<version>.zip"} </code></pre> </div> </li> </ol> Here, the module parameter specifies the full path of the module package and must be submitted as form-data. In addition, the package must be available and accessible to the server processing the request. After the install is complete, RedisGears will appear in the list of available modules on the settings and create database pages of the Redis Enterprise admin console. <h3 id="enable-redisgears-for-a-database"> Enable RedisGears for a database </h3> After installation, create a new database and enable RedisGears: <ul> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/python/install/"> With Python </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/install/"> With the JVM </a> </li> </ul> <h2 id="uninstall-redisgears"> Uninstall RedisGears </h2> To uninstall RedisGears, make a <a href="/docs/latest/operate/rs/references/rest-api/requests/modules/#delete-module-v2"> <code> DELETE </code> request to the <code> /v2/modules </code> REST API endpoint </a> . <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/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/requests/bdbs/syncer_state/replica/.html

<section class="prose w-full py-12 max-w-none"> <h1> Replica syncer state requests </h1> Replica syncer state requests <table> <thead> <tr> <th> Method </th> <th> Path </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="#get-syncer-state"> GET </a> </td> <td> <code> /v1/bdbs/{uid}/syncer_state/replica </code> </td> <td> Get a CRDB replica's syncer state </td> </tr> </tbody> </table> <h2 id="get-syncer-state"> Get replica syncer state </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /v1/bdbs/{int: uid}/syncer_state/replica </code></pre> </div> Get a CRDB replica's syncer state as JSON. <h3 id="permissions"> Permissions </h3> <table> <thead> <tr> <th> Permission name </th> <th> Roles </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_bdb_info"> view_bdb_info </a> </td> <td> admin cluster_member cluster_viewer db_member db_viewer </td> </tr> </tbody> </table> <h3 id="get-request"> Request </h3> <h4 id="example-http-request"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /v1/bdbs/1/syncer_state/replica </code></pre> </div> <h4 id="headers"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> </tr> </thead> <tbody> <tr> <td> Host </td> <td> The domain name or IP of the cluster. </td> </tr> <tr> <td> Accept </td> <td> application/json </td> </tr> </tbody> </table> <h4 id="url-parameters"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> uid </td> <td> integer </td> <td> The unique ID of the database requested. </td> </tr> </tbody> </table> <h3 id="get-response"> Response </h3> Returns a JSON object that represents the syncer state. <h4 id="example-json-body"> Example JSON body </h4> <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "DB": 22, "RunID": 1584086516, // additional fields... } </code></pre> </div> <h4 id="get-status-codes"> Status codes </h4> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> OK </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Syncer state key does not exist </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"> 500 Internal Server Error </a> </td> <td> Internal error </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4"> 503 Service Unavailable </a> </td> <td> Redis connection error, service unavailable </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/rest-api/requests/bdbs/syncer_state/replica/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rs-7-4-2-releases/rs-7-4-6-102/.html

<section class="prose w-full py-12 max-w-none"> <h1> Redis Enterprise Software release notes 7.4.6-102 (October 2024) </h1> Updated module feature sets with later versions of RediSearch and RedisTimeSeries. This is a maintenance release for <a href="https://redis.com/redis-enterprise-software/download-center/software/"> Redis Enterprise Software version 7.4.6 </a> . <h2 id="highlights"> Highlights </h2> This version offers: <ul> <li> Updated module feature sets with later versions of RediSearch and RedisTimeSeries </li> </ul> <h2 id="new-in-this-release"> New in this release </h2> <h4 id="redis-module-feature-sets"> Redis module feature sets </h4> Redis Enterprise comes packaged with several modules. As of version 7.4.2, Redis Enterprise includes two feature sets, compatible with different Redis database versions. Bundled Redis modules compatible with Redis database version 7.2: <ul> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.8-release-notes/"> RediSearch 2.8.19 </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.6-release-notes/"> RedisJSON 2.6.13 </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.10-release-notes/"> RedisTimeSeries 1.10.15 </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.6-release-notes/"> RedisBloom 2.6.15 </a> </li> <li> <a href="https://github.com/RedisGears/RedisGears/releases/tag/v2.0.20-m21"> RedisGears 2.0.20 preview </a> : The RedisGears preview will not be promoted to GA and will be removed in a future release. </li> </ul> Bundled Redis modules compatible with Redis database versions 6.0 and 6.2: <ul> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.6-release-notes/"> RediSearch 2.6.23 </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.4-release-notes/"> RedisJSON 2.4.9 </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.8-release-notes/"> RedisTimeSeries 1.8.15 </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.4-release-notes/"> RedisBloom 2.4.12 </a> </li> <li> <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.10-release-notes/"> RedisGraph v2.10.15 </a> : RedisGraph end-of-life has been announced and will be removed in a future release. See the <a href="https://redis.io/blog/redisgraph-eol/"> RedisGraph end-of-life announcement </a> for more details. </li> </ul> <h2 id="version-changes"> Version changes </h2> <h3 id="product-lifecycle-updates"> Product lifecycle updates </h3> <h4 id="end-of-life-policy-extension"> End-of-life policy extension </h4> The end-of-life policy for Redis Enterprise Software versions 6.2 and later has been extended to 24 months after the formal release of the subsequent major version. For the updated end-of-life schedule, see the <a href="/docs/latest/operate/rs/installing-upgrading/product-lifecycle/"> Redis Enterprise Software product lifecycle </a> . <h4 id="supported-upgrade-paths"> Supported upgrade paths </h4> Redis Enterprise Software versions 6.2.4 and 6.2.8 do not support direct upgrades beyond version 7.4.x. Versions 6.2.10, 6.2.12, and 6.2.18 are part of the <a href="/docs/latest/operate/rs/installing-upgrading/upgrading/upgrade-cluster/#supported-upgrade-paths"> upgrade path </a> . To upgrade from 6.2.4 or 6.2.8 to versions later than 7.4.x, an intermediate upgrade is required. The next major Redis Enterprise Software release will still bundle Redis database version 6.2 and allow database upgrades from Redis database version 6.2 to 7.x. See the <a href="/docs/latest/operate/rs/installing-upgrading/product-lifecycle/"> Redis Enterprise Software product lifecycle </a> for more information about release numbers. <h3 id="deprecations"> Deprecations </h3> <h4 id="legacy-ui-deprecation"> Legacy UI deprecation </h4> The legacy UI is deprecated in favor of the new Cluster Manager UI and will be removed in a future release. <h4 id="redis-60-database-deprecation"> Redis 6.0 database deprecation </h4> Redis database version 6.0 is deprecated as of Redis Enterprise Software version 7.4.2 and will be removed in a future release. To prepare for the future removal of Redis 6.0: <ul> <li> For Redis Enterprise 6.2.* clusters, upgrade Redis 6.0 databases to Redis 6.2. See the <a href="https://raw.githubusercontent.com/redis/redis/6.2/00-RELEASENOTES"> Redis 6.2 release notes </a> for the list of changes. </li> <li> For Redis Enterprise 7.2.4 and 7.4.x clusters, upgrade Redis 6.0 databases to Redis 7.2. Before you upgrade your databases, see the list of <a href="/docs/latest/operate/rs/release-notes/rs-7-2-4-releases/rs-7-2-4-52/#redis-72-breaking-changes"> Redis 7.2 breaking changes </a> and update any applications that connect to your database to handle these changes. </li> </ul> <h4 id="end-of-triggers-and-functions-preview"> End of triggers and functions preview </h4> The <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/"> triggers and functions </a> (RedisGears) preview has been discontinued. <ul> <li> Commands such as <code> TFCALL </code> , <code> TFCALLASYNC </code> , and <code> TFUNCTION </code> will be deprecated and will return error messages. </li> <li> Any JavaScript functions stored in Redis will be removed. </li> <li> JavaScript-based triggers will be blocked. </li> <li> Lua functions and scripts will not be affected. </li> </ul> If your database currently uses triggers and functions, you need to: <ol> <li> Adjust your applications to accommodate these changes. </li> <li> Delete all triggers and functions libraries from your existing database: <ol> <li> Run <code> TFUNCTION LIST </code> . </li> <li> Copy all library names. </li> <li> Run <code> TFUNCTION DELETE </code> for each library in the list. </li> </ol> If any triggers and functions libraries remain in the database, the RDB snapshot won't load on a cluster without RedisGears. </li> <li> Migrate your database to a new database without the RedisGears module. </li> </ol> <h4 id="redisgraph-end-of-life"> RedisGraph end of life </h4> Redis has announced the end of life for RedisGraph. Redis will continue to support all RedisGraph customers, including releasing patch versions until January 31, 2025. See the <a href="https://redis.com/blog/redisgraph-eol/"> RedisGraph end-of-life announcement </a> for more details. <h3 id="upcoming-changes"> Upcoming changes </h3> <h4 id="default-image-change-for-redis-enterprise-software-containers"> Default image change for Redis Enterprise Software containers </h4> Starting with the next major version, Redis Enterprise Software containers with the image tag <code> x.y.z-build </code> will be based on RHEL instead of Ubuntu. This change will only affect you if you use containers outside the official <a href="/docs/latest/operate/kubernetes/"> Redis Enterprise for Kubernetes </a> product and use Ubuntu-specific commands. To use Ubuntu-based images after this change, you can specify the operating system suffix in the image tag. For example, use the image tag <code> 7.4.2-216.focal </code> instead of <code> 7.4.2-216 </code> . <h3 id="supported-platforms"> Supported platforms </h3> The following table provides a snapshot of supported platforms as of this Redis Enterprise Software release. See the <a href="/docs/latest/operate/rs/references/supported-platforms/"> supported platforms reference </a> for more details about operating system compatibility. ✅ Supported – The platform is supported for this version of Redis Enterprise Software and Redis Stack modules. ⚠️ Deprecation warning – The platform is still supported for this version of Redis Enterprise Software, but support will be removed in a future release. <table> <thead> <tr> <th> Redis Enterprise major versions </th> <th style="text-align:center"> 7.4 </th> <th style="text-align:center"> 7.2 </th> <th style="text-align:center"> 6.4 </th> <th style="text-align:center"> 6.2 </th> </tr> </thead> <tbody> <tr> <td> Release date </td> <td style="text-align:center"> Feb 2024 </td> <td style="text-align:center"> Aug 2023 </td> <td style="text-align:center"> Feb 2023 </td> <td style="text-align:center"> Aug 2021 </td> </tr> <tr> <td> <a href="/docs/latest/operate/rs/installing-upgrading/product-lifecycle/#endoflife-schedule"> End-of-life date </a> </td> <td style="text-align:center"> Determined after next major release </td> <td style="text-align:center"> Feb 2026 </td> <td style="text-align:center"> Aug 2025 </td> <td style="text-align:center"> Feb 2025 </td> </tr> <tr> <td> Platforms </td> <td style="text-align:center"> </td> <td style="text-align:center"> </td> <td style="text-align:center"> </td> <td style="text-align:center"> </td> </tr> <tr> <td> RHEL 9 & compatible distros <a href="#table-note-1"> 1 </a> </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> – </td> <td style="text-align:center"> – </td> <td style="text-align:center"> – </td> </tr> <tr> <td> RHEL 8 & compatible distros <a href="#table-note-1"> 1 </a> </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> </tr> <tr> <td> RHEL 7 & compatible distros <a href="#table-note-1"> 1 </a> </td> <td style="text-align:center"> – </td> <td style="text-align:center"> ⚠️ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> </tr> <tr> <td> Ubuntu 20.04 <a href="#table-note-2"> 2 </a> </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> – </td> </tr> <tr> <td> Ubuntu 18.04 <a href="#table-note-2"> 2 </a> </td> <td style="text-align:center"> ⚠️ </td> <td style="text-align:center"> ⚠️ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> </tr> <tr> <td> Ubuntu 16.04 <a href="#table-note-2"> 2 </a> </td> <td style="text-align:center"> – </td> <td style="text-align:center"> ⚠️ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> </tr> <tr> <td> Amazon Linux 2 </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> – </td> </tr> <tr> <td> Amazon Linux 1 </td> <td style="text-align:center"> – </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> </tr> <tr> <td> Kubernetes <a href="#table-note-3"> 3 </a> </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> </tr> <tr> <td> Docker <a href="#table-note-4"> 4 </a> </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> <td style="text-align:center"> ✅ </td> </tr> </tbody> </table> <ol> <li> <a name="table-note-1" style="display: block; height: 80px; margin-top: -80px;"> </a> The RHEL-compatible distributions CentOS, CentOS Stream, Alma, and Rocky are supported if they have full RHEL compatibility. Oracle Linux running the Red Hat Compatible Kernel (RHCK) is supported, but the Unbreakable Enterprise Kernel (UEK) is not supported. </li> <li> <a name="table-note-2" style="display: block; height: 80px; margin-top: -80px;"> </a> The server version of Ubuntu is recommended for production installations. The desktop version is only recommended for development deployments. </li> <li> <a name="table-note-3" style="display: block; height: 80px; margin-top: -80px;"> </a> See the <a href="/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/"> Redis Enterprise for Kubernetes documentation </a> for details about support per version and Kubernetes distribution. </li> <li> <a name="table-note-4" style="display: block; height: 80px; margin-top: -80px;"> </a> <a href="/docs/latest/operate/rs/installing-upgrading/quickstarts/docker-quickstart/"> Docker images </a> of Redis Enterprise Software are certified for development and testing only. </li> </ol> <h2 id="downloads"> Downloads </h2> The following table shows the SHA256 checksums for the available packages: <table> <thead> <tr> <th> Package </th> <th> SHA256 checksum (7.4.6-102 October release) </th> </tr> </thead> <tbody> <tr> <td> Ubuntu 18 </td> <td> f4e6af466b565e59d2e3fb1f5f0c70b7903564a0f1a45cc5a6816caf20059f93 </td> </tr> <tr> <td> Ubuntu 20 </td> <td> 9f10ed232a5655fdc5b46d2dd98157449484fb03290c8c71994cf29b50c4b4a7 </td> </tr> <tr> <td> Red Hat Enterprise Linux (RHEL) 8 </td> <td> 412a2244e5fd464382acccf811a221671c120fcb51d00bf6bc3089b6f9ad034e </td> </tr> <tr> <td> Red Hat Enterprise Linux (RHEL) 9 </td> <td> b4fc25f6a812fe05ab990049f7f6f8a22932c5d8c507c475455802009ed5acca </td> </tr> <tr> <td> Amazon Linux 2 </td> <td> ab3dafdc46823548a6a4a2870be1db21cd2d907533bd0fddf59a895b94c00863 </td> </tr> </tbody> </table> <h2 id="known-issues"> Known issues </h2> <ul> <li> RS131972: Creating an ACL that contains a line break in the Cluster Manager UI can cause shard migration to fail due to ACL errors. </li> <li> RS61676: Full chain certificate update fails if any certificate in the chain does not have a Common Name (CN). </li> <li> RS119958: The <code> debuginfo </code> script fails with the error <code> /bin/tar: Argument list too long </code> if there are too many RocksDB log files. This issue only affects clusters with Auto Tiering. </li> </ul> <h2 id="known-limitations"> Known limitations </h2> <h4 id="new-cluster-manager-ui-limitations"> New Cluster Manager UI limitations </h4> The following legacy UI features are not yet available in the new Cluster Manager UI: <ul> <li> Remove a node. Use the REST API or legacy UI instead. See <a href="/docs/latest/operate/rs/clusters/remove-node/"> Remove a cluster node </a> for instructions. </li> <li> Purge an Active-Active instance. Use <a href="/docs/latest/operate/rs/references/cli-utilities/crdb-cli/crdb/purge-instance/"> <code> crdb-cli crdb purge-instance </code> </a> instead. </li> <li> Search and export the log. </li> </ul> <h4 id="openssl-compatibility-issue-for-742-modules-on-amazon-linux-2"> OpenSSL compatibility issue for 7.4.2 modules on Amazon Linux 2 </h4> Due to an OpenSSL 1.1 compatibility issue between modules and clusters, Redis Enterprise Software version 7.4.2-54 is not fully supported on Amazon Linux 2 clusters with databases that use the following modules: RedisGears, RediSearch, or RedisTimeSeries. This issue will be fixed in a future maintenance release. <h4 id="redisgraph-prevents-upgrade-to-rhel-9"> RedisGraph prevents upgrade to RHEL 9 </h4> You cannot upgrade from a prior RHEL version to RHEL 9 if the Redis Enterprise cluster contains a RedisGraph module, even if unused by any database. The <a href="https://redis.com/blog/redisgraph-eol/"> RedisGraph module has reached End-of-Life </a> and is completely unavailable in RHEL 9. <h2 id="security"> Security </h2> <h4 id="open-source-redis-security-fixes-compatibility"> Open source Redis security fixes compatibility </h4> As part of Redis's commitment to security, Redis Enterprise Software implements the latest <a href="https://github.com/redis/redis/releases"> security fixes </a> available with <a href="https://github.com/redis/redis"> open source Redis </a> . Redis Enterprise has already included the fixes for the relevant CVEs. Some CVEs announced for open source Redis do not affect Redis Enterprise due to different or additional functionality available in Redis Enterprise that is not available in open source Redis. Redis Enterprise 7.4.6-102 supports open source Redis 7.2, 6.2, and 6.0. Below is the list of open source Redis CVEs fixed by version. Redis 7.2.x: <ul> <li> (CVE-2024-31449) An authenticated user may use a specially crafted Lua script to trigger a stack buffer overflow in the bit library, which may potentially lead to remote code execution. </li> <li> (CVE-2024-31228) An authenticated user can trigger a denial-of-service by using specially crafted, long string match patterns on supported commands such as <code> KEYS </code> , <code> SCAN </code> , <code> PSUBSCRIBE </code> , <code> FUNCTION LIST </code> , <code> COMMAND LIST </code> , and ACL definitions. Matching of extremely long patterns may result in unbounded recursion, leading to stack overflow and process crashes. </li> <li> (CVE-2023-41056) In some cases, Redis may incorrectly handle resizing of memory buffers, which can result in incorrect accounting of buffer sizes and lead to heap overflow and potential remote code execution. </li> <li> (CVE-2023-41053) Redis does not correctly identify keys accessed by <code> SORT_RO </code> and, as a result, may grant users executing this command access to keys that are not explicitly authorized by the ACL configuration. (Redis 7.2.1) </li> </ul> Redis 7.0.x: <ul> <li> (CVE-2024-31449) An authenticated user may use a specially crafted Lua script to trigger a stack buffer overflow in the bit library, which may potentially lead to remote code execution. </li> <li> (CVE-2024-31228) An authenticated user can trigger a denial-of-service by using specially crafted, long string match patterns on supported commands such as <code> KEYS </code> , <code> SCAN </code> , <code> PSUBSCRIBE </code> , <code> FUNCTION LIST </code> , <code> COMMAND LIST </code> , and ACL definitions. Matching of extremely long patterns may result in unbounded recursion, leading to stack overflow and process crashes. </li> <li> (CVE-2023-41056) In some cases, Redis may incorrectly handle resizing of memory buffers, which can result in incorrect accounting of buffer sizes and lead to heap overflow and potential remote code execution. </li> <li> (CVE-2023-41053) Redis does not correctly identify keys accessed by <code> SORT_RO </code> and, as a result, may grant users executing this command access to keys that are not explicitly authorized by the ACL configuration. (Redis 7.0.13) </li> <li> (CVE-2023-36824) Extracting key names from a command and a list of arguments may, in some cases, trigger a heap overflow and result in reading random heap memory, heap corruption, and potentially remote code execution. Specifically: using <code> COMMAND GETKEYS* </code> and validation of key names in ACL rules. (Redis 7.0.12) </li> <li> (CVE-2023-28856) Authenticated users can use the <code> HINCRBYFLOAT </code> command to create an invalid hash field that will crash Redis on access. (Redis 7.0.11) </li> <li> (CVE-2023-28425) Specially crafted <code> MSETNX </code> commands can lead to assertion and denial-of-service. (Redis 7.0.10) </li> <li> (CVE-2023-25155) Specially crafted <code> SRANDMEMBER </code> , <code> ZRANDMEMBER </code> , and <code> HRANDFIELD </code> commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 7.0.9) </li> <li> (CVE-2023-22458) Integer overflow in the Redis <code> HRANDFIELD </code> and <code> ZRANDMEMBER </code> commands can lead to denial-of-service. (Redis 7.0.8) </li> <li> (CVE-2022-36021) String matching commands (like <code> SCAN </code> or <code> KEYS </code> ) with a specially crafted pattern to trigger a denial-of-service attack on Redis can cause it to hang and consume 100% CPU time. (Redis 7.0.9) </li> <li> (CVE-2022-35977) Integer overflow in the Redis <code> SETRANGE </code> and <code> SORT </code> / <code> SORT_RO </code> commands can drive Redis to OOM panic. (Redis 7.0.8) </li> <li> (CVE-2022-35951) Executing an <code> XAUTOCLAIM </code> command on a stream key in a specific state, with a specially crafted <code> COUNT </code> argument, may cause an integer overflow, a subsequent heap overflow, and potentially lead to remote code execution. The problem affects Redis versions 7.0.0 or newer. (Redis 7.0.5) </li> <li> (CVE-2022-31144) A specially crafted <code> XAUTOCLAIM </code> command on a stream key in a specific state may result in heap overflow and potentially remote code execution. The problem affects Redis versions 7.0.0 or newer. (Redis 7.0.4) </li> <li> (CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 7.0.12) </li> <li> (CVE-2022-24736) An attacker attempting to load a specially crafted Lua script can cause NULL pointer dereference which will result in a crash of the <code> redis-server </code> process. This issue affects all versions of Redis. (Redis 7.0.0) </li> <li> (CVE-2022-24735) By exploiting weaknesses in the Lua script execution environment, an attacker with access to Redis can inject Lua code that will execute with the (potentially higher) privileges of another Redis user. (Redis 7.0.0) </li> </ul> Redis 6.2.x: <ul> <li> (CVE-2024-31449) An authenticated user may use a specially crafted Lua script to trigger a stack buffer overflow in the bit library, which may potentially lead to remote code execution. </li> <li> (CVE-2024-31228) An authenticated user can trigger a denial-of-service by using specially crafted, long string match patterns on supported commands such as <code> KEYS </code> , <code> SCAN </code> , <code> PSUBSCRIBE </code> , <code> FUNCTION LIST </code> , <code> COMMAND LIST </code> , and ACL definitions. Matching of extremely long patterns may result in unbounded recursion, leading to stack overflow and process crashes. </li> <li> (CVE-2023-28856) Authenticated users can use the <code> HINCRBYFLOAT </code> command to create an invalid hash field that will crash Redis on access. (Redis 6.2.12) </li> <li> (CVE-2023-25155) Specially crafted <code> SRANDMEMBER </code> , <code> ZRANDMEMBER </code> , and <code> HRANDFIELD </code> commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 6.2.11) </li> <li> (CVE-2023-22458) Integer overflow in the Redis <code> HRANDFIELD </code> and <code> ZRANDMEMBER </code> commands can lead to denial-of-service. (Redis 6.2.9) </li> <li> (CVE-2022-36021) String matching commands (like <code> SCAN </code> or <code> KEYS </code> ) with a specially crafted pattern to trigger a denial-of-service attack on Redis can cause it to hang and consume 100% CPU time. (Redis 6.2.11) </li> <li> (CVE-2022-35977) Integer overflow in the Redis <code> SETRANGE </code> and <code> SORT </code> / <code> SORT_RO </code> commands can drive Redis to OOM panic. (Redis 6.2.9) </li> <li> (CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 6.2.13) </li> <li> (CVE-2022-24736) An attacker attempting to load a specially crafted Lua script can cause NULL pointer dereference which will result in a crash of the <code> redis-server </code> process. This issue affects all versions of Redis. (Redis 6.2.7) </li> <li> (CVE-2022-24735) By exploiting weaknesses in the Lua script execution environment, an attacker with access to Redis can inject Lua code that will execute with the (potentially higher) privileges of another Redis user. (Redis 6.2.7) </li> <li> (CVE-2021-41099) Integer to heap buffer overflow handling certain string commands and network payloads, when <code> proto-max-bulk-len </code> is manually configured to a non-default, very large value. (Redis 6.2.6) </li> <li> (CVE-2021-32762) Integer to heap buffer overflow issue in <code> redis-cli </code> and <code> redis-sentinel </code> parsing large multi-bulk replies on some older and less common platforms. (Redis 6.2.6) </li> <li> (CVE-2021-32761) An integer overflow bug in Redis version 2.2 or newer can be exploited using the <code> BITFIELD </code> command to corrupt the heap and potentially result with remote code execution. (Redis 6.2.5) </li> <li> (CVE-2021-32687) Integer to heap buffer overflow with intsets, when <code> set-max-intset-entries </code> is manually configured to a non-default, very large value. (Redis 6.2.6) </li> <li> (CVE-2021-32675) Denial Of Service when processing RESP request payloads with a large number of elements on many connections. (Redis 6.2.6) </li> <li> (CVE-2021-32672) Random heap reading issue with Lua Debugger. (Redis 6.2.6) </li> <li> (CVE-2021-32628) Integer to heap buffer overflow handling ziplist-encoded data types, when configuring a large, non-default value for <code> hash-max-ziplist-entries </code> , <code> hash-max-ziplist-value </code> , <code> zset-max-ziplist-entries </code> or <code> zset-max-ziplist-value </code> . (Redis 6.2.6) </li> <li> (CVE-2021-32627) Integer to heap buffer overflow issue with streams, when configuring a non-default, large value for <code> proto-max-bulk-len </code> and <code> client-query-buffer-limit </code> . (Redis 6.2.6) </li> <li> (CVE-2021-32626) Specially crafted Lua scripts may result with Heap buffer overflow. (Redis 6.2.6) </li> <li> (CVE-2021-32625) An integer overflow bug in Redis version 6.0 or newer can be exploited using the STRALGO LCS command to corrupt the heap and potentially result with remote code execution. This is a result of an incomplete fix by CVE-2021-29477. (Redis 6.2.4) </li> <li> (CVE-2021-29478) An integer overflow bug in Redis 6.2 could be exploited to corrupt the heap and potentially result with remote code execution. The vulnerability involves changing the default set-max-intset-entries configuration value, creating a large set key that consists of integer values and using the COPY command to duplicate it. The integer overflow bug exists in all versions of Redis starting with 2.6, where it could result with a corrupted RDB or DUMP payload, but not exploited through COPY (which did not exist before 6.2). (Redis 6.2.3) </li> <li> (CVE-2021-29477) An integer overflow bug in Redis version 6.0 or newer could be exploited using the STRALGO LCS command to corrupt the heap and potentially result in remote code execution. The integer overflow bug exists in all versions of Redis starting with 6.0. (Redis 6.2.3) </li> </ul> Redis 6.0.x: <ul> <li> (CVE-2022-24834) A specially crafted Lua script executing in Redis can trigger a heap overflow in the cjson and cmsgpack libraries, and result in heap corruption and potentially remote code execution. The problem exists in all versions of Redis with Lua scripting support, starting from 2.6, and affects only authenticated and authorized users. (Redis 6.0.20) </li> <li> (CVE-2023-28856) Authenticated users can use the <code> HINCRBYFLOAT </code> command to create an invalid hash field that will crash Redis on access. (Redis 6.0.19) </li> <li> (CVE-2023-25155) Specially crafted <code> SRANDMEMBER </code> , <code> ZRANDMEMBER </code> , and <code> HRANDFIELD </code> commands can trigger an integer overflow, resulting in a runtime assertion and termination of the Redis server process. (Redis 6.0.18) </li> <li> (CVE-2022-36021) String matching commands (like <code> SCAN </code> or <code> KEYS </code> ) with a specially crafted pattern to trigger a denial-of-service attack on Redis can cause it to hang and consume 100% CPU time. (Redis 6.0.18) </li> <li> (CVE-2022-35977) Integer overflow in the Redis <code> SETRANGE </code> and <code> SORT </code> / <code> SORT_RO </code> commands can drive Redis to OOM panic. (Redis 6.0.17) </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/rs-7-4-2-releases/rs-7-4-6-102/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/cli-utilities/rladmin/cluster/reset_password/.html

<section class="prose w-full py-12 max-w-none"> <h1> rladmin cluster reset_password </h1> Changes the password for a given email. Changes the password for the user associated with the specified email address. Enter a new password when prompted. Then enter the same password when prompted a second time to confirm the password change. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin cluster reset_password <user email> </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> user email </td> <td> email address </td> <td> The email address of the user that needs a password reset </td> </tr> </tbody> </table> <h3 id="returns"> Returns </h3> Reports whether the password change succeeded or an error occurred. <h3 id="example"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin cluster reset_password [email protected] New password: New password (again): Password changed. </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/7.4/references/cli-utilities/rladmin/cluster/reset_password/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/bitfield/.html

<section class="prose w-full py-12"> <h1 class="command-name"> BITFIELD </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">BITFIELD key [GET encoding offset | [OVERFLOW <WRAP | SAT | FAIL>] <SET encoding offset value | INCRBY encoding offset increment> [GET encoding offset | [OVERFLOW <WRAP | SAT | FAIL>] <SET encoding offset value | INCRBY encoding offset increment> ...]]</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"> 3.2.0 </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(1) for each subcommand specified </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @write </code> , <code> @bitmap </code> , <code> @slow </code> , </dd> </dl> The command treats a Redis string as an array of bits, and is capable of addressing specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset. In practical terms using this command you can set, for example, a signed 5 bits integer at bit offset 1234 to a specific value, retrieve a 31 bit unsigned integer from offset 4567. Similarly the command handles increments and decrements of the specified integers, providing guaranteed and well specified overflow and underflow behavior that the user can configure. <code> BITFIELD </code> is able to operate with multiple bit fields in the same command call. It takes a list of operations to perform, and returns an array of replies, where each array matches the corresponding operation in the list of arguments. For example the following command increments a 5 bit signed integer at bit offset 100, and gets the value of the 4 bit unsigned integer at bit offset 0: <pre><code>> BITFIELD mykey INCRBY i5 100 1 GET u4 0 1) (integer) 1 2) (integer) 0 </code></pre> Note that: <ol> <li> Addressing with <code> GET </code> bits outside the current string length (including the case the key does not exist at all), results in the operation to be performed like the missing part all consists of bits set to 0. </li> <li> Addressing with <code> SET </code> or <code> INCRBY </code> bits outside the current string length will enlarge the string, zero-padding it, as needed, for the minimal length needed, according to the most far bit touched. </li> </ol> <h2 id="supported-subcommands-and-integer-encoding"> Supported subcommands and integer encoding </h2> The following is the list of supported commands. <ul> <li> GET <code> <encoding> </code> <code> <offset> </code> -- Returns the specified bit field. </li> <li> SET <code> <encoding> </code> <code> <offset> </code> <code> <value> </code> -- Set the specified bit field and returns its old value. </li> <li> INCRBY <code> <encoding> </code> <code> <offset> </code> <code> <increment> </code> -- Increments or decrements (if a negative increment is given) the specified bit field and returns the new value. </li> </ul> There is another subcommand that only changes the behavior of successive <code> INCRBY </code> and <code> SET </code> subcommands calls by setting the overflow behavior: <ul> <li> OVERFLOW <code> [WRAP|SAT|FAIL] </code> </li> </ul> Where an integer encoding is expected, it can be composed by prefixing with <code> i </code> for signed integers and <code> u </code> for unsigned integers with the number of bits of our integer encoding. So for example <code> u8 </code> is an unsigned integer of 8 bits and <code> i16 </code> is a signed integer of 16 bits. The supported encodings are up to 64 bits for signed integers, and up to 63 bits for unsigned integers. This limitation with unsigned integers is due to the fact that currently the Redis protocol is unable to return 64 bit unsigned integers as replies. <h2 id="bits-and-positional-offsets"> Bits and positional offsets </h2> There are two ways in order to specify offsets in the bitfield command. If a number without any prefix is specified, it is used just as a zero based bit offset inside the string. However if the offset is prefixed with a <code> # </code> character, the specified offset is multiplied by the integer encoding's width, so for example: <pre><code>BITFIELD mystring SET i8 #0 100 SET i8 #1 200 </code></pre> Will set the first i8 integer at offset 0 and the second at offset 8. This way you don't have to do the math yourself inside your client if what you want is a plain array of integers of a given size. <h2 id="overflow-control"> Overflow control </h2> Using the <code> OVERFLOW </code> command the user is able to fine-tune the behavior of the increment or decrement overflow (or underflow) by specifying one of the following behaviors: <ul> <li> WRAP : wrap around, both with signed and unsigned integers. In the case of unsigned integers, wrapping is like performing the operation modulo the maximum value the integer can contain (the C standard behavior). With signed integers instead wrapping means that overflows restart towards the most negative value and underflows towards the most positive ones, so for example if an <code> i8 </code> integer is set to the value 127, incrementing it by 1 will yield <code> -128 </code> . </li> <li> SAT : uses saturation arithmetic, that is, on underflows the value is set to the minimum integer value, and on overflows to the maximum integer value. For example incrementing an <code> i8 </code> integer starting from value 120 with an increment of 10, will result into the value 127, and further increments will always keep the value at 127. The same happens on underflows, but towards the value is blocked at the most negative value. </li> <li> FAIL : in this mode no operation is performed on overflows or underflows detected. The corresponding return value is set to NULL to signal the condition to the caller. </li> </ul> Note that each <code> OVERFLOW </code> statement only affects the <code> INCRBY </code> and <code> SET </code> commands that follow it in the list of subcommands, up to the next <code> OVERFLOW </code> statement. By default, WRAP is used if not otherwise specified. <pre><code>> BITFIELD mykey incrby u2 100 1 OVERFLOW SAT incrby u2 102 1 1) (integer) 1 2) (integer) 1 > BITFIELD mykey incrby u2 100 1 OVERFLOW SAT incrby u2 102 1 1) (integer) 2 2) (integer) 2 > BITFIELD mykey incrby u2 100 1 OVERFLOW SAT incrby u2 102 1 1) (integer) 3 2) (integer) 3 > BITFIELD mykey incrby u2 100 1 OVERFLOW SAT incrby u2 102 1 1) (integer) 0 2) (integer) 3 </code></pre> The following is an example of <code> OVERFLOW FAIL </code> returning NULL. <pre><code>> BITFIELD mykey OVERFLOW FAIL incrby u2 102 1 1) (nil) </code></pre> <h2 id="motivations"> Motivations </h2> The motivation for this command is that the ability to store many small integers as a single large bitmap (or segmented over a few keys to avoid having huge keys) is extremely memory efficient, and opens new use cases for Redis to be applied, especially in the field of real time analytics. This use cases are supported by the ability to specify the overflow in a controlled way. Fun fact: Reddit's 2017 April fools' project <a href="https://reddit.com/r/place"> r/place </a> was <a href="https://redditblog.com/2017/04/13/how-we-built-rplace/"> built using the Redis BITFIELD command </a> in order to take an in-memory representation of the collaborative canvas. <h2 id="performance-considerations"> Performance considerations </h2> Usually <code> BITFIELD </code> is a fast command, however note that addressing far bits of currently short strings will trigger an allocation that may be more costly than executing the command on bits already existing. <h2 id="orders-of-bits"> Orders of bits </h2> The representation used by <code> BITFIELD </code> considers the bitmap as having the bit number 0 to be the most significant bit of the first byte, and so forth, so for example setting a 5 bits unsigned integer to value 23 at offset 7 into a bitmap previously set to all zeroes, will produce the following representation: <pre><code>+--------+--------+ |00000001|01110000| +--------+--------+ </code></pre> When offsets and integer sizes are aligned to bytes boundaries, this is the same as big endian, however when such alignment does not exist, its important to also understand how the bits inside a byte are ordered. <h2 id="resp2-reply"> RESP2 Reply </h2> One of the following: <ul> <li> <a href="../../develop/reference/protocol-spec#arrays"> Array reply </a> : each entry being the corresponding result of the sub-command given at the same position. </li> <li> <a href="../../develop/reference/protocol-spec#bulk-strings"> Nil reply </a> : if OVERFLOW FAIL was given and overflows or underflows are detected. </li> </ul> <h2 id="resp3-reply"> RESP3 Reply </h2> One of the following: <ul> <li> <a href="../../develop/reference/protocol-spec#arrays"> Array reply </a> : each entry being the corresponding result of the sub-command given at the same position. </li> <li> <a href="../../develop/reference/protocol-spec#nulls"> Null reply </a> : if OVERFLOW FAIL was given and overflows or underflows are detected. </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/commands/bitfield/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/databases/create-database/create-essentials-database/.html

<section class="prose w-full py-12 max-w-none"> <h1> Create an Essentials database </h1> Shows how to create an Essentials database. Before creating a Redis Cloud database, you need to <a href="/docs/latest/operate/rc/rc-quickstart/"> create an account </a> . To create a database in your Redis Cloud account: <ol> <li> Sign in to the <a href="https://cloud.redis.io"> Redis Cloud console </a> . </li> <li> Select the New database button. <a href="/docs/latest/images/rc/button-database-new.png" sdata-lightbox="/images/rc/button-database-new.png"> <img alt="The New Database button creates a new database." src="/docs/latest/images/rc/button-database-new.png" width="120px"/> </a> This displays the Create database screen. </li> <li> Select your Redis use case. There are four pre-defined use cases: <a href="/docs/latest/images/rc/create-database-redis-use-cases.png" sdata-lightbox="/images/rc/create-database-redis-use-cases.png"> <img alt="The Redis Use case panel" src="/docs/latest/images/rc/create-database-redis-use-cases.png"/> </a> <ul> <li> Cache : Stores short-term or volatile data. Can be used for session management, semantic cache, session store, and other uses where data is short-lived. </li> <li> Database : Stores durable and consistent data. Can be used for document databases, feature storage, gaming leaderboards, durable caches, and other uses where your data needs to be highly available and persistent. </li> <li> Vector search : Manages and manipulates vector data. Can be used for Generative AI, recommendation systems, visual search, and other uses where you can search and query your data. </li> <li> Custom : If your Redis use case doesn't match any of the other use cases, you can choose this option to customize all of your settings. </li> </ul> Select the use case that best matches your Redis use case. You can always change the settings later. </li> </ol> <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> See <a href="#use-case-settings"> Use case settings </a> to view the default settings for each use case. </div> </div> <ol start="4"> <li> Select the type of <a href="/docs/latest/operate/rc/subscriptions/"> subscription </a> you need. For this guide, select Essentials . <a href="/docs/latest/images/rc/create-database-subscription-essentials.png" sdata-lightbox="/images/rc/create-database-subscription-essentials.png"> <img alt="The Subscription selection panel with Essentials selected." src="/docs/latest/images/rc/create-database-subscription-essentials.png"/> </a> <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> This guide shows how to create an Essentials database. <ul> <li> If you'd rather create a Pro database, see <a href="/docs/latest/operate/rc/databases/create-database/create-pro-database-new/"> Create a Pro database with a new subscription </a> . </li> <li> If you already have a Pro subscription and want to add a database to it, see <a href="/docs/latest/operate/rc/databases/create-database/create-pro-database-existing/"> Create a Pro database in an existing subscription </a> . </li> </ul> </div> </div> After you select Essentials , the rest of the database details will appear. <a href="/docs/latest/images/rc/create-database-essentials-cloud-vendor.png" sdata-lightbox="/images/rc/create-database-essentials-cloud-vendor.png"> <img alt="The database name, cloud vendor, region, and type settings." src="/docs/latest/images/rc/create-database-essentials-cloud-vendor.png"/> </a> </li> <li> Redis will generate a database name for you. If you want to change it, you can do so in the Database name field. </li> <li> Choose a Cloud Provider and a Region . A preview of Redis 7.4 is available for databases in selected regions. Select the Redis 7.4 preview toggle to view the regions where you can try Redis 7.4. <a href="/docs/latest/images/rc/essentials-74-preview.png" sdata-lightbox="/images/rc/essentials-74-preview.png"> <img alt="Turn on the Redis 7.4 preview toggle." src="/docs/latest/images/rc/essentials-74-preview.png"/> </a> Redis 7.4 offers hash field expiration and other feature set improvements. For more information on the changes in Redis 7.4, see the <a href="https://redis.io/blog/announcing-redis-community-edition-and-redis-stack-74"> Redis 7.4 release notes </a> . </li> <li> The Type of database controls the protocol and advanced capabilities. Leave this as Redis Stack unless you have a legacy application that uses Memcached . A Redis Stack database gives access to a set of advanced capabilities. For more information, see <a href="/docs/latest/operate/rc/databases/configuration/advanced-capabilities/#essentials"> Advanced capabilities </a> . </li> <li> In the Durability settings panel, choose your High availability settings and Data persistence settings from the list. <a href="/docs/latest/images/rc/create-database-essentials-durability.png" sdata-lightbox="/images/rc/create-database-essentials-durability.png"> <img alt="The durability settings allow you to choose High availability and Data persistence." src="/docs/latest/images/rc/create-database-essentials-durability.png"/> </a> Redis Cloud supports the following high availability settings: <ul> <li> None : You will have a single copy of your database without replication. </li> <li> Single-Zone : Your database will have a primary and a replica located in the same cloud zone. If anything happens to the primary, the replica takes over and becomes the new primary. </li> <li> Multi-Zone : The primary and its replicas are stored in different zones. This means that your database can remain online even if an entire zone becomes unavailable. </li> </ul> See <a href="/docs/latest/operate/rc/databases/configuration/high-availability/"> High availability </a> for more information about these settings. Redis Cloud supports the following Data persistence options: <ul> <li> An Append-Only File maintains a record (sometimes called a redo log or journal ) of write operations. This allows the data to be restored by using the record to reconstruct the database up to the point of failure. For Essentials databases, Redis updates the Append-Only file every second. </li> <li> A Snapshot is a copy of the in-memory database, taken at periodic intervals (one, six, or twelve hours). You can restore data to the snapshot's point in time. </li> </ul> See <a href="/docs/latest/operate/rc/databases/configuration/data-persistence/"> Data persistence </a> for more information about these settings. These settings may already be set based on the use case you selected. You can change them now if you like. </li> <li> Select the desired memory limit. To create a free database, select the 30 MB memory limit. You can only have one free database at a time. <a href="/docs/latest/images/rc/subscription-new-fixed-tiers.png" sdata-lightbox="/images/rc/subscription-new-fixed-tiers.png"> <img alt="Available Essentials plans." src="/docs/latest/images/rc/subscription-new-fixed-tiers.png"/> </a> For a comparison of available plans, see <a href="/docs/latest/operate/rc/subscriptions/view-essentials-subscription/essentials-plan-details/"> Redis Cloud Essentials plans </a> . </li> <li> Enter your payment details if you chose a paid plan. If you chose a paid plan and haven't previously entered a payment method, use the Add Credit Card button to add one. <a href="/docs/latest/images/rc/icon-add-credit-card.png" sdata-lightbox="/images/rc/icon-add-credit-card.png"> <img alt="The Add credit card icon." src="/docs/latest/images/rc/icon-add-credit-card.png"/> </a> </li> <li> Select Create database or Confirm & pay to create your database. </li> </ol> <a href="/docs/latest/images/rc/button-create-db-confirm-pay.png" sdata-lightbox="/images/rc/button-create-db-confirm-pay.png"> <img alt="Select Confirm & Pay to create your new database." src="/docs/latest/images/rc/button-create-db-confirm-pay.png" width="140px"/> </a> When you create your database, there's a brief pause while your request is processed and then the Database details page appears. <h2 id="use-case-settings"> Use case settings </h2> The following table shows the default use case settings for an Essentials database. <table> <thead> <tr> <th> Type </th> <th> High Availability </th> <th> Data Persistence </th> <th> Size </th> <th> Eviction Policy </th> </tr> </thead> <tbody> <tr> <td> Cache </td> <td> None </td> <td> None </td> <td> 30 MB - 12 GB </td> <td> <code> volatile-lru </code> </td> </tr> <tr> <td> Database </td> <td> Multi-zone </td> <td> Append-only file every 1 sec </td> <td> 250 MB - 12 GB </td> <td> None </td> </tr> <tr> <td> Vector Search </td> <td> Multi-zone </td> <td> Append-only file every 1 sec </td> <td> 250 MB - 12 GB </td> <td> None </td> </tr> <tr> <td> Custom </td> <td> Single-zone </td> <td> Append-only file every 1 sec </td> <td> 250 MB - 12 GB </td> <td> None </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/rc/databases/create-database/create-essentials-database/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/kubernetes/release-notes/7-4-6-releases/.html

<section class="prose w-full py-12 max-w-none"> <h1> Redis Enterprise for Kubernetes 7.4.6-2 release notes </h1> Releases with support for Redis Enterprise Software 7.4.6. <h2 id="detailed-release-notes"> Detailed release notes </h2> <table> <thead> <tr> <th style="text-align:left"> Version (Release date) </th> <th style="text-align:left"> Major changes </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/kubernetes/release-notes/7-4-6-releases/7-4-6-2-october24/"> 7.4.6-2 (October 2024) </a> </td> <td style="text-align:left"> This is a maintenance release with a new version of Redis Enterprise Software 7.4.6. </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/kubernetes/release-notes/7-4-6-releases/7-4-6-2-oct24/"> 7.4.6-2 (October 2024) </a> </td> <td style="text-align:left"> This is a maintenance release with a new version of Redis Enterprise Software 7.4.6. </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/kubernetes/release-notes/7-4-6-releases/7-4-6-2/"> 7.4.6-2 (July 2024) </a> </td> <td style="text-align:left"> This is a feature release with a new version of Redis Enterprise Software 7.4.6. </td> </tr> </tbody> </table> <h2 id="breaking-changes"> Breaking changes </h2> The following changes included in this release affect the upgrade process. Please read carefully before upgrading. <h3 id="validatingwebhookconfiguration"> ValidatingWebhookConfiguration </h3> Versions 6.4.2-4 and later include a new <code> ValidatingWebhookConfiguration </code> resource to replace the <code> redb-admission </code> webhook resource. To use releases 6.4.2-4 or later, delete the old webhook resource and apply the new file. See <a href="/docs/latest/operate/kubernetes/upgrade/upgrade-redis-cluster/#reapply-webhook"> upgrade Redis cluster </a> for instructions. <h3 id="openshift-scc"> OpenShift SCC </h3> Versions 6.4.2-6 and later include a new SCC ( <code> redis-enterprise-scc-v2 </code> ) that you need to bind to your service account before upgrading. If you skip this step, OpenShift clusters running version 6.2.12 or earlier might get stuck when upgrading to version 6.2.18 or later. See <a href="/docs/latest/operate/kubernetes/upgrade/upgrade-redis-cluster/#before-upgrading"> upgrade a Redis Enterprise cluster (REC) </a> for instructions. <h3 id="upcoming-changes"> Upcoming Changes </h3> <ul> <li> Future Redis Enterprise images will be UBI9-based only, without support for Ubuntu-based images. </li> </ul> <h2 id="security"> Security </h2> For a list of fixes related to CVEs, see the <a href="/docs/latest/operate/rs/release-notes/rs-7-4-2-releases/"> Redis Enterprise 7.2.4-109 release notes </a> . <h2 id="supported-distributions"> Supported distributions </h2> The following table shows supported distributions at the time of this release. You can also find this list in <a href="/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/"> Supported Kubernetes distributions </a> . ✅ Supported – This distribution is supported for this version of Redis Enterprise Software for Kubernetes. ⚠️ Deprecated – This distribution is still supported for this version of Redis Enterprise Software for Kubernetes, but support will be removed in a future release. ❌ End of life – Support for this distribution ended. Any distribution not listed below is not supported for production workloads. <table> <thead> <tr> <th> Kubernetes version </th> <th> 1.25 </th> <th> 1.26 </th> <th> 1.27 </th> <th> 1.28 </th> <th> 1.29 </th> <th> 1.30 </th> </tr> </thead> <tbody> <tr> <td> Community Kubernetes </td> <td> </td> <td> ⚠️ </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> </tr> <tr> <td> Amazon EKS </td> <td> ❌ </td> <td> ⚠️ </td> <td> ⚠️ </td> <td> ✅ </td> <td> ✅ </td> <td> </td> </tr> <tr> <td> Azure AKS </td> <td> </td> <td> ❌ </td> <td> ⚠️ </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> </tr> <tr> <td> Google GKE </td> <td> ❌ </td> <td> ⚠️ </td> <td> ⚠️ </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> </tr> <tr> <td> Rancher RKE2 </td> <td> ⚠️ </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> <td> </td> <td> </td> </tr> <tr> <td> VMware TKG 2.2 </td> <td> ❌ </td> <td> </td> <td> </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> VMware TKG 2.3 </td> <td> ❌ </td> <td> ✅ </td> <td> </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> VMware TKG 2.4 </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> OpenShift version </td> <td> 4.12 </td> <td> 4.13 </td> <td> 4.14 </td> <td> 4.15 </td> <td> 4.16 </td> <td> </td> </tr> <tr> <td> </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> <td> </td> </tr> <tr> <td> VMware TKGI version </td> <td> 1.16 </td> <td> 1.17 </td> <td> 1.18 </td> <td> 1.19 </td> <td> </td> <td> </td> </tr> <tr> <td> </td> <td> ⚠️ </td> <td> ✅ </td> <td> ✅ </td> <td> ✅ </td> <td> </td> <td> </td> </tr> </tbody> </table> <h2 id="known-limitations"> Known limitations </h2> <ul> <li> Missing endpoint for admission endpoint (rare) (RED-119469) Restart the operator pod. </li> <li> The REDB “redisVersion” field can’t be used for memcached databases(RED-119152) </li> <li> When modifying the database suffix for an Active-Active database, while the service-rigger is in a terminating state, the services-rigger will delete and create the ingress or route resources in a loop (RED-107687) Wait until the services rigger pod has finished to terminate it. </li> <li> REAADB changes might fail with "gateway timeout" errors, mostly on OpenShift (RED-103048) Retry the operation. </li> <li> Creating two databases with the same name directly on Redis Enterprise software will cause the service to be deleted and the database will not be available (RED-99997) Avoid duplicating database names. Database creation via K8s has validation in place to prevent this. </li> <li> Installing the operator bundle produces warning: <code> Warning: would violate PodSecurity "restricted: v1.24" </code> (RED-97381) Ignore the warning. This issue is documented as benign on official Red Hat documentation. </li> <li> RERC resources must have a unique name (RED-96302) The string "rec-name"/"rec-namespace" must be different from all other participating clusters in the Active-Active database. </li> <li> Admission is not blocking REAADB with <code> shardCount </code> which exceeds license quota (RED-96301) Fix the problems with the REAADB and reapply. </li> <li> Active-Active controller only supports global database options. Configuration specific to location is not supported (RED-86490) </li> <li> Active-Active setup removal might keep services or routes undeleted (RED-77752) Delete services or routes manually if you encounter this problem. </li> <li> <code> autoUpgrade </code> set to <code> true </code> can cause unexpected bdb upgrades when <code> redisUpgradePolicy </code> is set to <code> true </code> (RED-72351) Contact support if your deployment is impacted. </li> <li> Following the previous quick start guide version causes issues with creating an REDB due to unrecognized memory field name (RED-69515) The workaround is to use the newer (current) revision of Deploy Redis Enterprise Software for Kubernetes. </li> <li> PVC size issues when using decimal value in spec (RED-62132) Make sure you use integer values for the PVC size. </li> <li> REC might report error states on initial startup (RED-61707) There is no workaround at this time except to ignore the errors. </li> <li> Hashicorp Vault integration - no support for Gesher (RED-55080) There is no workaround for this issue. Gesher support has been deprecated. </li> <li> REC clusters fail to start on Kubernetes clusters with unsynchronized clocks (RED-47254) When REC clusters are deployed on Kubernetes clusters without synchronized clocks, the REC cluster does not start correctly. The fix is to use NTP to synchronize the underlying K8s nodes. </li> <li> Deleting an OpenShift project with an REC deployed may hang (RED-47192) When an REC cluster is deployed in a project (namespace) and has REDB resources, the REDB resources must be deleted first before the REC can be deleted. Therefore, until the REDB resources are deleted, the project deletion will hang. The fix is to delete the REDB resources first and the REC second. Then, you can delete the project. </li> <li> Clusters must be named 'rec' in OLM-based deployments (RED-39825) In OLM-deployed operators, the deployment of the cluster will fail if the name is not "rec". When the operator is deployed via the OLM, the security context constraints (scc) are bound to a specific service account name (namely, "rec"). The workaround is to name the cluster "rec". </li> <li> Readiness probe incorrect on failures (RED-39300) STS Readiness probe does not mark a node as "not ready" when running <code> rladmin status </code> on node failure. </li> <li> Internal DNS and Kubernetes DNS may have conflicts (RED-37462) DNS conflicts are possible between the cluster <code> mdns_server </code> and the K8s DNS. This only impacts DNS resolution from within cluster nodes for Kubernetes DNS names. </li> <li> K8s-based 5.4.10 clusters seem to negatively affect existing 5.4.6 clusters (RED-37233) Upgrade clusters to latest version. </li> <li> Node CPU usage is reported instead of pod CPU usage (RED-36884) In Kubernetes, the reported node CPU usage is the usage of the Kubernetes worker node hosting the REC pod. </li> <li> An unreachable cluster has status running (RED-32805) When a cluster is in an unreachable state, the state remains <code> running </code> instead of triggering an error. </li> <li> Long cluster names cause routes to be rejected (RED-25871) A cluster name longer than 20 characters will result in a rejected route configuration because the host part of the domain name exceeds 63 characters. The workaround is to limit the cluster name to 20 characters or fewer. </li> <li> Cluster CR (REC) errors are not reported after invalid updates (RED-25542) A cluster CR specification error is not reported if two or more invalid CR resources are updated in sequence. </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/kubernetes/release-notes/7-4-6-releases/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/kubernetes/reference/redis_enterprise_active_active_database_api/.html

<section class="prose w-full py-12 max-w-none"> <h1> RedisEnterpriseActiveActiveDatabase API Reference </h1> apiVersion: <ul> <li> <a href="#appredislabscomv1alpha1"> app.redislabs.com/v1alpha1 </a> </li> </ul> <h1 id="appredislabscomv1alpha1"> app.redislabs.com/v1alpha1 </h1> RedisEnterpriseActiveActiveDatabase is the Schema for the redisenterpriseactiveactivedatabase API <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> apiVersion </td> <td> string </td> <td> app.redislabs.com/v1alpha1 </td> <td> true </td> </tr> <tr> <td> kind </td> <td> string </td> <td> RedisEnterpriseActiveActiveDatabase </td> <td> true </td> </tr> <tr> <td> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta"> metadata </a> </td> <td> object </td> <td> Refer to the Kubernetes API documentation for the fields of the `metadata` field. </td> <td> true </td> </tr> <tr> <td> <a href="#spec"> spec </a> </td> <td> object </td> <td> RedisEnterpriseActiveActiveDatabaseSpec defines the desired state of RedisEnterpriseActiveActiveDatabase </td> <td> false </td> </tr> <tr> <td> <a href="#status"> status </a> </td> <td> object </td> <td> RedisEnterpriseActiveActiveDatabaseStatus defines the observed state of RedisEnterpriseActiveActiveDatabase </td> <td> false </td> </tr> </tbody> </table> <h3 id="spec"> spec </h3> <a href="#"> ↩ Parent </a> RedisEnterpriseActiveActiveDatabaseSpec defines the desired state of RedisEnterpriseActiveActiveDatabase <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specparticipatingclusters"> participatingClusters </a> </td> <td> []object </td> <td> The list of instances/ clusters specifications and configurations. </td> <td> true </td> </tr> <tr> <td> <a href="#specglobalconfigurations"> globalConfigurations </a> </td> <td> object </td> <td> The Active-Active database global configurations, contains the global properties for each of the participating clusters/ instances databases within the Active-Active database. </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterprisecluster"> redisEnterpriseCluster </a> </td> <td> object </td> <td> Connection to Redis Enterprise Cluster </td> <td> false </td> </tr> </tbody> </table> <h3 id="specparticipatingclusters"> spec.participatingClusters[] </h3> <a href="#spec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> The name of the remote cluster CR to link. </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurations"> spec.globalConfigurations </h3> <a href="#spec"> ↩ Parent </a> The Active-Active database global configurations, contains the global properties for each of the participating clusters/ instances databases within the Active-Active database. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specglobalconfigurationsactiveactive"> activeActive </a> </td> <td> object </td> <td> Connection/ association to the Active-Active database. </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettings"> alertSettings </a> </td> <td> object </td> <td> Settings for database alerts </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsbackup"> backup </a> </td> <td> object </td> <td> Target for automatic database backups. </td> <td> false </td> </tr> <tr> <td> clientAuthenticationCertificates </td> <td> []string </td> <td> The Secrets containing TLS Client Certificate to use for Authentication </td> <td> false </td> </tr> <tr> <td> dataInternodeEncryption </td> <td> boolean </td> <td> Internode encryption (INE) setting. An optional boolean setting, overriding a similar cluster-wide policy. If set to False, INE is guaranteed to be turned off for this DB (regardless of cluster-wide policy). If set to True, INE will be turned on, unless the capability is not supported by the DB ( in such a case we will get an error and database creation will fail). If left unspecified, will be disabled if internode encryption is not supported by the DB (regardless of cluster default). Deleting this property after explicitly setting its value shall have no effect. </td> <td> false </td> </tr> <tr> <td> databasePort </td> <td> integer </td> <td> Database port number. TCP port on which the database is available. Will be generated automatically if omitted. can not be changed after creation </td> <td> false </td> </tr> <tr> <td> databaseSecretName </td> <td> string </td> <td> The name of the secret that holds the password to the database (redis databases only). If secret does not exist, it will be created. To define the password, create an opaque secret and set the name in the spec. The password will be taken from the value of the 'password' key. Use an empty string as value within the secret to disable authentication for the database. Notes - For Active-Active databases this secret will not be automatically created, and also, memcached databases must not be set with a value, and a secret/password will not be automatically created for them. Use the memcachedSaslSecretName field to set authentication parameters for memcached databases. </td> <td> false </td> </tr> <tr> <td> defaultUser </td> <td> boolean </td> <td> Is connecting with a default user allowed? If disabled, the DatabaseSecret will not be created or updated </td> <td> false </td> </tr> <tr> <td> evictionPolicy </td> <td> string </td> <td> Database eviction policy. see more https://docs.redislabs.com/latest/rs/administering/database-operations/eviction-policy/ </td> <td> false </td> </tr> <tr> <td> isRof </td> <td> boolean </td> <td> Whether it is an RoF database or not. Applicable only for databases of type "REDIS". Assumed to be false if left blank. </td> <td> false </td> </tr> <tr> <td> memcachedSaslSecretName </td> <td> string </td> <td> Credentials used for binary authentication in memcached databases. The credentials should be saved as an opaque secret and the name of that secret should be configured using this field. For username, use 'username' as the key and the actual username as the value. For password, use 'password' as the key and the actual password as the value. Note that connections are not encrypted. </td> <td> false </td> </tr> <tr> <td> memorySize </td> <td> string </td> <td> memory size of database. use formats like 100MB, 0.1GB. minimum value in 100MB. When redis on flash (RoF) is enabled, this value refers to RAM+Flash memory, and it must not be below 1GB. </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsmoduleslist"> modulesList </a> </td> <td> []object </td> <td> List of modules associated with database. Note - For Active-Active databases this feature is currently in preview. For this feature to take effect for Active-Active databases, set a boolean environment variable with the name "ENABLE_ALPHA_FEATURES" to True. This variable can be set via the redis-enterprise-operator pod spec, or through the operator-environment-config Config Map. </td> <td> false </td> </tr> <tr> <td> ossCluster </td> <td> boolean </td> <td> OSS Cluster mode option. Note that not all client libraries support OSS cluster mode. </td> <td> false </td> </tr> <tr> <td> persistence </td> <td> enum </td> <td> Database on-disk persistence policy Enum : disabled, aofEverySecond, aofAlways, snapshotEvery1Hour, snapshotEvery6Hour, snapshotEvery12Hour </td> <td> false </td> </tr> <tr> <td> proxyPolicy </td> <td> string </td> <td> The policy used for proxy binding to the endpoint. Supported proxy policies are: single/all-master-shards/all-nodes When left blank, the default value will be chosen according to the value of ossCluster - single if disabled, all-master-shards when enabled </td> <td> false </td> </tr> <tr> <td> rackAware </td> <td> boolean </td> <td> Whether database should be rack aware. This improves availability - more information: https://docs.redislabs.com/latest/rs/concepts/high-availability/rack-zone-awareness/ </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsredisenterprisecluster"> redisEnterpriseCluster </a> </td> <td> object </td> <td> Connection to Redis Enterprise Cluster </td> <td> false </td> </tr> <tr> <td> redisVersion </td> <td> string </td> <td> Redis OSS version. Version can be specified via <major.minor> prefix, or via channels - for existing databases - Upgrade Redis OSS version. For new databases - the version which the database will be created with. If set to 'major' - will always upgrade to the most recent major Redis version. If set to 'latest' - will always upgrade to the most recent Redis version. Depends on 'redisUpgradePolicy' - if you want to set the value to 'latest' for some databases, you must set redisUpgradePolicy on the cluster before. Possible values are 'major' or 'latest' When using upgrade - make sure to backup the database before. This value is used only for database type 'redis' </major.minor> </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsreplicasources"> replicaSources </a> </td> <td> []object </td> <td> What databases to replicate from </td> <td> false </td> </tr> <tr> <td> replication </td> <td> boolean </td> <td> In-memory database replication. When enabled, database will have replica shard for every master - leading to higher availability. Defaults to false. </td> <td> false </td> </tr> <tr> <td> resp3 </td> <td> boolean </td> <td> Whether this database supports RESP3 protocol. Note - Deleting this property after explicitly setting its value shall have no effect. Please view the corresponding field in RS doc for more info. </td> <td> false </td> </tr> <tr> <td> rofRamSize </td> <td> string </td> <td> The size of the RAM portion of an RoF database. Similarly to "memorySize" use formats like 100MB, 0.1GB It must be at least 10% of combined memory size (RAM+Flash), as specified by "memorySize". </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsrolespermissions"> rolesPermissions </a> </td> <td> []object </td> <td> List of Redis Enteprise ACL and Role bindings to apply </td> <td> false </td> </tr> <tr> <td> shardCount </td> <td> integer </td> <td> Number of database server-side shards </td> <td> false </td> </tr> <tr> <td> shardingEnabled </td> <td> boolean </td> <td> Toggles database sharding for REAADBs (Active Active databases) and enabled by default. This field is blocked for REDB (non-Active Active databases) and sharding is toggled via the shardCount field - when shardCount is 1 this is disabled otherwise enabled. </td> <td> false </td> </tr> <tr> <td> shardsPlacement </td> <td> string </td> <td> Control the density of shards - should they reside on as few or as many nodes as possible. Available options are "dense" or "sparse". If left unset, defaults to "dense". </td> <td> false </td> </tr> <tr> <td> tlsMode </td> <td> enum </td> <td> Require SSL authenticated and encrypted connections to the database. enabled - all incoming connections to the Database must use SSL. disabled - no incoming connection to the Database should use SSL. replica_ssl - databases that replicate from this one need to use SSL. Enum : disabled, enabled, replica_ssl </td> <td> false </td> </tr> <tr> <td> type </td> <td> enum </td> <td> The type of the database. Enum : redis, memcached </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsupgradespec"> upgradeSpec </a> </td> <td> object </td> <td> Specifications for DB upgrade. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsactiveactive"> spec.globalConfigurations.activeActive </h3> <a href="#specglobalconfigurations"> ↩ Parent </a> Connection/ association to the Active-Active database. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> The the corresponding Active-Active database name, Redis Enterprise Active Active Database custom resource name, this Resource is associated with. In case this resource is created manually at the active active database creation this field must be filled via the user, otherwise, the operator will assign this field automatically. Note: this feature is currently unsupported. </td> <td> true </td> </tr> <tr> <td> participatingClusterName </td> <td> string </td> <td> The corresponding participating cluster name, Redis Enterprise Remote Cluster custom resource name, in the Active-Active database, In case this resource is created manually at the active active database creation this field must be filled via the user, otherwise, the operator will assign this field automatically. Note: this feature is currently unsupported. </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettings"> spec.globalConfigurations.alertSettings </h3> <a href="#specglobalconfigurations"> ↩ Parent </a> Settings for database alerts <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_backup_delayed"> bdb_backup_delayed </a> </td> <td> object </td> <td> Periodic backup has been delayed for longer than specified threshold value [minutes] </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_crdt_src_high_syncer_lag"> bdb_crdt_src_high_syncer_lag </a> </td> <td> object </td> <td> Active-active source - sync lag is higher than specified threshold value [seconds] </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_crdt_src_syncer_connection_error"> bdb_crdt_src_syncer_connection_error </a> </td> <td> object </td> <td> Active-active source - sync has connection error while trying to connect replica source </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_crdt_src_syncer_general_error"> bdb_crdt_src_syncer_general_error </a> </td> <td> object </td> <td> Active-active source - sync encountered in general error </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_high_latency"> bdb_high_latency </a> </td> <td> object </td> <td> Latency is higher than specified threshold value [micro-sec] </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_high_throughput"> bdb_high_throughput </a> </td> <td> object </td> <td> Throughput is higher than specified threshold value [requests / sec.] </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_long_running_action"> bdb_long_running_action </a> </td> <td> object </td> <td> An alert for state-machines that are running for too long </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_low_throughput"> bdb_low_throughput </a> </td> <td> object </td> <td> Throughput is lower than specified threshold value [requests / sec.] </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_ram_dataset_overhead"> bdb_ram_dataset_overhead </a> </td> <td> object </td> <td> Dataset RAM overhead of a shard has reached the threshold value [% of its RAM limit] </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_ram_values"> bdb_ram_values </a> </td> <td> object </td> <td> Percent of values kept in a shard's RAM is lower than [% of its key count] </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_replica_src_high_syncer_lag"> bdb_replica_src_high_syncer_lag </a> </td> <td> object </td> <td> Replica-of source - sync lag is higher than specified threshold value [seconds] </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_replica_src_syncer_connection_error"> bdb_replica_src_syncer_connection_error </a> </td> <td> object </td> <td> Replica-of source - sync has connection error while trying to connect replica source </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_shard_num_ram_values"> bdb_shard_num_ram_values </a> </td> <td> object </td> <td> Number of values kept in a shard's RAM is lower than [values] </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsalertsettingsbdb_size"> bdb_size </a> </td> <td> object </td> <td> Dataset size has reached the threshold value [% of the memory limit] </td> <td> false </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_backup_delayed"> spec.globalConfigurations.alertSettings.bdb_backup_delayed </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Periodic backup has been delayed for longer than specified threshold value [minutes] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_crdt_src_high_syncer_lag"> spec.globalConfigurations.alertSettings.bdb_crdt_src_high_syncer_lag </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Active-active source - sync lag is higher than specified threshold value [seconds] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_crdt_src_syncer_connection_error"> spec.globalConfigurations.alertSettings.bdb_crdt_src_syncer_connection_error </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Active-active source - sync has connection error while trying to connect replica source <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_crdt_src_syncer_general_error"> spec.globalConfigurations.alertSettings.bdb_crdt_src_syncer_general_error </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Active-active source - sync encountered in general error <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_high_latency"> spec.globalConfigurations.alertSettings.bdb_high_latency </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Latency is higher than specified threshold value [micro-sec] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_high_throughput"> spec.globalConfigurations.alertSettings.bdb_high_throughput </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Throughput is higher than specified threshold value [requests / sec.] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_long_running_action"> spec.globalConfigurations.alertSettings.bdb_long_running_action </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> An alert for state-machines that are running for too long <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_low_throughput"> spec.globalConfigurations.alertSettings.bdb_low_throughput </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Throughput is lower than specified threshold value [requests / sec.] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_ram_dataset_overhead"> spec.globalConfigurations.alertSettings.bdb_ram_dataset_overhead </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Dataset RAM overhead of a shard has reached the threshold value [% of its RAM limit] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_ram_values"> spec.globalConfigurations.alertSettings.bdb_ram_values </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Percent of values kept in a shard's RAM is lower than [% of its key count] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_replica_src_high_syncer_lag"> spec.globalConfigurations.alertSettings.bdb_replica_src_high_syncer_lag </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Replica-of source - sync lag is higher than specified threshold value [seconds] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_replica_src_syncer_connection_error"> spec.globalConfigurations.alertSettings.bdb_replica_src_syncer_connection_error </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Replica-of source - sync has connection error while trying to connect replica source <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_shard_num_ram_values"> spec.globalConfigurations.alertSettings.bdb_shard_num_ram_values </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Number of values kept in a shard's RAM is lower than [values] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsalertsettingsbdb_size"> spec.globalConfigurations.alertSettings.bdb_size </h3> <a href="#specglobalconfigurationsalertsettings"> ↩ Parent </a> Dataset size has reached the threshold value [% of the memory limit] <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Alert enabled or disabled </td> <td> true </td> </tr> <tr> <td> threshold </td> <td> string </td> <td> Threshold for alert going on/off </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsbackup"> spec.globalConfigurations.backup </h3> <a href="#specglobalconfigurations"> ↩ Parent </a> Target for automatic database backups. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specglobalconfigurationsbackupabs"> abs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsbackupftp"> ftp </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsbackupgcs"> gcs </a> </td> <td> object </td> <td> GoogleStorage </td> <td> false </td> </tr> <tr> <td> interval </td> <td> integer </td> <td> Backup Interval in seconds </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsbackupmount"> mount </a> </td> <td> object </td> <td> MountPointStorage </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsbackups3"> s3 </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsbackupsftp"> sftp </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specglobalconfigurationsbackupswift"> swift </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsbackupabs"> spec.globalConfigurations.backup.abs </h3> <a href="#specglobalconfigurationsbackup"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> absSecretName </td> <td> string </td> <td> The name of the secret that holds ABS credentials. The secret must contain the keys "AccountName" and "AccountKey", and these must hold the corresponding credentials </td> <td> true </td> </tr> <tr> <td> container </td> <td> string </td> <td> Azure Blob Storage container name. </td> <td> true </td> </tr> <tr> <td> subdir </td> <td> string </td> <td> Optional. Azure Blob Storage subdir under container. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsbackupftp"> spec.globalConfigurations.backup.ftp </h3> <a href="#specglobalconfigurationsbackup"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> url </td> <td> string </td> <td> a URI of the "ftps://[USER[:PASSWORD]@]HOST[:PORT]/PATH[/]" format </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsbackupgcs"> spec.globalConfigurations.backup.gcs </h3> <a href="#specglobalconfigurationsbackup"> ↩ Parent </a> GoogleStorage <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> bucketName </td> <td> string </td> <td> Google Storage bucket name. </td> <td> true </td> </tr> <tr> <td> gcsSecretName </td> <td> string </td> <td> The name of the secret that holds the Google Cloud Storage credentials. The secret must contain the keys "CLIENT_ID", "PRIVATE_KEY", "PRIVATE_KEY_ID", "CLIENT_EMAIL" and these must hold the corresponding credentials. The keys should correspond to the values in the key JSON. </td> <td> true </td> </tr> <tr> <td> subdir </td> <td> string </td> <td> Optional. Google Storage subdir under bucket. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsbackupmount"> spec.globalConfigurations.backup.mount </h3> <a href="#specglobalconfigurationsbackup"> ↩ Parent </a> MountPointStorage <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> Path to the local mount point. You must create the mount point on all nodes, and the redislabs:redislabs user must have read and write permissions on the local mount point. </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsbackups3"> spec.globalConfigurations.backup.s3 </h3> <a href="#specglobalconfigurationsbackup"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> awsSecretName </td> <td> string </td> <td> The name of the secret that holds the AWS credentials. The secret must contain the keys "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY", and these must hold the corresponding credentials. </td> <td> true </td> </tr> <tr> <td> bucketName </td> <td> string </td> <td> Amazon S3 bucket name. </td> <td> true </td> </tr> <tr> <td> subdir </td> <td> string </td> <td> Optional. Amazon S3 subdir under bucket. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsbackupsftp"> spec.globalConfigurations.backup.sftp </h3> <a href="#specglobalconfigurationsbackup"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> sftpSecretName </td> <td> string </td> <td> The name of the secret that holds SFTP credentials. The secret must contain the "Key" key, which is the SSH private key for connecting to the sftp server. </td> <td> true </td> </tr> <tr> <td> sftp_url </td> <td> string </td> <td> SFTP url </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsbackupswift"> spec.globalConfigurations.backup.swift </h3> <a href="#specglobalconfigurationsbackup"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> auth_url </td> <td> string </td> <td> Swift service authentication URL. </td> <td> true </td> </tr> <tr> <td> container </td> <td> string </td> <td> Swift object store container for storing the backup files. </td> <td> true </td> </tr> <tr> <td> swiftSecretName </td> <td> string </td> <td> The name of the secret that holds Swift credentials. The secret must contain the keys "Key" and "User", and these must hold the corresponding credentials: service access key and service user name (pattern for the latter does not allow special characters &,<,>,") </td> <td> true </td> </tr> <tr> <td> prefix </td> <td> string </td> <td> Optional. Prefix (path) of backup files in the swift container. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsmoduleslist"> spec.globalConfigurations.modulesList[] </h3> <a href="#specglobalconfigurations"> ↩ Parent </a> Redis Enterprise Module: <a href="https://redislabs.com/redis-enterprise/modules/"> https://redislabs.com/redis-enterprise/modules/ </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> The module's name e.g "ft" for redissearch </td> <td> true </td> </tr> <tr> <td> config </td> <td> string </td> <td> Module command line arguments e.g. VKEY_MAX_ENTITY_COUNT 30 </td> <td> false </td> </tr> <tr> <td> uid </td> <td> string </td> <td> Module's uid - do not set, for system use only nolint:staticcheck // custom json tag unknown to the linter </td> <td> false </td> </tr> <tr> <td> version </td> <td> string </td> <td> Module's semantic version e.g "1.6.12" - optional only in REDB, must be set in REAADB </td> <td> false </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsredisenterprisecluster"> spec.globalConfigurations.redisEnterpriseCluster </h3> <a href="#specglobalconfigurations"> ↩ Parent </a> Connection to Redis Enterprise Cluster <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> The name of the Redis Enterprise Cluster where the database should be stored. </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsreplicasources"> spec.globalConfigurations.replicaSources[] </h3> <a href="#specglobalconfigurations"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> replicaSourceName </td> <td> string </td> <td> The name of the resource from which the source database URI is derived. The type of resource must match the type specified in the ReplicaSourceType field. </td> <td> true </td> </tr> <tr> <td> replicaSourceType </td> <td> string </td> <td> The type of resource from which the source database URI is derived. If set to 'SECRET', the source database URI is derived from the secret named in the ReplicaSourceName field. The secret must have a key named 'uri' that defines the URI of the source database in the form of 'redis://...'. The type of secret (kubernetes, vault, ...) is determined by the secret mechanism used by the underlying REC object. If set to 'REDB', the source database URI is derived from the RedisEnterpriseDatabase resource named in the ReplicaSourceName field. </td> <td> true </td> </tr> <tr> <td> clientKeySecret </td> <td> string </td> <td> Secret that defines the client certificate and key used by the syncer in the target database cluster. The secret must have 2 keys in its map: "cert" which is the PEM encoded certificate, and "key" which is the PEM encoded private key. </td> <td> false </td> </tr> <tr> <td> compression </td> <td> integer </td> <td> GZIP compression level (0-6) to use for replication. </td> <td> false </td> </tr> <tr> <td> serverCertSecret </td> <td> string </td> <td> Secret that defines the server certificate used by the proxy in the source database cluster. The secret must have 1 key in its map: "cert" which is the PEM encoded certificate. </td> <td> false </td> </tr> <tr> <td> tlsSniName </td> <td> string </td> <td> TLS SNI name to use for the replication link. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsrolespermissions"> spec.globalConfigurations.rolesPermissions[] </h3> <a href="#specglobalconfigurations"> ↩ Parent </a> Redis Enterprise Role and ACL Binding <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> acl </td> <td> string </td> <td> Acl Name of RolePermissionType (note: use exact name of the ACL from the Redis Enterprise ACL list, case sensitive) </td> <td> true </td> </tr> <tr> <td> role </td> <td> string </td> <td> Role Name of RolePermissionType (note: use exact name of the role from the Redis Enterprise role list, case sensitive) </td> <td> true </td> </tr> <tr> <td> type </td> <td> string </td> <td> Type of Redis Enterprise Database Role Permission </td> <td> true </td> </tr> </tbody> </table> <h3 id="specglobalconfigurationsupgradespec"> spec.globalConfigurations.upgradeSpec </h3> <a href="#specglobalconfigurations"> ↩ Parent </a> Specifications for DB upgrade. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> upgradeModulesToLatest </td> <td> boolean </td> <td> Upgrades the modules to the latest version that supportes the DB version during a DB upgrade action, to upgrade the DB version view the 'redisVersion' field. Note - This field is currently not supported for Active-Active databases. </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterprisecluster"> spec.redisEnterpriseCluster </h3> <a href="#spec"> ↩ Parent </a> Connection to Redis Enterprise Cluster <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> The name of the Redis Enterprise Cluster where the database should be stored. </td> <td> true </td> </tr> </tbody> </table> <h3 id="status"> status </h3> <a href="#"> ↩ Parent </a> RedisEnterpriseActiveActiveDatabaseStatus defines the observed state of RedisEnterpriseActiveActiveDatabase <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> guid </td> <td> string </td> <td> The active-active database corresponding GUID. </td> <td> false </td> </tr> <tr> <td> lastTaskUid </td> <td> string </td> <td> The last active-active database task UID. </td> <td> false </td> </tr> <tr> <td> linkedRedbs </td> <td> []string </td> <td> The linked REDBs. </td> <td> false </td> </tr> <tr> <td> <a href="#statusparticipatingclusters"> participatingClusters </a> </td> <td> []object </td> <td> The list of instances/ clusters statuses. </td> <td> false </td> </tr> <tr> <td> redisEnterpriseCluster </td> <td> string </td> <td> The Redis Enterprise Cluster Object this Resource is associated with </td> <td> false </td> </tr> <tr> <td> replicationStatus </td> <td> enum </td> <td> The overall replication status Enum : up, down </td> <td> false </td> </tr> <tr> <td> <a href="#statussecretsstatus"> secretsStatus </a> </td> <td> []object </td> <td> The status of the secrets </td> <td> false </td> </tr> <tr> <td> specStatus </td> <td> string </td> <td> Whether the desired specification is valid </td> <td> false </td> </tr> <tr> <td> status </td> <td> string </td> <td> The status of the active active database. </td> <td> false </td> </tr> </tbody> </table> <h3 id="statusparticipatingclusters"> status.participatingClusters[] </h3> <a href="#status"> ↩ Parent </a> Status of participating cluster. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> The name of the remote cluster CR that is linked. </td> <td> true </td> </tr> <tr> <td> id </td> <td> integer </td> <td> The corresponding ID of the instance in the active-active database. Format : int64 </td> <td> false </td> </tr> <tr> <td> replicationStatus </td> <td> enum </td> <td> The replication status of the participating cluster Enum : up, down </td> <td> false </td> </tr> </tbody> </table> <h3 id="statussecretsstatus"> status.secretsStatus[] </h3> <a href="#status"> ↩ Parent </a> Status of secrets. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> The name of the secret. </td> <td> true </td> </tr> <tr> <td> status </td> <td> enum </td> <td> The status of the secret. Enum : Valid, Invalid </td> <td> false </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/kubernetes/reference/redis_enterprise_active_active_database_api/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/sinterstore/.html

<section class="prose w-full py-12"> <h1 class="command-name"> SINTERSTORE </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">SINTERSTORE destination key [key ...]</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"> 1.0.0 </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets. </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @write </code> , <code> @set </code> , <code> @slow </code> , </dd> </dl> This command is equal to <a href="/docs/latest/commands/sinter/"> <code> SINTER </code> </a> , but instead of returning the resulting set, it is stored in <code> destination </code> . If <code> destination </code> already exists, it is overwritten. <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> SADD key1 "a" (integer) 1 redis> SADD key1 "b" (integer) 1 redis> SADD key1 "c" (integer) 1 redis> SADD key2 "c" (integer) 1 redis> SADD key2 "d" (integer) 1 redis> SADD key2 "e" (integer) 1 redis> SINTERSTORE key key1 key2 (integer) 1 redis> SMEMBERS key 1) "c" </pre> <div class="prompt" style=""> redis> <input autocomplete="off" name="prompt" spellcheck="false" type="text"/> </div> </form> <h2 id="resp2-reply"> RESP2 Reply </h2> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : the number of elements in the resulting set. <h2 id="resp3-reply"> RESP3 Reply </h2> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : the number of elements in the result set. <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/sinterstore/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/stream_triggers/.html

<section class="prose w-full py-12 max-w-none"> <h1> Stream triggers </h1> Execute a JavaScript function when an item is added to a stream <div class="banner-article rounded-md"> The Redis Stack triggers and functions feature preview has ended and it will not be promoted to GA. </div> Redis Stack's triggers and functions feature comes with a full stream API to process data from <a href="/docs/latest/develop/data-types/streams/"> Redis streams </a> . Unlike RedisGears v1 that provided a micro batching API, the new triggers and functions feature provides a real streaming API, which means that the data will be processed as soon as it enters the stream. <h2 id="register-a-stream-consumer"> Register a stream consumer </h2> Triggers and functions provide an API that allows to register a stream trigger. Do not get confused with <a href="/docs/latest/develop/data-types/streams#consumer-groups"> Redis streams consumer groups </a> , triggers and functions uses the Redis Module API to efficiently read the stream and manage its consumers. This approach gives a much better performance as there is no need to invoke any Redis commands in order to read from the stream. Lets see a simple example: <div class="highlight"> <pre class="chroma"><code class="language-js" data-lang="js">#!js api_version=1.0 name=myFirstLibrary redis.registerStreamTrigger( "consumer", // consumer name "stream", // streams prefix function(c, data) { // callback to run on each element added to the stream redis.log(JSON.stringify(data, (key, value) => typeof value === 'bigint' ? value.toString() : value // return everything else unchanged )); } ); </code></pre> </div> Argument Description: <ul> <li> consumer - the consumer name. </li> <li> stream - streams name prefix on which to trigger the callback. </li> <li> callback - the callback to invoke on each element in the stream. Following the same rules of <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/sync_async/"> sync and async invocation </a> . The callback will be invoke only on primary shard. </li> </ul> If we register this library (see the <a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/quick_start_cli/"> quick start </a> section to learn how to Register a RedisGears function) and run the following command on our Redis: <pre tabindex="0"><code>XADD stream:1 * foo1 bar1 XADD stream:1 * foo2 bar2 XADD stream:2 * foo1 bar1 XADD stream:2 * foo2 bar2 </code></pre> We will see the following line on the Redis log file: <pre tabindex="0"><code>2630021:M 05 Jul 2022 17:13:22.506 * <redisgears_2> {"id":["1657030402506","0"],"stream_name":"stream:1","record":[["foo1","bar1"]]} 2630021:M 05 Jul 2022 17:13:25.323 * <redisgears_2> {"id":["1657030405323","0"],"stream_name":"stream:1","record":[["foo2","bar2"]]} 2630021:M 05 Jul 2022 17:13:29.475 * <redisgears_2> {"id":["1657030409475","0"],"stream_name":"stream:2","record":[["foo1","bar1"]]} 2630021:M 05 Jul 2022 17:13:32.715 * <redisgears_2> {"id":["1657030412715","0"],"stream_name":"stream:2","record":[["foo2","bar2"]]} </code></pre> The <code> data </code> argument which pass to the stream consumer callback are in the following format: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "id": ["<ms>", "<seq>"], "stream_name": "<stream name>", "stream_name_raw": "<stream name as ArrayBuffer>", "record":[ ["<key>", "<value>"], . . ["<key>", "<value>"] ], "record_raw":[ ["<key_raw>", "<value_raw>"], . . ["<key_raw>", "<value_raw>"] ], } </code></pre> </div> The reason why the record is a list of touples and not an object is because the Redis Stream specifications allows duplicate keys. Notice that <code> stream_name </code> and <code> record </code> fields might contains <code> null </code> 's if the data can not be decoded as string. the <code> *_raw </code> fields will always be provided and will contains the data as <code> JS </code> <code> ArrayBuffer </code> . We can observe the streams which are tracked by our registered consumer using <code> TFUNCTION LIST </code> command: <pre tabindex="0"><code>127.0.0.1:6379> TFUNCTION LIST LIBRARY lib vvv 1) 1) "engine" 1) "js" 2) "api_version" 3) "1.0" 4) "name" 5) "lib" 6) "pending_jobs" 7) (integer) 0 8) "user" 9) "default" 10) "functions" 1) (empty array) 2) "stream_triggers" 3) 1) 1) "name" 1) "consumer" 2) "prefix" 3) "stream" 4) "window" 5) (integer) 1 6) "trim" 7) "disabled" 8) "num_streams" 1) (integer) 2 2) "streams" 3) 1) 1) "name" 1) "stream:2" 2) "last_processed_time" 3) (integer) 0 4) "avg_processed_time" 5) "0" 6) "last_lag" 7) (integer) 0 8) "avg_lag" 1) "0" 2) "total_record_processed" 3) (integer) 2 4) "id_to_read_from" 5) "1657030412715-0" 6) "last_error" 7) "None" 17) "pending_ids" 18) (empty array) 1) 1) "name" 1) "stream:1" 2) "last_processed_time" 3) (integer) 1 4) "avg_processed_time" 5) "0.5" 6) "last_lag" 7) (integer) 1 8) "avg_lag" 1) "0.5" 2) "total_record_processed" 3) (integer) 2 4) "id_to_read_from" 5) "1657030405323-0" 6) "last_error" 7) "None" 8) "pending_ids" 9) (empty array) 4) "keyspace_triggers" 5) (empty array) </code></pre> <h2 id="enable-trimming-and-set-window"> Enable trimming and set window </h2> We can enable stream trimming by adding <code> isStreamTrimmed </code> optional argument after the trigger callback, we can also set the <code> window </code> argument that controls how many elements can be processed simultaneously. example: <div class="highlight"> <pre class="chroma"><code class="language-js" data-lang="js">#!js api_version=1.0 name=myFirstLibrary redis.registerStreamTrigger( "consumer", // consumer name "stream", // streams prefix function(c, data) { // callback to run on each element added to the stream redis.log(JSON.stringify(data, (key, value) => typeof value === 'bigint' ? value.toString() : value // return everything else unchanged )); }, { isStreamTrimmed: true, window: 3 } ); </code></pre> </div> The default values are: <ul> <li> <code> isStreamTrimmed </code> - <code> false </code> </li> <li> <code> window </code> - 1 </li> </ul> It is enough that a single consumer will enable trimming so that the stream will be trimmed. The stream will be trim according to the slowest consumer that consume the stream at a given time (even if this is not the consumer that enabled the trimming). Raising exception during the callback invocation will not prevent the trimming . The callback should decide how to handle failures by invoke a retry or write some error log. The error will be added to the <code> last_error </code> field on <code> TFUNCTION LIST </code> command. <h2 id="data-processing-guarantees"> Data processing guarantees </h2> As long as the primary shard is up and running we guarantee exactly once property (the callback will be triggered exactly one time on each element in the stream). In case of failure such as shard crashing, we guarantee at least once property (the callback will be triggered at least one time on each element in the stream) <h2 id="upgrades"> Upgrades </h2> When upgrading the consumer code (using the <code> REPLACE </code> option of <code> TFUNCTION LOAD </code> command) the following consumer parameters can be updated: <ul> <li> Window </li> <li> Trimming </li> </ul> Any attempt to update any other parameter will result in an error when loading the library. <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/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/stream_triggers/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/objects/bootstrap/limits/.html

<section class="prose w-full py-12 max-w-none"> <h1> Limits object </h1> Documents the limits object used with Redis Enterprise Software REST API calls. <table> <thead> <tr> <th> Name </th> <th> Type/Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> max_listeners </td> <td> integer (default: 100) </td> <td> Max allowed listeners on node </td> </tr> <tr> <td> max_redis_servers </td> <td> integer (default: 100) </td> <td> Max allowed Redis servers on node </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/rest-api/objects/bootstrap/limits/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/json.arrindex/.html

<section class="prose w-full py-12"> <h1 class="command-name"> JSON.ARRINDEX </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">JSON.ARRINDEX key path value [start [stop]]</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/json"> JSON 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(N) when path is evaluated to a single value where N is the size of the array, O(N) when path is evaluated to multiple values, where N is the size of the key </dd> </dl> Search for the first occurrence of a JSON value in an array <a href="#examples"> Examples </a> <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> key </code> </summary> is key to parse. </details> <details open=""> <summary> <code> path </code> </summary> is JSONPath to specify. </details> <details open=""> <summary> <code> value </code> </summary> is value to find its index in one or more arrays. <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"> About using strings with JSON commands: </div> To specify a string as an array value to index, wrap the quoted string with an additional set of single quotes. Example: <code> '"silver"' </code> . For more detailed use, see <a href="#examples"> Examples </a> . </div> </div> </details> <h2 id="optional-arguments"> Optional arguments </h2> <details open=""> <summary> <code> start </code> </summary> is inclusive start value to specify in a slice of the array to search. Default is <code> 0 </code> . </details> <details open=""> <summary> <code> stop </code> </summary> is exclusive stop value to specify in a slice of the array to search, including the last element. Default is <code> 0 </code> . Negative values are interpreted as starting from the end. </details> <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"> About out-of-range indexes: </div> Out-of-range indexes round to the array's start and end. An inverse index range (such as the range from 1 to 0) returns unfound or <code> -1 </code> . </div> </div> <h2 id="return-value"> Return value </h2> <code> JSON.ARRINDEX </code> returns an <a href="/docs/latest/develop/reference/protocol-spec#resp-arrays"> array </a> of integer replies for each path, the first position in the array of each JSON value that matches the path, <code> -1 </code> if unfound in the array, or <code> nil </code> , if the matching JSON value is not an array. For more information about replies, see <a href="/docs/latest/develop/reference/protocol-spec/"> Redis serialization protocol specification </a> . <h2 id="examples"> Examples </h2> <details open=""> <summary> Find the specific place of a color in a list of product colors </summary> Create a document for noise-cancelling headphones in black and silver colors. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.SET item:1 $ '{"name":"Noise-cancelling Bluetooth headphones","description":"Wireless Bluetooth headphones with noise-cancelling technology","connection":{"wireless":true,"type":"Bluetooth"},"price":99.98,"stock":25,"colors":["black","silver"]}' OK</code></pre> </div> Add color <code> blue </code> to the end of the <code> colors </code> array. <code> JSON.ARRAPEND </code> returns the array's new size. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.ARRAPPEND item:1 $.colors '"blue"' 1) (integer) 3</code></pre> </div> Return the new length of the <code> colors </code> array. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.GET item:1 "{\"name\":\"Noise-cancelling Bluetooth headphones\",\"description\":\"Wireless Bluetooth headphones with noise-cancelling technology\",\"connection\":{\"wireless\":true,\"type\":\"Bluetooth\"},\"price\":99.98,\"stock\":25,\"colors\":[\"black\",\"silver\",\"blue\"]}"</code></pre> </div> Get the list of colors for the product. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.GET item:1 '$.colors[*]' "[\"black\",\"silver\",\"blue\"]"</code></pre> </div> Insert two more colors after the second color. You now have five colors. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.ARRINSERT item:1 $.colors 2 '"yellow"' '"gold"' 1) (integer) 5</code></pre> </div> Get the updated list of colors. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.GET item:1 $.colors "[[\"black\",\"silver\",\"yellow\",\"gold\",\"blue\"]]"</code></pre> </div> Find the place where color <code> silver </code> is located. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.ARRINDEX item:1 $..colors '"silver"' 1) (integer) 1</code></pre> </div> </details> <h2 id="see-also"> See also </h2> <a href="/docs/latest/commands/json.arrappend/"> <code> JSON.ARRAPPEND </code> </a> | <a href="/docs/latest/commands/json.arrinsert/"> <code> JSON.ARRINSERT </code> </a> <h2 id="related-topics"> Related topics </h2> <ul> <li> <a href="/docs/latest/develop/data-types/json/"> RedisJSON </a> </li> <li> <a href="/docs/latest/develop/interact/search-and-query/indexing/"> Index and search JSON documents </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/commands/json.arrindex/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2/.html

<section class="prose w-full py-12 max-w-none"> <h1> Transition from Prometheus v1 to Prometheus v2 </h1> Transition from v1 metrics to v2 PromQL equivalents. You can <a href="/docs/latest/integrate/prometheus-with-redis-enterprise/"> integrate Redis Enterprise Software with Prometheus and Grafana </a> to create dashboards for important metrics. As of Redis Enterprise Software version 7.8.2, <a href="https://prometheus.io/docs/prometheus/latest/querying/basics/"> PromQL (Prometheus Query Language) </a> metrics are available, and v1 metrics are deprecated. You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 PromQL metrics, see <a href="/docs/latest/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions/"> Prometheus metrics v2 </a> . <h2 id="database-metrics"> Database metrics </h2> <table> <thead> <tr> <th> V1 metric </th> <th style="text-align:left"> Equivalent V2 PromQL </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td> bdb_avg_latency </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_acc_latency[1m])) / sum by (bdb) (irate(endpoint_total_started_res[1m])) / 1000000 </code> </td> <td style="text-align:left"> Average latency of operations on the database (seconds); returned only when there is traffic </td> </tr> <tr> <td> bdb_avg_latency_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_acc_latency[1m])) / sum by (bdb) (irate(endpoint_total_started_res[1m])) / 1000000 </code> </td> <td style="text-align:left"> Highest value of average latency of operations on the database (seconds); returned only when there is traffic </td> </tr> <tr> <td> bdb_avg_read_latency </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_acc_read_latency[1m])) / sum by (bdb) (irate(endpoint_total_started_res[1m])) / 1000000 </code> </td> <td style="text-align:left"> Average latency of read operations (seconds); returned only when there is traffic </td> </tr> <tr> <td> bdb_avg_read_latency_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_acc_read_latency[1m])) / sum by (bdb) (irate(endpoint_total_started_res[1m])) / 1000000 </code> </td> <td style="text-align:left"> Highest value of average latency of read operations (seconds); returned only when there is traffic </td> </tr> <tr> <td> bdb_avg_write_latency </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_acc_write_latency[1m])) / sum by (bdb) (irate(endpoint_total_started_res[1m])) / 1000000 </code> </td> <td style="text-align:left"> Average latency of write operations (seconds); returned only when there is traffic </td> </tr> <tr> <td> bdb_avg_write_latency_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_acc_write_latency[1m])) / sum by (bdb) (irate(endpoint_total_started_res[1m])) / 1000000 </code> </td> <td style="text-align:left"> Highest value of average latency of write operations (seconds); returned only when there is traffic </td> </tr> <tr> <td> bdb_bigstore_shard_count </td> <td style="text-align:left"> <code> sum((sum(label_replace(label_replace(namedprocess_namegroup_thread_count{groupname=~"redis-\d+", threadname=~"(speedb|rocksdb).*"}, "redis", "$1", "groupname", "redis-(\d+)"), "driver", "$1", "threadname", "(speedb|rocksdb).*")) by (redis, driver) > bool 0) * on (redis) group_left(bdb) redis_server_up) by (bdb, driver) </code> </td> <td style="text-align:left"> Shard count by database and by storage engine (driver - rocksdb / speedb); Only for databases with Auto Tiering enabled </td> </tr> <tr> <td> bdb_conns </td> <td style="text-align:left"> <code> sum by(bdb) (endpoint_conns) </code> </td> <td style="text-align:left"> Number of client connections to database </td> </tr> <tr> <td> bdb_egress_bytes </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_egress_bytes[1m])) </code> </td> <td style="text-align:left"> Rate of outgoing network traffic from the database (bytes/sec) </td> </tr> <tr> <td> bdb_egress_bytes_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_egress_bytes[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of outgoing network traffic from the database (bytes/sec) </td> </tr> <tr> <td> bdb_evicted_objects </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_evicted_keys{role="master"}[1m])) </code> </td> <td style="text-align:left"> Rate of key evictions from database (evictions/sec) </td> </tr> <tr> <td> bdb_evicted_objects_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_evicted_keys{role="master"}[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of key evictions from database (evictions/sec) </td> </tr> <tr> <td> bdb_expired_objects </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_expired_keys{role="master"}[1m])) </code> </td> <td style="text-align:left"> Rate keys expired in database (expirations/sec) </td> </tr> <tr> <td> bdb_expired_objects_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_expired_keys{role="master"}[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate keys expired in database (expirations/sec) </td> </tr> <tr> <td> bdb_fork_cpu_system </td> <td style="text-align:left"> <code> sum by (bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="system"}[1m])) </code> </td> <td style="text-align:left"> % cores utilization in system mode for all Redis shard fork child processes of this database </td> </tr> <tr> <td> bdb_fork_cpu_system_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="system"}[1m])) </code> </td> <td style="text-align:left"> Highest value of % cores utilization in system mode for all Redis shard fork child processes of this database </td> </tr> <tr> <td> bdb_fork_cpu_user </td> <td style="text-align:left"> <code> sum by (bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="user"}[1m])) </code> </td> <td style="text-align:left"> % cores utilization in user mode for all Redis shard fork child processes of this database </td> </tr> <tr> <td> bdb_fork_cpu_user_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="user"}[1m])) </code> </td> <td style="text-align:left"> Highest value of % cores utilization in user mode for all Redis shard fork child processes of this database </td> </tr> <tr> <td> bdb_ingress_bytes </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_ingress_bytes[1m])) </code> </td> <td style="text-align:left"> Rate of incoming network traffic to database (bytes/sec) </td> </tr> <tr> <td> bdb_ingress_bytes_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_ingress_bytes[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of incoming network traffic to database (bytes/sec) </td> </tr> <tr> <td> bdb_instantaneous_ops_per_sec </td> <td style="text-align:left"> <code> sum by(bdb) (redis_server_instantaneous_ops_per_sec) </code> </td> <td style="text-align:left"> Request rate handled by all shards of database (ops/sec) </td> </tr> <tr> <td> bdb_main_thread_cpu_system </td> <td style="text-align:left"> <code> sum by(bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="system", threadname=~"redis-server.*"}[1m])) </code> </td> <td style="text-align:left"> % cores utilization in system mode for all Redis shard main threads of this database </td> </tr> <tr> <td> bdb_main_thread_cpu_system_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="system", threadname=~"redis-server.*"}[1m])) </code> </td> <td style="text-align:left"> Highest value of % cores utilization in system mode for all Redis shard main threads of this database </td> </tr> <tr> <td> bdb_main_thread_cpu_user </td> <td style="text-align:left"> <code> sum by(irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="user", threadname=~"redis-server.*"}[1m])) </code> </td> <td style="text-align:left"> % cores utilization in user mode for all Redis shard main threads of this database </td> </tr> <tr> <td> bdb_main_thread_cpu_user_max </td> <td style="text-align:left"> <code> sum by(irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="user", threadname=~"redis-server.*"}[1m])) </code> </td> <td style="text-align:left"> Highest value of % cores utilization in user mode for all Redis shard main threads of this database </td> </tr> <tr> <td> bdb_mem_frag_ratio </td> <td style="text-align:left"> <code> avg(redis_server_mem_fragmentation_ratio) </code> </td> <td style="text-align:left"> RAM fragmentation ratio (RSS / allocated RAM) </td> </tr> <tr> <td> bdb_mem_size_lua </td> <td style="text-align:left"> <code> sum by(bdb) (redis_server_used_memory_lua) </code> </td> <td style="text-align:left"> Redis lua scripting heap size (bytes) </td> </tr> <tr> <td> bdb_memory_limit </td> <td style="text-align:left"> <code> sum by(bdb) (redis_server_maxmemory) </code> </td> <td style="text-align:left"> Configured RAM limit for the database </td> </tr> <tr> <td> bdb_monitor_sessions_count </td> <td style="text-align:left"> <code> sum by(bdb) (endpoint_monitor_sessions_count) </code> </td> <td style="text-align:left"> Number of clients connected in monitor mode to the database </td> </tr> <tr> <td> bdb_no_of_keys </td> <td style="text-align:left"> <code> sum by (bdb) (redis_server_db_keys{role="master"}) </code> </td> <td style="text-align:left"> Number of keys in database </td> </tr> <tr> <td> bdb_other_req </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_other_req[1m])) </code> </td> <td style="text-align:left"> Rate of other (non read/write) requests on the database (ops/sec) </td> </tr> <tr> <td> bdb_other_req_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_other_req[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of other (non read/write) requests on the database (ops/sec) </td> </tr> <tr> <td> bdb_other_res </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_other_res[1m])) </code> </td> <td style="text-align:left"> Rate of other (non read/write) responses on the database (ops/sec) </td> </tr> <tr> <td> bdb_other_res_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_other_res[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of other (non read/write) responses on the database (ops/sec) </td> </tr> <tr> <td> bdb_pubsub_channels </td> <td style="text-align:left"> <code> sum by(bdb) (redis_server_pubsub_channels) </code> </td> <td style="text-align:left"> Count the pub/sub channels with subscribed clients </td> </tr> <tr> <td> bdb_pubsub_channels_max </td> <td style="text-align:left"> <code> sum by(bdb) (redis_server_pubsub_channels) </code> </td> <td style="text-align:left"> Highest value of count the pub/sub channels with subscribed clients </td> </tr> <tr> <td> bdb_pubsub_patterns </td> <td style="text-align:left"> <code> sum by(bdb) (redis_server_pubsub_patterns) </code> </td> <td style="text-align:left"> Count the pub/sub patterns with subscribed clients </td> </tr> <tr> <td> bdb_pubsub_patterns_max </td> <td style="text-align:left"> <code> sum by(bdb) (redis_server_pubsub_patterns) </code> </td> <td style="text-align:left"> Highest value of count the pub/sub patterns with subscribed clients </td> </tr> <tr> <td> bdb_read_hits </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_keyspace_read_hits{role="master"}[1m])) </code> </td> <td style="text-align:left"> Rate of read operations accessing an existing key (ops/sec) </td> </tr> <tr> <td> bdb_read_hits_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_keyspace_read_hits{role="master"}[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of read operations accessing an existing key (ops/sec) </td> </tr> <tr> <td> bdb_read_misses </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_keyspace_read_misses{role="master"}[1m])) </code> </td> <td style="text-align:left"> Rate of read operations accessing a non-existing key (ops/sec) </td> </tr> <tr> <td> bdb_read_misses_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_keyspace_read_misses{role="master"}[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of read operations accessing a non-existing key (ops/sec) </td> </tr> <tr> <td> bdb_read_req </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_read_req[1m])) </code> </td> <td style="text-align:left"> Rate of read requests on the database (ops/sec) </td> </tr> <tr> <td> bdb_read_req_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_read_req[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of read requests on the database (ops/sec) </td> </tr> <tr> <td> bdb_read_res </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_read_res[1m])) </code> </td> <td style="text-align:left"> Rate of read responses on the database (ops/sec) </td> </tr> <tr> <td> bdb_read_res_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_read_res[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of read responses on the database (ops/sec) </td> </tr> <tr> <td> bdb_shard_cpu_system </td> <td style="text-align:left"> <code> sum by(bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="system", role="master"}[1m])) </code> </td> <td style="text-align:left"> % cores utilization in system mode for all Redis shard processes of this database </td> </tr> <tr> <td> bdb_shard_cpu_system_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="system", role="master"}[1m])) </code> </td> <td style="text-align:left"> Highest value of % cores utilization in system mode for all Redis shard processes of this database </td> </tr> <tr> <td> bdb_shard_cpu_user </td> <td style="text-align:left"> <code> sum by(bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="user", role="master"}[1m])) </code> </td> <td style="text-align:left"> % cores utilization in user mode for the Redis shard process </td> </tr> <tr> <td> bdb_shard_cpu_user_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(namedprocess_namegroup_thread_cpu_seconds_total{mode="user", role="master"}[1m])) </code> </td> <td style="text-align:left"> Highest value of % cores utilization in user mode for the Redis shard process </td> </tr> <tr> <td> bdb_shards_used </td> <td style="text-align:left"> <code> sum((sum(label_replace(label_replace(label_replace(namedprocess_namegroup_thread_count{groupname=~"redis-\d+"}, "redis", "$1", "groupname", "redis-(\d+)"), "shard_type", "flash", "threadname", "(bigstore).*"), "shard_type", "ram", "shard_type", "")) by (redis, shard_type) > bool 0) * on (redis) group_left(bdb) redis_server_up) by (bdb, shard_type) </code> </td> <td style="text-align:left"> Used shard count by database and by shard type (ram / flash) </td> </tr> <tr> <td> bdb_total_connections_received </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_total_connections_received[1m])) </code> </td> <td style="text-align:left"> Rate of new client connections to database (connections/sec) </td> </tr> <tr> <td> bdb_total_connections_received_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_total_connections_received[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of new client connections to database (connections/sec) </td> </tr> <tr> <td> bdb_total_req </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_total_req[1m])) </code> </td> <td style="text-align:left"> Rate of all requests on the database (ops/sec) </td> </tr> <tr> <td> bdb_total_req_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_total_req[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of all requests on the database (ops/sec) </td> </tr> <tr> <td> bdb_total_res </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_total_res[1m])) </code> </td> <td style="text-align:left"> Rate of all responses on the database (ops/sec) </td> </tr> <tr> <td> bdb_total_res_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_total_res[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of all responses on the database (ops/sec) </td> </tr> <tr> <td> bdb_up </td> <td style="text-align:left"> <code> min by(bdb) (redis_up) </code> </td> <td style="text-align:left"> Database is up and running </td> </tr> <tr> <td> bdb_used_memory </td> <td style="text-align:left"> <code> sum by (bdb) (redis_server_used_memory) </code> </td> <td style="text-align:left"> Memory used by database (in BigRedis this includes flash) (bytes) </td> </tr> <tr> <td> bdb_write_hits </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_keyspace_write_hits{role="master"}[1m])) </code> </td> <td style="text-align:left"> Rate of write operations accessing an existing key (ops/sec) </td> </tr> <tr> <td> bdb_write_hits_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_keyspace_write_hits{role="master"}[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of write operations accessing an existing key (ops/sec) </td> </tr> <tr> <td> bdb_write_misses </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_keyspace_write_misses{role="master"}[1m])) </code> </td> <td style="text-align:left"> Rate of write operations accessing a non-existing key (ops/sec) </td> </tr> <tr> <td> bdb_write_misses_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(redis_server_keyspace_write_misses{role="master"}[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of write operations accessing a non-existing key (ops/sec) </td> </tr> <tr> <td> bdb_write_req </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_write_req[1m])) </code> </td> <td style="text-align:left"> Rate of write requests on the database (ops/sec) </td> </tr> <tr> <td> bdb_write_req_max </td> <td style="text-align:left"> <code> sum by (bdb) (irate(endpoint_write_req[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of write requests on the database (ops/sec) </td> </tr> <tr> <td> bdb_write_res </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_write_responses[1m])) </code> </td> <td style="text-align:left"> Rate of write responses on the database (ops/sec) </td> </tr> <tr> <td> bdb_write_res_max </td> <td style="text-align:left"> <code> sum by(bdb) (irate(endpoint_write_responses[1m])) </code> </td> <td style="text-align:left"> Highest value of the rate of write responses on the database (ops/sec) </td> </tr> <tr> <td> no_of_expires </td> <td style="text-align:left"> <code> sum by(bdb) (redis_server_db_expires{role="master"}) </code> </td> <td style="text-align:left"> Current number of volatile keys in the database </td> </tr> </tbody> </table> <h2 id="node-metrics"> Node metrics </h2> <table> <thead> <tr> <th> V1 metric </th> <th style="text-align:left"> Equivalent V2 PromQL </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td> node_available_flash </td> <td style="text-align:left"> <code> node_available_flash_bytes </code> </td> <td style="text-align:left"> Available flash in the node (bytes) </td> </tr> <tr> <td> node_available_flash_no_overbooking </td> <td style="text-align:left"> <code> node_available_flash_no_overbooking_bytes </code> </td> <td style="text-align:left"> Available flash in the node (bytes), without taking into account overbooking </td> </tr> <tr> <td> node_available_memory </td> <td style="text-align:left"> <code> node_available_memory_bytes </code> </td> <td style="text-align:left"> Amount of free memory in the node (bytes) that is available for database provisioning </td> </tr> <tr> <td> node_available_memory_no_overbooking </td> <td style="text-align:left"> <code> node_available_memory_no_overbooking_bytes </code> </td> <td style="text-align:left"> Available RAM in the node (bytes) without taking into account overbooking </td> </tr> <tr> <td> node_avg_latency </td> <td style="text-align:left"> <code> sum by (proxy) (irate(endpoint_acc_latency[1m])) / sum by (proxy) (irate(endpoint_total_started_res[1m])) </code> </td> <td style="text-align:left"> Average latency of requests handled by endpoints on the node in milliseconds; returned only when there is traffic </td> </tr> <tr> <td> node_bigstore_free </td> <td style="text-align:left"> <code> node_bigstore_free_bytes </code> </td> <td style="text-align:left"> Sum of free space of back-end flash (used by flash database's [BigRedis]) on all cluster nodes (bytes); returned only when BigRedis is enabled </td> </tr> <tr> <td> node_bigstore_iops </td> <td style="text-align:left"> <code> node_flash_reads_total + node_flash_writes_total </code> </td> <td style="text-align:left"> Rate of I/O operations against back-end flash for all shards which are part of a flash-based database (BigRedis) in the cluster (ops/sec); returned only when BigRedis is enabled </td> </tr> <tr> <td> node_bigstore_kv_ops </td> <td style="text-align:left"> <code> sum by (node) (irate(redis_server_big_io_dels[1m]) + irate(redis_server_big_io_reads[1m]) + irate(redis_server_big_io_writes[1m])) </code> </td> <td style="text-align:left"> Rate of value read/write operations against back-end flash for all shards which are part of a flash-based database (BigRedis) in the cluster (ops/sec); returned only when BigRedis is enabled </td> </tr> <tr> <td> node_bigstore_throughput </td> <td style="text-align:left"> <code> sum by (node) (irate(redis_server_big_io_read_bytes[1m]) + irate(redis_server_big_io_write_bytes[1m])) </code> </td> <td style="text-align:left"> Throughput I/O operations against back-end flash for all shards which are part of a flash-based database (BigRedis) in the cluster (bytes/sec); returned only when BigRedis is enabled </td> </tr> <tr> <td> node_cert_expiration_seconds </td> <td style="text-align:left"> <code> node_cert_expires_in_seconds </code> </td> <td style="text-align:left"> Certificate expiration (in seconds) per given node; read more about <a href="/docs/latest/operate/rs/security/certificates/"> certificates in Redis Enterprise </a> and <a href="/docs/latest/operate/rs/security/certificates/monitor-certificates/"> monitoring certificates </a> </td> </tr> <tr> <td> node_conns </td> <td style="text-align:left"> <code> sum by (node) (endpoint_conns) </code> </td> <td style="text-align:left"> Number of clients connected to endpoints on node </td> </tr> <tr> <td> node_cpu_idle </td> <td style="text-align:left"> <code> avg by (node) (irate(node_cpu_seconds_total{mode="idle"}[1m])) </code> </td> <td style="text-align:left"> CPU idle time portion (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_idle_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of CPU idle time portion (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_idle_median </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Average value of CPU idle time portion (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_idle_min </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Lowest value of CPU idle time portion (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_system </td> <td style="text-align:left"> <code> avg by (node) (irate(node_cpu_seconds_total{mode="system"}[1m])) </code> </td> <td style="text-align:left"> CPU time portion spent in the kernel (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_system_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of CPU time portion spent in the kernel (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_system_median </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Average value of CPU time portion spent in the kernel (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_system_min </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Lowest value of CPU time portion spent in the kernel (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_user </td> <td style="text-align:left"> <code> avg by (node) (irate(node_cpu_seconds_total{mode="user"}[1m])) </code> </td> <td style="text-align:left"> CPU time portion spent by user-space processes (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_user_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of CPU time portion spent by user-space processes (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_user_median </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Average value of CPU time portion spent by user-space processes (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cpu_user_min </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Lowest value of CPU time portion spent by user-space processes (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> node_cur_aof_rewrites </td> <td style="text-align:left"> <code> sum by (cluster, node) (redis_server_aof_rewrite_in_progress) </code> </td> <td style="text-align:left"> Number of AOF rewrites that are currently performed by shards on this node </td> </tr> <tr> <td> node_egress_bytes </td> <td style="text-align:left"> <code> irate(node_network_transmit_bytes_total{device="<interface>"}[1m]) </code> </td> <td style="text-align:left"> Rate of outgoing network traffic to node (bytes/sec) </td> </tr> <tr> <td> node_egress_bytes_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of outgoing network traffic to node (bytes/sec) </td> </tr> <tr> <td> node_egress_bytes_median </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Average value of the rate of outgoing network traffic to node (bytes/sec) </td> </tr> <tr> <td> node_egress_bytes_min </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Lowest value of the rate of outgoing network traffic to node (bytes/sec) </td> </tr> <tr> <td> node_ephemeral_storage_avail </td> <td style="text-align:left"> <code> node_ephemeral_storage_avail_bytes </code> </td> <td style="text-align:left"> Disk space available to RLEC processes on configured ephemeral disk (bytes) </td> </tr> <tr> <td> node_ephemeral_storage_free </td> <td style="text-align:left"> <code> node_ephemeral_storage_free_bytes </code> </td> <td style="text-align:left"> Free disk space on configured ephemeral disk (bytes) </td> </tr> <tr> <td> node_free_memory </td> <td style="text-align:left"> <code> node_memory_MemFree_bytes </code> </td> <td style="text-align:left"> Free memory in the node (bytes) </td> </tr> <tr> <td> node_ingress_bytes </td> <td style="text-align:left"> <code> irate(node_network_receive_bytes_total{device="<interface>"}[1m]) </code> </td> <td style="text-align:left"> Rate of incoming network traffic to node (bytes/sec) </td> </tr> <tr> <td> node_ingress_bytes_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of incoming network traffic to node (bytes/sec) </td> </tr> <tr> <td> node_ingress_bytes_median </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Average value of the rate of incoming network traffic to node (bytes/sec) </td> </tr> <tr> <td> node_ingress_bytes_min </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Lowest value of the rate of incoming network traffic to node (bytes/sec) </td> </tr> <tr> <td> node_persistent_storage_avail </td> <td style="text-align:left"> <code> node_persistent_storage_avail_bytes </code> </td> <td style="text-align:left"> Disk space available to RLEC processes on configured persistent disk (bytes) </td> </tr> <tr> <td> node_persistent_storage_free </td> <td style="text-align:left"> <code> node_persistent_storage_free_bytes </code> </td> <td style="text-align:left"> Free disk space on configured persistent disk (bytes) </td> </tr> <tr> <td> node_provisional_flash </td> <td style="text-align:left"> <code> node_provisional_flash_bytes </code> </td> <td style="text-align:left"> Amount of flash available for new shards on this node, taking into account overbooking, max Redis servers, reserved flash, and provision and migration thresholds (bytes) </td> </tr> <tr> <td> node_provisional_flash_no_overbooking </td> <td style="text-align:left"> <code> node_provisional_flash_no_overbooking_bytes </code> </td> <td style="text-align:left"> Amount of flash available for new shards on this node, without taking into account overbooking, max Redis servers, reserved flash, and provision and migration thresholds (bytes) </td> </tr> <tr> <td> node_provisional_memory </td> <td style="text-align:left"> <code> node_provisional_memory_bytes </code> </td> <td style="text-align:left"> Amount of RAM that is available for provisioning to databases out of the total RAM allocated for databases </td> </tr> <tr> <td> node_provisional_memory_no_overbooking </td> <td style="text-align:left"> <code> node_provisional_memory_no_overbooking_bytes </code> </td> <td style="text-align:left"> Amount of RAM that is available for provisioning to databases out of the total RAM allocated for databases, without taking into account overbooking </td> </tr> <tr> <td> node_total_req </td> <td style="text-align:left"> <code> sum by (cluster, node) (irate(endpoint_total_req[1m])) </code> </td> <td style="text-align:left"> Request rate handled by endpoints on node (ops/sec) </td> </tr> <tr> <td> node_up </td> <td style="text-align:left"> <code> node_metrics_up </code> </td> <td style="text-align:left"> Node is part of the cluster and is connected </td> </tr> </tbody> </table> <h2 id="cluster-metrics"> Cluster metrics </h2> <table> <thead> <tr> <th> V1 metric </th> <th style="text-align:left"> Equivalent V2 PromQL </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td> cluster_shards_limit </td> <td style="text-align:left"> <code> license_shards_limit </code> </td> <td style="text-align:left"> Total shard limit by the license by shard type (ram / flash) </td> </tr> </tbody> </table> <h2 id="proxy-metrics"> Proxy metrics </h2> <table> <thead> <tr> <th> V1 metric </th> <th style="text-align:left"> Equivalent V2 PromQL </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td> listener_acc_latency </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Accumulative latency (sum of the latencies) of all types of commands on the database. For the average latency, divide this value by listener_total_res </td> </tr> <tr> <td> listener_acc_latency_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of accumulative latency of all types of commands on the database </td> </tr> <tr> <td> listener_acc_other_latency </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Accumulative latency (sum of the latencies) of commands that are a type "other" on the database. For the average latency, divide this value by listener_other_res </td> </tr> <tr> <td> listener_acc_other_latency_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of accumulative latency of commands that are a type "other" on the database </td> </tr> <tr> <td> listener_acc_read_latency </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Accumulative latency (sum of the latencies) of commands that are a type "read" on the database. For the average latency, divide this value by listener_read_res </td> </tr> <tr> <td> listener_acc_read_latency_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of accumulative latency of commands that are a type "read" on the database </td> </tr> <tr> <td> listener_acc_write_latency </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Accumulative latency (sum of the latencies) of commands that are a type "write" on the database. For the average latency, divide this value by listener_write_res </td> </tr> <tr> <td> listener_acc_write_latency_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of accumulative latency of commands that are a type "write" on the database </td> </tr> <tr> <td> listener_auth_cmds </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of memcached AUTH commands sent to the database </td> </tr> <tr> <td> listener_auth_cmds_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of memcached AUTH commands sent to the database </td> </tr> <tr> <td> listener_auth_errors </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of error responses to memcached AUTH commands </td> </tr> <tr> <td> listener_auth_errors_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of error responses to memcached AUTH commands </td> </tr> <tr> <td> listener_cmd_flush </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of memcached FLUSH_ALL commands sent to the database </td> </tr> <tr> <td> listener_cmd_flush_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of memcached FLUSH_ALL commands sent to the database </td> </tr> <tr> <td> listener_cmd_get </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of memcached GET commands sent to the database </td> </tr> <tr> <td> listener_cmd_get_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of memcached GET commands sent to the database </td> </tr> <tr> <td> listener_cmd_set </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of memcached SET commands sent to the database </td> </tr> <tr> <td> listener_cmd_set_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of memcached SET commands sent to the database </td> </tr> <tr> <td> listener_cmd_touch </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of memcached TOUCH commands sent to the database </td> </tr> <tr> <td> listener_cmd_touch_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of memcached TOUCH commands sent to the database </td> </tr> <tr> <td> listener_conns </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of clients connected to the endpoint </td> </tr> <tr> <td> listener_egress_bytes </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Rate of outgoing network traffic to the endpoint (bytes/sec) </td> </tr> <tr> <td> listener_egress_bytes_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of outgoing network traffic to the endpoint (bytes/sec) </td> </tr> <tr> <td> listener_ingress_bytes </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Rate of incoming network traffic to the endpoint (bytes/sec) </td> </tr> <tr> <td> listener_ingress_bytes_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of incoming network traffic to the endpoint (bytes/sec) </td> </tr> <tr> <td> listener_last_req_time </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Time of last command sent to the database </td> </tr> <tr> <td> listener_last_res_time </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Time of last response sent from the database </td> </tr> <tr> <td> listener_max_connections_exceeded </td> <td style="text-align:left"> <code> irate(endpoint_maximal_connections_exceeded[1m]) </code> </td> <td style="text-align:left"> Number of times the number of clients connected to the database at the same time has exceeded the max limit </td> </tr> <tr> <td> listener_max_connections_exceeded_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of times the number of clients connected to the database at the same time has exceeded the max limit </td> </tr> <tr> <td> listener_monitor_sessions_count </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of clients connected in monitor mode to the endpoint </td> </tr> <tr> <td> listener_other_req </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Rate of other (non-read/write) requests on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_other_req_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of other (non-read/write) requests on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_other_res </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Rate of other (non-read/write) responses on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_other_res_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of other (non-read/write) responses on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_other_started_res </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of responses sent from the database of type "other" </td> </tr> <tr> <td> listener_other_started_res_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of responses sent from the database of type "other" </td> </tr> <tr> <td> listener_read_req </td> <td style="text-align:left"> <code> irate(endpoint_read_requests[1m]) </code> </td> <td style="text-align:left"> Rate of read requests on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_read_req_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of read requests on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_read_res </td> <td style="text-align:left"> <code> irate(endpoint_read_responses[1m]) </code> </td> <td style="text-align:left"> Rate of read responses on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_read_res_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of read responses on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_read_started_res </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of responses sent from the database of type "read" </td> </tr> <tr> <td> listener_read_started_res_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of responses sent from the database of type "read" </td> </tr> <tr> <td> listener_total_connections_received </td> <td style="text-align:left"> <code> irate(endpoint_total_connections_received[1m]) </code> </td> <td style="text-align:left"> Rate of new client connections to the endpoint (connections/sec) </td> </tr> <tr> <td> listener_total_connections_received_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of new client connections to the endpoint (connections/sec) </td> </tr> <tr> <td> listener_total_req </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Request rate handled by the endpoint (ops/sec) </td> </tr> <tr> <td> listener_total_req_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of all requests on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_total_res </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Rate of all responses on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_total_res_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of all responses on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_total_started_res </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of responses sent from the database of all types </td> </tr> <tr> <td> listener_total_started_res_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of responses sent from the database of all types </td> </tr> <tr> <td> listener_write_req </td> <td style="text-align:left"> <code> irate(endpoint_write_requests[1m]) </code> </td> <td style="text-align:left"> Rate of write requests on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_write_req_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of write requests on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_write_res </td> <td style="text-align:left"> <code> irate(endpoint_write_responses[1m]) </code> </td> <td style="text-align:left"> Rate of write responses on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_write_res_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the rate of write responses on the endpoint (ops/sec) </td> </tr> <tr> <td> listener_write_started_res </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Number of responses sent from the database of type "write" </td> </tr> <tr> <td> listener_write_started_res_max </td> <td style="text-align:left"> N/A </td> <td style="text-align:left"> Highest value of the number of responses sent from the database of type "write" </td> </tr> </tbody> </table> <h2 id="replication-metrics"> Replication metrics </h2> <table> <thead> <tr> <th> V1 metric </th> <th style="text-align:left"> Equivalent V2 PromQL </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td> bdb_replicaof_syncer_ingress_bytes </td> <td style="text-align:left"> <code> rate(replica_src_ingress_bytes[1m]) </code> </td> <td style="text-align:left"> Rate of compressed incoming network traffic to a Replica Of database (bytes/sec) </td> </tr> <tr> <td> bdb_replicaof_syncer_ingress_bytes_decompressed </td> <td style="text-align:left"> <code> rate(replica_src_ingress_bytes_decompressed[1m]) </code> </td> <td style="text-align:left"> Rate of decompressed incoming network traffic to a Replica Of database (bytes/sec) </td> </tr> <tr> <td> bdb_replicaof_syncer_local_ingress_lag_time </td> <td style="text-align:left"> <code> database_syncer_lag_ms{syncer_type="replicaof"} </code> </td> <td style="text-align:left"> Lag time between the source and the destination for Replica Of traffic (ms) </td> </tr> <tr> <td> bdb_replicaof_syncer_status </td> <td style="text-align:left"> <code> database_syncer_current_status{syncer_type="replicaof"} </code> </td> <td style="text-align:left"> Syncer status for Replica Of traffic; 0 = in-sync, 1 = syncing, 2 = out of sync </td> </tr> <tr> <td> bdb_crdt_syncer_ingress_bytes </td> <td style="text-align:left"> <code> rate(crdt_src_ingress_bytes[1m]) </code> </td> <td style="text-align:left"> Rate of compressed incoming network traffic to CRDB (bytes/sec) </td> </tr> <tr> <td> bdb_crdt_syncer_ingress_bytes_decompressed </td> <td style="text-align:left"> <code> rate(crdt_src_ingress_bytes_decompressed[1m]) </code> </td> <td style="text-align:left"> Rate of decompressed incoming network traffic to CRDB (bytes/sec) </td> </tr> <tr> <td> bdb_crdt_syncer_local_ingress_lag_time </td> <td style="text-align:left"> <code> database_syncer_lag_ms{syncer_type="crdt"} </code> </td> <td style="text-align:left"> Lag time between the source and the destination (ms) for CRDB traffic </td> </tr> <tr> <td> bdb_crdt_syncer_status </td> <td style="text-align:left"> <code> database_syncer_current_status{syncer_type="crdt"} </code> </td> <td style="text-align:left"> Syncer status for CRDB traffic; 0 = in-sync, 1 = syncing, 2 = out of sync </td> </tr> </tbody> </table> <h2 id="shard-metrics"> Shard metrics </h2> <table> <thead> <tr> <th> V1 metric </th> <th style="text-align:left"> Equivalent V2 PromQL </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td> redis_active_defrag_running </td> <td style="text-align:left"> <code> redis_server_active_defrag_running </code> </td> <td style="text-align:left"> Automatic memory defragmentation current aggressiveness (% cpu) </td> </tr> <tr> <td> redis_allocator_active </td> <td style="text-align:left"> <code> redis_server_allocator_active </code> </td> <td style="text-align:left"> Total used memory, including external fragmentation </td> </tr> <tr> <td> redis_allocator_allocated </td> <td style="text-align:left"> <code> redis_server_allocator_allocated </code> </td> <td style="text-align:left"> Total allocated memory </td> </tr> <tr> <td> redis_allocator_resident </td> <td style="text-align:left"> <code> redis_server_allocator_resident </code> </td> <td style="text-align:left"> Total resident memory (RSS) </td> </tr> <tr> <td> redis_aof_last_cow_size </td> <td style="text-align:left"> <code> redis_server_aof_last_cow_size </code> </td> <td style="text-align:left"> Last AOFR, CopyOnWrite memory </td> </tr> <tr> <td> redis_aof_rewrite_in_progress </td> <td style="text-align:left"> <code> redis_server_aof_rewrite_in_progress </code> </td> <td style="text-align:left"> The number of simultaneous AOF rewrites that are in progress </td> </tr> <tr> <td> redis_aof_rewrites </td> <td style="text-align:left"> <code> redis_server_aof_rewrites </code> </td> <td style="text-align:left"> Number of AOF rewrites this process executed </td> </tr> <tr> <td> redis_aof_delayed_fsync </td> <td style="text-align:left"> <code> redis_server_aof_delayed_fsync </code> </td> <td style="text-align:left"> Number of times an AOF fsync caused delays in the main Redis thread (inducing latency); this can indicate that the disk is slow or overloaded </td> </tr> <tr> <td> redis_blocked_clients </td> <td style="text-align:left"> <code> redis_server_blocked_clients </code> </td> <td style="text-align:left"> Count the clients waiting on a blocking call </td> </tr> <tr> <td> redis_connected_clients </td> <td style="text-align:left"> <code> redis_server_connected_clients </code> </td> <td style="text-align:left"> Number of client connections to the specific shard </td> </tr> <tr> <td> redis_connected_slaves </td> <td style="text-align:left"> <code> redis_server_connected_slaves </code> </td> <td style="text-align:left"> Number of connected replicas </td> </tr> <tr> <td> redis_db0_avg_ttl </td> <td style="text-align:left"> <code> redis_server_db0_avg_ttl </code> </td> <td style="text-align:left"> Average TTL of all volatile keys </td> </tr> <tr> <td> redis_db0_expires </td> <td style="text-align:left"> <code> redis_server_expired_keys </code> </td> <td style="text-align:left"> Total count of volatile keys </td> </tr> <tr> <td> redis_db0_keys </td> <td style="text-align:left"> <code> redis_server_db0_keys </code> </td> <td style="text-align:left"> Total key count </td> </tr> <tr> <td> redis_evicted_keys </td> <td style="text-align:left"> <code> redis_server_evicted_keys </code> </td> <td style="text-align:left"> Keys evicted so far (since restart) </td> </tr> <tr> <td> redis_expire_cycle_cpu_milliseconds </td> <td style="text-align:left"> <code> redis_server_expire_cycle_cpu_milliseconds </code> </td> <td style="text-align:left"> The cumulative amount of time spent on active expiry cycles </td> </tr> <tr> <td> redis_expired_keys </td> <td style="text-align:left"> <code> redis_server_expired_keys </code> </td> <td style="text-align:left"> Keys expired so far (since restart) </td> </tr> <tr> <td> redis_forwarding_state </td> <td style="text-align:left"> <code> redis_server_forwarding_state </code> </td> <td style="text-align:left"> Shard forwarding state (on or off) </td> </tr> <tr> <td> redis_keys_trimmed </td> <td style="text-align:left"> <code> redis_server_keys_trimmed </code> </td> <td style="text-align:left"> The number of keys that were trimmed in the current or last resharding process </td> </tr> <tr> <td> redis_keyspace_read_hits </td> <td style="text-align:left"> <code> redis_server_keyspace_read_hits </code> </td> <td style="text-align:left"> Number of read operations accessing an existing keyspace </td> </tr> <tr> <td> redis_keyspace_read_misses </td> <td style="text-align:left"> <code> redis_server_keyspace_read_misses </code> </td> <td style="text-align:left"> Number of read operations accessing a non-existing keyspace </td> </tr> <tr> <td> redis_keyspace_write_hits </td> <td style="text-align:left"> <code> redis_server_keyspace_write_hits </code> </td> <td style="text-align:left"> Number of write operations accessing an existing keyspace </td> </tr> <tr> <td> redis_keyspace_write_misses </td> <td style="text-align:left"> <code> redis_server_keyspace_write_misses </code> </td> <td style="text-align:left"> Number of write operations accessing a non-existing keyspace </td> </tr> <tr> <td> redis_master_link_status </td> <td style="text-align:left"> <code> redis_server_master_link_status </code> </td> <td style="text-align:left"> Indicates if the replica is connected to its master </td> </tr> <tr> <td> redis_master_repl_offset </td> <td style="text-align:left"> <code> redis_server_master_repl_offset </code> </td> <td style="text-align:left"> Number of bytes sent to replicas by the shard; calculate the throughput for a time period by comparing the value at different times </td> </tr> <tr> <td> redis_master_sync_in_progress </td> <td style="text-align:left"> <code> redis_server_master_sync_in_progress </code> </td> <td style="text-align:left"> The master shard is synchronizing (1 true </td> </tr> <tr> <td> redis_max_process_mem </td> <td style="text-align:left"> <code> redis_server_max_process_mem </code> </td> <td style="text-align:left"> Current memory limit configured by redis_mgr according to node free memory </td> </tr> <tr> <td> redis_maxmemory </td> <td style="text-align:left"> <code> redis_server_maxmemory </code> </td> <td style="text-align:left"> Current memory limit configured by redis_mgr according to database memory limits </td> </tr> <tr> <td> redis_mem_aof_buffer </td> <td style="text-align:left"> <code> redis_server_mem_aof_buffer </code> </td> <td style="text-align:left"> Current size of AOF buffer </td> </tr> <tr> <td> redis_mem_clients_normal </td> <td style="text-align:left"> <code> redis_server_mem_clients_normal </code> </td> <td style="text-align:left"> Current memory used for input and output buffers of non-replica clients </td> </tr> <tr> <td> redis_mem_clients_slaves </td> <td style="text-align:left"> <code> redis_server_mem_clients_slaves </code> </td> <td style="text-align:left"> Current memory used for input and output buffers of replica clients </td> </tr> <tr> <td> redis_mem_fragmentation_ratio </td> <td style="text-align:left"> <code> redis_server_mem_fragmentation_ratio </code> </td> <td style="text-align:left"> Memory fragmentation ratio (1.3 means 30% overhead) </td> </tr> <tr> <td> redis_mem_not_counted_for_evict </td> <td style="text-align:left"> <code> redis_server_mem_not_counted_for_evict </code> </td> <td style="text-align:left"> Portion of used_memory (in bytes) that's not counted for eviction and OOM error </td> </tr> <tr> <td> redis_mem_replication_backlog </td> <td style="text-align:left"> <code> redis_server_mem_replication_backlog </code> </td> <td style="text-align:left"> Size of replication backlog </td> </tr> <tr> <td> redis_module_fork_in_progress </td> <td style="text-align:left"> <code> redis_server_module_fork_in_progress </code> </td> <td style="text-align:left"> A binary value that indicates if there is an active fork spawned by a module (1) or not (0) </td> </tr> <tr> <td> redis_process_cpu_system_seconds_total </td> <td style="text-align:left"> <code> namedprocess_namegroup_cpu_seconds_total{mode="system"} </code> </td> <td style="text-align:left"> Shard process system CPU time spent in seconds </td> </tr> <tr> <td> redis_process_cpu_usage_percent </td> <td style="text-align:left"> <code> namedprocess_namegroup_cpu_seconds_total{mode=~"system|user"} </code> </td> <td style="text-align:left"> Shard process CPU usage percentage </td> </tr> <tr> <td> redis_process_cpu_user_seconds_total </td> <td style="text-align:left"> <code> namedprocess_namegroup_cpu_seconds_total{mode="user"} </code> </td> <td style="text-align:left"> Shard user CPU time spent in seconds </td> </tr> <tr> <td> redis_process_main_thread_cpu_system_seconds_total </td> <td style="text-align:left"> <code> namedprocess_namegroup_thread_cpu_seconds_total{mode="system",threadname="redis-server"} </code> </td> <td style="text-align:left"> Shard main thread system CPU time spent in seconds </td> </tr> <tr> <td> redis_process_main_thread_cpu_user_seconds_total </td> <td style="text-align:left"> <code> namedprocess_namegroup_thread_cpu_seconds_total{mode="user",threadname="redis-server"} </code> </td> <td style="text-align:left"> Shard main thread user CPU time spent in seconds </td> </tr> <tr> <td> redis_process_max_fds </td> <td style="text-align:left"> <code> max(namedprocess_namegroup_open_filedesc) </code> </td> <td style="text-align:left"> Shard maximum number of open file descriptors </td> </tr> <tr> <td> redis_process_open_fds </td> <td style="text-align:left"> <code> namedprocess_namegroup_open_filedesc </code> </td> <td style="text-align:left"> Shard number of open file descriptors </td> </tr> <tr> <td> redis_process_resident_memory_bytes </td> <td style="text-align:left"> <code> namedprocess_namegroup_memory_bytes{memtype="resident"} </code> </td> <td style="text-align:left"> Shard resident memory size in bytes </td> </tr> <tr> <td> redis_process_start_time_seconds </td> <td style="text-align:left"> <code> namedprocess_namegroup_oldest_start_time_seconds </code> </td> <td style="text-align:left"> Shard start time of the process since unix epoch in seconds </td> </tr> <tr> <td> redis_process_virtual_memory_bytes </td> <td style="text-align:left"> <code> namedprocess_namegroup_memory_bytes{memtype="virtual"} </code> </td> <td style="text-align:left"> Shard virtual memory in bytes </td> </tr> <tr> <td> redis_rdb_bgsave_in_progress </td> <td style="text-align:left"> <code> redis_server_rdb_bgsave_in_progress </code> </td> <td style="text-align:left"> Indication if bgsave is currently in progress </td> </tr> <tr> <td> redis_rdb_last_cow_size </td> <td style="text-align:left"> <code> redis_server_rdb_last_cow_size </code> </td> <td style="text-align:left"> Last bgsave (or SYNC fork) used CopyOnWrite memory </td> </tr> <tr> <td> redis_rdb_saves </td> <td style="text-align:left"> <code> redis_server_rdb_saves </code> </td> <td style="text-align:left"> Total count of bgsaves since the process was restarted (including replica fullsync and persistence) </td> </tr> <tr> <td> redis_repl_touch_bytes </td> <td style="text-align:left"> <code> redis_server_repl_touch_bytes </code> </td> <td style="text-align:left"> Number of bytes sent to replicas as TOUCH commands by the shard as a result of a READ command that was processed; calculate the throughput for a time period by comparing the value at different times </td> </tr> <tr> <td> redis_total_commands_processed </td> <td style="text-align:left"> <code> redis_server_total_commands_processed </code> </td> <td style="text-align:left"> Number of commands processed by the shard; calculate the number of commands for a time period by comparing the value at different times </td> </tr> <tr> <td> redis_total_connections_received </td> <td style="text-align:left"> <code> redis_server_total_connections_received </code> </td> <td style="text-align:left"> Number of connections received by the shard; calculate the number of connections for a time period by comparing the value at different times </td> </tr> <tr> <td> redis_total_net_input_bytes </td> <td style="text-align:left"> <code> redis_server_total_net_input_bytes </code> </td> <td style="text-align:left"> Number of bytes received by the shard; calculate the throughput for a time period by comparing the value at different times </td> </tr> <tr> <td> redis_total_net_output_bytes </td> <td style="text-align:left"> <code> redis_server_total_net_output_bytes </code> </td> <td style="text-align:left"> Number of bytes sent by the shard; calculate the throughput for a time period by comparing the value at different times </td> </tr> <tr> <td> redis_up </td> <td style="text-align:left"> <code> redis_server_up </code> </td> <td style="text-align:left"> Shard is up and running </td> </tr> <tr> <td> redis_used_memory </td> <td style="text-align:left"> <code> redis_server_used_memory </code> </td> <td style="text-align:left"> Memory used by shard (in BigRedis this includes flash) (bytes) </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/integrate/prometheus-with-redis-enterprise/prometheus-metrics-v1-to-v2/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/installing-upgrading/install/customize-install-directories/.html

<section class="prose w-full py-12 max-w-none"> <h1> Customize installation directories </h1> Customize Redis Enterprise Software installation directories. When you install Redis Enterprise Software on Red Hat Enterprise Linux, you can customize the installation directories. The files are installed in the <code> redislabs </code> directory located in the path that you specify. <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> <ul> <li> When you install with custom directories, the installation does not run as an RPM file. </li> <li> If a <code> redislabs </code> directory already exists in the path that you specify, the installation fails. </li> <li> All nodes in a cluster must be installed with the same file locations. </li> <li> Custom installation directories are not supported for databases using Auto Tiering. </li> </ul> </div> </div> You can specify these file locations: <table> <thead> <tr> <th> Files </th> <th> Installer flag </th> <th> Example parameter </th> <th> Example file location </th> </tr> </thead> <tbody> <tr> <td> Binaries files </td> <td> --install-dir </td> <td> /opt </td> <td> /opt/redislabs </td> </tr> <tr> <td> Configuration files </td> <td> --config-dir </td> <td> /etc/opt </td> <td> /etc/opt/redislabs </td> </tr> <tr> <td> Data and log files </td> <td> --var-dir </td> <td> /var/opt </td> <td> /var/opt/redislabs </td> </tr> </tbody> </table> These files are not in the custom directories: <ul> <li> OS files <ul> <li> /etc/cron.d/redislabs </li> <li> /etc/firewalld/services </li> <li> /etc/firewalld/services/redislabs-clients.xml </li> <li> /etc/firewalld/services/redislabs.xml </li> <li> /etc/ld.so.conf.d/redislabs_ldconfig.conf.tmpl </li> <li> /etc/logrotate.d/redislabs </li> <li> /etc/profile.d/redislabs_env.sh </li> <li> /usr/lib/systemd/system/rlec_supervisor.service.tmpl </li> <li> /usr/share/selinux/mls/redislabs.pp </li> <li> /usr/share/selinux/targeted/redislabs.pp </li> </ul> </li> <li> Installation reference files <ul> <li> /etc/opt/redislabs/redislabs_custom_install_version </li> <li> /etc/opt/redislabs/redislabs_env_config.sh </li> </ul> </li> </ul> To specify directories during <a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/install-on-linux/"> installation </a> , include installer flags as <a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/install-script/"> command-line options </a> when you run the <code> install.sh </code> script. For example: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">sudo ./install.sh --install-dir <path> --config-dir <path> --var-dir <path> </code></pre> </div> <h2 id="limitations"> Limitations </h2> Several Redis Enterprise Software installation reference files are installed to the directory <code> /etc/opt/redislabs/ </code> even if you use custom installation directories. As a workaround to install Redis Enterprise Software without using any root directories, do the following before installing Redis Enterprise Software: <ol> <li> Create all custom, non-root directories you want to use with Redis Enterprise Software. </li> <li> Mount <code> /etc/opt/redislabs </code> to one of the custom, non-root directories. </li> </ol> <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/installing-upgrading/install/customize-install-directories/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/kubernetes/reference/redis_enterprise_cluster_api/.html

<section class="prose w-full py-12 max-w-none"> <h1> RedisEnterpriseCluster API Reference </h1> apiVersion: <ul> <li> <a href="#appredislabscomv1"> app.redislabs.com/v1 </a> </li> </ul> <h1 id="appredislabscomv1"> app.redislabs.com/v1 </h1> RedisEnterpriseCluster is the Schema for the redisenterpriseclusters API <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> apiVersion </td> <td> string </td> <td> app.redislabs.com/v1 </td> <td> true </td> </tr> <tr> <td> kind </td> <td> string </td> <td> RedisEnterpriseCluster </td> <td> true </td> </tr> <tr> <td> <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta"> metadata </a> </td> <td> object </td> <td> Refer to the Kubernetes API documentation for the fields of the `metadata` field. </td> <td> true </td> </tr> <tr> <td> <a href="#spec"> spec </a> </td> <td> object </td> <td> RedisEnterpriseClusterSpec defines the desired state of RedisEnterpriseCluster </td> <td> false </td> </tr> <tr> <td> <a href="#status"> status </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="spec"> spec </h3> <a href="#"> ↩ Parent </a> RedisEnterpriseClusterSpec defines the desired state of RedisEnterpriseCluster <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specactiveactive"> activeActive </a> </td> <td> object </td> <td> Specification for ActiveActive setup. At most one of ingressOrRouteSpec or activeActive fields can be set at the same time. </td> <td> false </td> </tr> <tr> <td> antiAffinityAdditionalTopologyKeys </td> <td> []string </td> <td> Additional antiAffinity terms in order to support installation on different zones/vcenters </td> <td> false </td> </tr> <tr> <td> <a href="#specbackup"> backup </a> </td> <td> object </td> <td> Cluster-wide backup configurations </td> <td> false </td> </tr> <tr> <td> <a href="#specbootstrapperimagespec"> bootstrapperImageSpec </a> </td> <td> object </td> <td> Specification for Bootstrapper container image </td> <td> false </td> </tr> <tr> <td> <a href="#specbootstrapperresources"> bootstrapperResources </a> </td> <td> object </td> <td> Compute resource requirements for bootstrapper containers </td> <td> false </td> </tr> <tr> <td> <a href="#speccertificates"> certificates </a> </td> <td> object </td> <td> RS Cluster Certificates. Used to modify the certificates used by the cluster. See the "RSClusterCertificates" struct described above to see the supported certificates. </td> <td> false </td> </tr> <tr> <td> clusterCredentialSecretName </td> <td> string </td> <td> Secret Name/Path to use for Cluster Credentials. To be used only if ClusterCredentialSecretType is vault. If left blank, will use cluster name. </td> <td> false </td> </tr> <tr> <td> clusterCredentialSecretRole </td> <td> string </td> <td> Used only if ClusterCredentialSecretType is vault, to define vault role to be used. If blank, defaults to "redis-enterprise-operator" </td> <td> false </td> </tr> <tr> <td> clusterCredentialSecretType </td> <td> enum </td> <td> Type of Secret to use for ClusterCredential, Vault, Kuberetes,... If left blank, will default ot kubernetes secrets Enum : vault, kubernetes </td> <td> false </td> </tr> <tr> <td> clusterRecovery </td> <td> boolean </td> <td> ClusterRecovery initiates cluster recovery when set to true. Note that this field is cleared automatically after the cluster is recovered </td> <td> false </td> </tr> <tr> <td> <a href="#speccontainertimezone"> containerTimezone </a> </td> <td> object </td> <td> Container timezone configuration. While the default timezone on all containers is UTC, this setting can be used to set the timezone on services rigger/bootstrapper/RS containers. You can either propagate the hosts timezone to RS pods or set it manually via timezoneName. </td> <td> false </td> </tr> <tr> <td> createServiceAccount </td> <td> boolean </td> <td> Whether to create service account </td> <td> false </td> </tr> <tr> <td> dataInternodeEncryption </td> <td> boolean </td> <td> Internode encryption (INE) cluster wide policy. An optional boolean setting. Specifies if INE should be on/off for new created REDBs. May be overridden for specific REDB via similar setting, please view the similar setting for REDB for more info. </td> <td> false </td> </tr> <tr> <td> encryptPkeys </td> <td> boolean </td> <td> Private key encryption Possible values: true/false </td> <td> false </td> </tr> <tr> <td> enforceIPv4 </td> <td> boolean </td> <td> Sets ENFORCE_IPV4 environment variable </td> <td> false </td> </tr> <tr> <td> <a href="#specextraenvvars"> extraEnvVars </a> </td> <td> []object </td> <td> ADVANCED USAGE: use carefully. Add environment variables to RS StatefulSet's containers. </td> <td> false </td> </tr> <tr> <td> extraLabels </td> <td> map[string]string </td> <td> Labels that the user defines for their convenience </td> <td> false </td> </tr> <tr> <td> <a href="#spechostaliases"> hostAliases </a> </td> <td> []object </td> <td> Adds hostAliases entries to the Redis Enterprise pods </td> <td> false </td> </tr> <tr> <td> <a href="#specingressorroutespec"> ingressOrRouteSpec </a> </td> <td> object </td> <td> Access configurations for the Redis Enterprise Cluster and Databases. At most one of ingressOrRouteSpec or activeActive fields can be set at the same time. </td> <td> false </td> </tr> <tr> <td> <a href="#specldap"> ldap </a> </td> <td> object </td> <td> Cluster-level LDAP configuration, such as server addresses, protocol, authentication and query settings. </td> <td> false </td> </tr> <tr> <td> license </td> <td> string </td> <td> Redis Enterprise License </td> <td> false </td> </tr> <tr> <td> licenseSecretName </td> <td> string </td> <td> K8s secret or Vault Secret Name/Path to use for Cluster License. When left blank, the license is read from the "license" field. Note that you can't specify non-empty values in both "license" and "licenseSecretName", only one of these fields can be used to pass the license string. The license needs to be stored under the key "license". </td> <td> false </td> </tr> <tr> <td> nodeSelector </td> <td> map[string]string </td> <td> Selector for nodes that could fit Redis Enterprise pod </td> <td> false </td> </tr> <tr> <td> nodes </td> <td> integer </td> <td> Number of Redis Enterprise nodes (pods) Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specocspconfiguration"> ocspConfiguration </a> </td> <td> object </td> <td> An API object that represents the cluster's OCSP configuration. To enable OCSP, the cluster's proxy certificate should contain the OCSP responder URL. </td> <td> false </td> </tr> <tr> <td> <a href="#specpersistentspec"> persistentSpec </a> </td> <td> object </td> <td> Specification for Redis Enterprise Cluster persistence </td> <td> false </td> </tr> <tr> <td> podAnnotations </td> <td> map[string]string </td> <td> annotations for the service rigger and redis enterprise pods </td> <td> false </td> </tr> <tr> <td> <a href="#specpodantiaffinity"> podAntiAffinity </a> </td> <td> object </td> <td> Override for the default anti-affinity rules of the Redis Enterprise pods. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#an-example-of-a-pod-that-uses-pod-affinity </td> <td> false </td> </tr> <tr> <td> podSecurityPolicyName </td> <td> string </td> <td> DEPRECATED PodSecurityPolicy support is removed in Kubernetes v1.25 and the use of this field is invalid for use when running on Kubernetes v1.25+. Future versions of the RedisEnterpriseCluster API will remove support for this field altogether. For migration instructions, see https://kubernetes.io/docs/tasks/configure-pod-container/migrate-from-psp/ Name of pod security policy to use on pods </td> <td> false </td> </tr> <tr> <td> <a href="#specpodstartingpolicy"> podStartingPolicy </a> </td> <td> object </td> <td> Mitigation setting for STS pods stuck in "ContainerCreating" </td> <td> false </td> </tr> <tr> <td> <a href="#specpodtolerations"> podTolerations </a> </td> <td> []object </td> <td> Tolerations that are added to all managed pods. More information: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ </td> <td> false </td> </tr> <tr> <td> priorityClassName </td> <td> string </td> <td> Adds the priority class to pods managed by the operator </td> <td> false </td> </tr> <tr> <td> <a href="#specpullsecrets"> pullSecrets </a> </td> <td> []object </td> <td> PullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ </td> <td> false </td> </tr> <tr> <td> rackAwarenessNodeLabel </td> <td> string </td> <td> Node label that specifies rack ID - if specified, will create rack aware cluster. Rack awareness requires node label must exist on all nodes. Additionally, operator needs a special cluster role with permission to list nodes. </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributes"> redisEnterpriseAdditionalPodSpecAttributes </a> </td> <td> object </td> <td> ADVANCED USAGE USE AT YOUR OWN RISK - specify pod attributes that are required for the statefulset - Redis Enterprise pods. Pod attributes managed by the operator might override these settings. Also make sure the attributes are supported by the K8s version running on the cluster - the operator does not validate that. </td> <td> false </td> </tr> <tr> <td> redisEnterpriseIPFamily </td> <td> enum </td> <td> Reserved, future use, only for use if instructed by Redis. IPFamily dictates what IP family to choose for pods' internal and external communication. Enum : IPv4, IPv6 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseimagespec"> redisEnterpriseImageSpec </a> </td> <td> object </td> <td> Specification for Redis Enterprise container image </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterprisenoderesources"> redisEnterpriseNodeResources </a> </td> <td> object </td> <td> Compute resource requirements for Redis Enterprise containers </td> <td> false </td> </tr> <tr> <td> redisEnterprisePodAnnotations </td> <td> map[string]string </td> <td> annotations for redis enterprise pod </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseservicesconfiguration"> redisEnterpriseServicesConfiguration </a> </td> <td> object </td> <td> RS Cluster optional services settings </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseservicesriggerimagespec"> redisEnterpriseServicesRiggerImageSpec </a> </td> <td> object </td> <td> Specification for Services Rigger container image </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseservicesriggerresources"> redisEnterpriseServicesRiggerResources </a> </td> <td> object </td> <td> Compute resource requirements for Services Rigger pod </td> <td> false </td> </tr> <tr> <td> redisEnterpriseTerminationGracePeriodSeconds </td> <td> integer </td> <td> The TerminationGracePeriodSeconds value for the (STS created) REC pods Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterprisevolumemounts"> redisEnterpriseVolumeMounts </a> </td> <td> []object </td> <td> additional volume mounts within the redis enterprise containers. More info: https://kubernetes.io/docs/concepts/storage/volumes/ </td> <td> false </td> </tr> <tr> <td> <a href="#specredisonflashspec"> redisOnFlashSpec </a> </td> <td> object </td> <td> Stores configurations specific to redis on flash. If provided, the cluster will be capable of creating redis on flash databases. </td> <td> false </td> </tr> <tr> <td> redisUpgradePolicy </td> <td> enum </td> <td> Redis upgrade policy to be set on the Redis Enterprise Cluster. Possible values: major/latest This value is used by the cluster to choose the Redis version of the database when an upgrade is performed. The Redis Enterprise Cluster includes multiple versions of OSS Redis that can be used for databases. Enum : major, latest </td> <td> false </td> </tr> <tr> <td> resp3Default </td> <td> boolean </td> <td> Whether databases will turn on RESP3 compatibility upon database upgrade. Note - Deleting this property after explicitly setting its value shall have no effect. Please view the corresponding field in RS doc for more info. </td> <td> false </td> </tr> <tr> <td> serviceAccountName </td> <td> string </td> <td> Name of the service account to use </td> <td> false </td> </tr> <tr> <td> <a href="#specservices"> services </a> </td> <td> object </td> <td> Customization options for operator-managed service resources created for Redis Enterprise clusters and databases </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspec"> servicesRiggerSpec </a> </td> <td> object </td> <td> Specification for service rigger </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspec"> sideContainersSpec </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specslaveha"> slaveHA </a> </td> <td> object </td> <td> Slave high availability mechanism configuration. </td> <td> false </td> </tr> <tr> <td> uiAnnotations </td> <td> map[string]string </td> <td> Annotations for Redis Enterprise UI service. This annotations will override the overlapping global annotations set under spec.services.servicesAnnotations The specified annotations will not override annotations that already exist and didn't originate from the operator, except for the 'redis.io/last-keys' annotation which is reserved. </td> <td> false </td> </tr> <tr> <td> uiServiceType </td> <td> enum </td> <td> Type of service used to expose Redis Enterprise UI (https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types) Enum : ClusterIP, NodePort, LoadBalancer, ExternalName </td> <td> false </td> </tr> <tr> <td> <a href="#specupgradespec"> upgradeSpec </a> </td> <td> object </td> <td> Specification for upgrades of Redis Enterprise </td> <td> false </td> </tr> <tr> <td> username </td> <td> string </td> <td> Username for the admin user of Redis Enterprise </td> <td> false </td> </tr> <tr> <td> vaultCASecret </td> <td> string </td> <td> K8s secret name containing Vault's CA cert - defaults to "vault-ca-cert" </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumes"> volumes </a> </td> <td> []object </td> <td> additional volumes </td> <td> false </td> </tr> </tbody> </table> <h3 id="specactiveactive"> spec.activeActive </h3> <a href="#spec"> ↩ Parent </a> Specification for ActiveActive setup. At most one of ingressOrRouteSpec or activeActive fields can be set at the same time. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> apiIngressUrl </td> <td> string </td> <td> RS API URL </td> <td> true </td> </tr> <tr> <td> dbIngressSuffix </td> <td> string </td> <td> DB ENDPOINT SUFFIX - will be used to set the db host. ingress <db name=""> <db ingress="" suffix=""> Creates a host name so it should be unique if more than one db is created on the cluster with the same name </db> </db> </td> <td> true </td> </tr> <tr> <td> method </td> <td> enum </td> <td> Used to distinguish between different platforms implementation Enum : openShiftRoute, ingress </td> <td> true </td> </tr> <tr> <td> ingressAnnotations </td> <td> map[string]string </td> <td> Used for ingress controllers such as ha-proxy or nginx in GKE </td> <td> false </td> </tr> </tbody> </table> <h3 id="specbackup"> spec.backup </h3> <a href="#spec"> ↩ Parent </a> Cluster-wide backup configurations <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specbackups3"> s3 </a> </td> <td> object </td> <td> Configurations for backups to s3 and s3-compatible storage </td> <td> false </td> </tr> </tbody> </table> <h3 id="specbackups3"> spec.backup.s3 </h3> <a href="#specbackup"> ↩ Parent </a> Configurations for backups to s3 and s3-compatible storage <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> caCertificateSecretName </td> <td> string </td> <td> Secret name that holds the S3 CA certificate, which contains the TLS certificate mapped to the key in the secret 'cert' </td> <td> false </td> </tr> <tr> <td> url </td> <td> string </td> <td> Specifies the URL for S3 export and import </td> <td> false </td> </tr> </tbody> </table> <h3 id="specbootstrapperimagespec"> spec.bootstrapperImageSpec </h3> <a href="#spec"> ↩ Parent </a> Specification for Bootstrapper container image <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> digestHash </td> <td> string </td> <td> The digest hash of the container image to pull. When specified, the container image is pulled according to the digest hash instead of the image tag. The versionTag field must also be specified with the image tag matching this digest hash. Note: This field is only supported for OLM deployments. </td> <td> false </td> </tr> <tr> <td> imagePullPolicy </td> <td> string </td> <td> The image pull policy to be applied to the container image. One of Always, Never, IfNotPresent. </td> <td> false </td> </tr> <tr> <td> repository </td> <td> string </td> <td> The repository (name) of the container image to be deployed. </td> <td> false </td> </tr> <tr> <td> versionTag </td> <td> string </td> <td> The tag of the container image to be deployed. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specbootstrapperresources"> spec.bootstrapperResources </h3> <a href="#spec"> ↩ Parent </a> Compute resource requirements for bootstrapper containers <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specbootstrapperresourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ </td> <td> false </td> </tr> </tbody> </table> <h3 id="specbootstrapperresourcesclaims"> spec.bootstrapperResources.claims[] </h3> <a href="#specbootstrapperresources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="speccertificates"> spec.certificates </h3> <a href="#spec"> ↩ Parent </a> RS Cluster Certificates. Used to modify the certificates used by the cluster. See the "RSClusterCertificates" struct described above to see the supported certificates. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> apiCertificateSecretName </td> <td> string </td> <td> Secret name to use for cluster's API certificate. If left blank, a cluster-provided certificate will be used. </td> <td> false </td> </tr> <tr> <td> cmCertificateSecretName </td> <td> string </td> <td> Secret name to use for cluster's CM (Cluster Manager) certificate. If left blank, a cluster-provided certificate will be used. </td> <td> false </td> </tr> <tr> <td> ldapClientCertificateSecretName </td> <td> string </td> <td> Secret name to use for cluster's LDAP client certificate. If left blank, LDAP client certificate authentication will be disabled. </td> <td> false </td> </tr> <tr> <td> metricsExporterCertificateSecretName </td> <td> string </td> <td> Secret name to use for cluster's Metrics Exporter certificate. If left blank, a cluster-provided certificate will be used. </td> <td> false </td> </tr> <tr> <td> proxyCertificateSecretName </td> <td> string </td> <td> Secret name to use for cluster's Proxy certificate. If left blank, a cluster-provided certificate will be used. </td> <td> false </td> </tr> <tr> <td> syncerCertificateSecretName </td> <td> string </td> <td> Secret name to use for cluster's Syncer certificate. If left blank, a cluster-provided certificate will be used. </td> <td> false </td> </tr> </tbody> </table> <h3 id="speccontainertimezone"> spec.containerTimezone </h3> <a href="#spec"> ↩ Parent </a> Container timezone configuration. While the default timezone on all containers is UTC, this setting can be used to set the timezone on services rigger/bootstrapper/RS containers. You can either propagate the hosts timezone to RS pods or set it manually via timezoneName. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> propagateHost </td> <td> object </td> <td> Identifies that container timezone should be in sync with the host, this option mounts a hostPath volume onto RS pods that could be restricted in some systems. </td> <td> false </td> </tr> <tr> <td> timezoneName </td> <td> string </td> <td> POSIX-style timezone name as a string to be passed as EnvVar to RE pods, e.g. "Europe/London". </td> <td> false </td> </tr> </tbody> </table> <h3 id="specextraenvvars"> spec.extraEnvVars[] </h3> <a href="#spec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specextraenvvarsvaluefrom"> valueFrom </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specextraenvvarsvaluefrom"> spec.extraEnvVars[].valueFrom </h3> <a href="#specextraenvvars"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specextraenvvarsvaluefromconfigmapkeyref"> configMapKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specextraenvvarsvaluefromfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specextraenvvarsvaluefromresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specextraenvvarsvaluefromsecretkeyref"> secretKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specextraenvvarsvaluefromconfigmapkeyref"> spec.extraEnvVars[].valueFrom.configMapKeyRef </h3> <a href="#specextraenvvarsvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specextraenvvarsvaluefromfieldref"> spec.extraEnvVars[].valueFrom.fieldRef </h3> <a href="#specextraenvvarsvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specextraenvvarsvaluefromresourcefieldref"> spec.extraEnvVars[].valueFrom.resourceFieldRef </h3> <a href="#specextraenvvarsvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specextraenvvarsvaluefromsecretkeyref"> spec.extraEnvVars[].valueFrom.secretKeyRef </h3> <a href="#specextraenvvarsvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="spechostaliases"> spec.hostAliases[] </h3> <a href="#spec"> ↩ Parent </a> HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> hostnames </td> <td> []string </td> <td> Hostnames for the above IP address. </td> <td> false </td> </tr> <tr> <td> ip </td> <td> string </td> <td> IP address of the host file entry. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specingressorroutespec"> spec.ingressOrRouteSpec </h3> <a href="#spec"> ↩ Parent </a> Access configurations for the Redis Enterprise Cluster and Databases. At most one of ingressOrRouteSpec or activeActive fields can be set at the same time. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> apiFqdnUrl </td> <td> string </td> <td> RS API URL </td> <td> true </td> </tr> <tr> <td> dbFqdnSuffix </td> <td> string </td> <td> DB ENDPOINT SUFFIX - will be used to set the db host ingress <db name=""> <db fqdn="" suffix=""> . Creates a host name so it should be unique if more than one db is created on the cluster with the same name </db> </db> </td> <td> true </td> </tr> <tr> <td> method </td> <td> enum </td> <td> Used to distinguish between different platforms implementation. Enum : openShiftRoute, ingress, istio </td> <td> true </td> </tr> <tr> <td> ingressAnnotations </td> <td> map[string]string </td> <td> Additional annotations to set on ingress resources created by the operator </td> <td> false </td> </tr> </tbody> </table> <h3 id="specldap"> spec.ldap </h3> <a href="#spec"> ↩ Parent </a> Cluster-level LDAP configuration, such as server addresses, protocol, authentication and query settings. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specldapauthenticationquery"> authenticationQuery </a> </td> <td> object </td> <td> Configuration of authentication queries, mapping between the username, provided to the cluster for authentication, and the LDAP Distinguished Name. </td> <td> true </td> </tr> <tr> <td> <a href="#specldapauthorizationquery"> authorizationQuery </a> </td> <td> object </td> <td> Configuration of authorization queries, mapping between a user's Distinguished Name and its group memberships. </td> <td> true </td> </tr> <tr> <td> protocol </td> <td> enum </td> <td> Specifies the LDAP protocol to use. One of: LDAP, LDAPS, STARTTLS. Enum : LDAP, LDAPS, STARTTLS </td> <td> true </td> </tr> <tr> <td> <a href="#specldapservers"> servers </a> </td> <td> []object </td> <td> One or more LDAP servers. If multiple servers are specified, they must all share an identical organization tree structure. </td> <td> true </td> </tr> <tr> <td> bindCredentialsSecretName </td> <td> string </td> <td> Name of a secret within the same namespace, holding the credentials used to communicate with the LDAP server for authentication queries. The secret must have a key named 'dn' with the Distinguished Name of the user to execute the query, and 'password' with its password. If left blank, credentials-based authentication is disabled. </td> <td> false </td> </tr> <tr> <td> caCertificateSecretName </td> <td> string </td> <td> Name of a secret within the same namespace, holding a PEM-encoded CA certificate for validating the TLS connection to the LDAP server. The secret must have a key named 'cert' with the certificate data. This field is applicable only when the protocol is LDAPS or STARTTLS. </td> <td> false </td> </tr> <tr> <td> cacheTTLSeconds </td> <td> integer </td> <td> The maximum TTL of cached entries. </td> <td> false </td> </tr> <tr> <td> enabledForControlPlane </td> <td> boolean </td> <td> Whether to enable LDAP for control plane access. Disabled by default. </td> <td> false </td> </tr> <tr> <td> enabledForDataPlane </td> <td> boolean </td> <td> Whether to enable LDAP for data plane access. Disabled by default. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specldapauthenticationquery"> spec.ldap.authenticationQuery </h3> <a href="#specldap"> ↩ Parent </a> Configuration of authentication queries, mapping between the username, provided to the cluster for authentication, and the LDAP Distinguished Name. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specldapauthenticationqueryquery"> query </a> </td> <td> object </td> <td> Configuration for a search query. Mutually exclusive with the 'template' field. The substring '%u' in the query filter will be replaced with the username. </td> <td> false </td> </tr> <tr> <td> template </td> <td> string </td> <td> Configuration for a template query. Mutually exclusive with the 'query' field. The substring '%u' will be replaced with the username, e.g., 'cn=%u,ou=dev,dc=example,dc=com'. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specldapauthenticationqueryquery"> spec.ldap.authenticationQuery.query </h3> <a href="#specldapauthenticationquery"> ↩ Parent </a> Configuration for a search query. Mutually exclusive with the 'template' field. The substring '%u' in the query filter will be replaced with the username. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> base </td> <td> string </td> <td> The Distinguished Name of the entry at which to start the search, e.g., 'ou=dev,dc=example,dc=com'. </td> <td> true </td> </tr> <tr> <td> filter </td> <td> string </td> <td> An RFC-4515 string representation of the filter to apply in the search. For an authentication query, the substring '%u' will be replaced with the username, e.g., '(cn=%u)'. For an authorization query, the substring '%D' will be replaced with the user's Distinguished Name, e.g., '(members=%D)'. </td> <td> true </td> </tr> <tr> <td> scope </td> <td> enum </td> <td> The search scope for an LDAP query. One of: BaseObject, SingleLevel, WholeSubtree Enum : BaseObject, SingleLevel, WholeSubtree </td> <td> true </td> </tr> </tbody> </table> <h3 id="specldapauthorizationquery"> spec.ldap.authorizationQuery </h3> <a href="#specldap"> ↩ Parent </a> Configuration of authorization queries, mapping between a user's Distinguished Name and its group memberships. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> attribute </td> <td> string </td> <td> Configuration for an attribute query. Mutually exclusive with the 'query' field. Holds the name of an attribute of the LDAP user entity that contains a list of the groups that the user belongs to, e.g., 'memberOf'. </td> <td> false </td> </tr> <tr> <td> <a href="#specldapauthorizationqueryquery"> query </a> </td> <td> object </td> <td> Configuration for a search query. Mutually exclusive with the 'attribute' field. The substring '%D' in the query filter will be replaced with the user's Distinguished Name. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specldapauthorizationqueryquery"> spec.ldap.authorizationQuery.query </h3> <a href="#specldapauthorizationquery"> ↩ Parent </a> Configuration for a search query. Mutually exclusive with the 'attribute' field. The substring '%D' in the query filter will be replaced with the user's Distinguished Name. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> base </td> <td> string </td> <td> The Distinguished Name of the entry at which to start the search, e.g., 'ou=dev,dc=example,dc=com'. </td> <td> true </td> </tr> <tr> <td> filter </td> <td> string </td> <td> An RFC-4515 string representation of the filter to apply in the search. For an authentication query, the substring '%u' will be replaced with the username, e.g., '(cn=%u)'. For an authorization query, the substring '%D' will be replaced with the user's Distinguished Name, e.g., '(members=%D)'. </td> <td> true </td> </tr> <tr> <td> scope </td> <td> enum </td> <td> The search scope for an LDAP query. One of: BaseObject, SingleLevel, WholeSubtree Enum : BaseObject, SingleLevel, WholeSubtree </td> <td> true </td> </tr> </tbody> </table> <h3 id="specldapservers"> spec.ldap.servers[] </h3> <a href="#specldap"> ↩ Parent </a> Address of an LDAP server. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> host </td> <td> string </td> <td> Host name of the LDAP server </td> <td> true </td> </tr> <tr> <td> port </td> <td> integer </td> <td> Port number of the LDAP server. If unspecified, defaults to 389 for LDAP and STARTTLS protocols, and 636 for LDAPS protocol. Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specocspconfiguration"> spec.ocspConfiguration </h3> <a href="#spec"> ↩ Parent </a> An API object that represents the cluster's OCSP configuration. To enable OCSP, the cluster's proxy certificate should contain the OCSP responder URL. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> ocspFunctionality </td> <td> boolean </td> <td> Whether to enable/disable OCSP mechanism for the cluster. </td> <td> false </td> </tr> <tr> <td> queryFrequency </td> <td> integer </td> <td> Determines the interval (in seconds) in which the control plane will poll the OCSP responder for a new status for the server certificate. Minimum value is 60. Maximum value is 86400. </td> <td> false </td> </tr> <tr> <td> recoveryFrequency </td> <td> integer </td> <td> Determines the interval (in seconds) in which the control plane will poll the OCSP responder for a new status for the server certificate when the current staple is invalid. Minimum value is 60. Maximum value is 86400. </td> <td> false </td> </tr> <tr> <td> recoveryMaxTries </td> <td> integer </td> <td> Determines the maximum number for the OCSP recovery attempts. After max number of tries passed, the control plane will revert back to the regular frequency. Minimum value is 1. Maximum value is 100. </td> <td> false </td> </tr> <tr> <td> responseTimeout </td> <td> integer </td> <td> Determines the time interval (in seconds) for which the request waits for a response from the OCSP responder. Minimum value is 1. Maximum value is 60. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpersistentspec"> spec.persistentSpec </h3> <a href="#spec"> ↩ Parent </a> Specification for Redis Enterprise Cluster persistence <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enablePersistentVolumeResize </td> <td> boolean </td> <td> Whether to enable PersistentVolumes resize. Disabled by default. Read the instruction in pvc_expansion readme carefully before using this feature. </td> <td> false </td> </tr> <tr> <td> enabled </td> <td> boolean </td> <td> Whether to add persistent volume to Redis Enterprise pods </td> <td> false </td> </tr> <tr> <td> storageClassName </td> <td> string </td> <td> Storage class for persistent volume in Redis Enterprise pods. Leave empty to use the default. If using the default this way, make sure the Kubernetes Cluster has a default Storage Class configured. This can be done by running a `kubectl get storageclass` and see if one of the Storage Classes' names contains a `(default)` mark. </td> <td> false </td> </tr> <tr> <td> volumeSize </td> <td> int or string </td> <td> To enable resizing after creating the cluster - please follow the instructions in the pvc_expansion readme </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinity"> spec.podAntiAffinity </h3> <a href="#spec"> ↩ Parent </a> Override for the default anti-affinity rules of the Redis Enterprise pods. More info: <a href="https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#an-example-of-a-pod-that-uses-pod-affinity"> https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#an-example-of-a-pod-that-uses-pod-affinity </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecution"> preferredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specpodantiaffinityrequiredduringschedulingignoredduringexecution"> requiredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinitypreferredduringschedulingignoredduringexecution"> spec.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specpodantiaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> podAffinityTerm </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> weight </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> </tbody> </table> <h3 id="specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> spec.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm </h3> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> spec.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector </h3> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> spec.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] </h3> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> spec.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector </h3> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> spec.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] </h3> <a href="#specpodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinityrequiredduringschedulingignoredduringexecution"> spec.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specpodantiaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specpodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specpodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> spec.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector </h3> <a href="#specpodantiaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specpodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> spec.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] </h3> <a href="#specpodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> spec.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector </h3> <a href="#specpodantiaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specpodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> spec.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] </h3> <a href="#specpodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpodstartingpolicy"> spec.podStartingPolicy </h3> <a href="#spec"> ↩ Parent </a> Mitigation setting for STS pods stuck in "ContainerCreating" <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> Whether to detect and attempt to mitigate pod startup issues </td> <td> true </td> </tr> <tr> <td> startingThresholdSeconds </td> <td> integer </td> <td> Time in seconds to wait for a pod to be stuck while starting up before action is taken. If set to 0, will be treated as if disabled. Format : int32 </td> <td> true </td> </tr> </tbody> </table> <h3 id="specpodtolerations"> spec.podTolerations[] </h3> <a href="#spec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> effect </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> key </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> tolerationSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specpullsecrets"> spec.pullSecrets[] </h3> <a href="#spec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> Secret name </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributes"> spec.redisEnterpriseAdditionalPodSpecAttributes </h3> <a href="#spec"> ↩ Parent </a> ADVANCED USAGE USE AT YOUR OWN RISK - specify pod attributes that are required for the statefulset - Redis Enterprise pods. Pod attributes managed by the operator might override these settings. Also make sure the attributes are supported by the K8s version running on the cluster - the operator does not validate that. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> activeDeadlineSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinity"> affinity </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> automountServiceAccountToken </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesdnsconfig"> dnsConfig </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> dnsPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> enableServiceLinks </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ephemeralContainers </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributeshostaliases"> hostAliases </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> hostIPC </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> hostNetwork </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> hostPID </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> hostUsers </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> hostname </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesimagepullsecrets"> imagePullSecrets </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> initContainers </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> nodeName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> nodeSelector </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesos"> os </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> overhead </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> preemptionPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> priority </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> priorityClassName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesreadinessgates"> readinessGates </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesresourceclaims"> resourceClaims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> restartPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> runtimeClassName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> schedulerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesschedulinggates"> schedulingGates </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributessecuritycontext"> securityContext </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> serviceAccount </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> serviceAccountName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> setHostnameAsFQDN </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> shareProcessNamespace </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> subdomain </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributestolerations"> tolerations </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributestopologyspreadconstraints"> topologySpreadConstraints </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> volumes </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinity"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinity"> nodeAffinity </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinity"> podAffinity </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinity"> podAntiAffinity </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitynodeaffinity"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.nodeAffinity </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecution"> preferredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecution"> requiredDuringSchedulingIgnoredDuringExecution </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecution"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference"> preference </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> weight </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfields"> matchFields </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfields"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecution"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms"> nodeSelectorTerms </a> </td> <td> []object </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfields"> matchFields </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfields"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinity"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecution"> preferredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecution"> requiredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecution"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> podAffinityTerm </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> weight </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecution"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinity"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution"> preferredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution"> requiredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> podAffinityTerm </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> weight </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesdnsconfig"> spec.redisEnterpriseAdditionalPodSpecAttributes.dnsConfig </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> nameservers </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesdnsconfigoptions"> options </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> searches </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesdnsconfigoptions"> spec.redisEnterpriseAdditionalPodSpecAttributes.dnsConfig.options[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesdnsconfig"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainers"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> args </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenv"> env </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvfrom"> envFrom </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> image </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> imagePullPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycle"> lifecycle </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobe"> livenessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersports"> ports </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobe"> readinessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersresources"> resources </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontext"> securityContext </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobe"> startupProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> stdin </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> stdinOnce </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> targetContainerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> tty </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersvolumedevices"> volumeDevices </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersvolumemounts"> volumeMounts </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> workingDir </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersenv"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].env[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefrom"> valueFrom </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefrom"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenv"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefromconfigmapkeyref"> configMapKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefromfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefromresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefromsecretkeyref"> secretKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefromconfigmapkeyref"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom.configMapKeyRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefromfieldref"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom.fieldRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefromresourcefieldref"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom.resourceFieldRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefromsecretkeyref"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom.secretKeyRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersenvfrom"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].envFrom[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvfromconfigmapref"> configMapRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> prefix </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvfromsecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersenvfromconfigmapref"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].envFrom[].configMapRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersenvfromsecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].envFrom[].secretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycle"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststart"> postStart </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestop"> preStop </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststart"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststartexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststarttcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststartexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststarttcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestop"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestopexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestophttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestoptcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestopexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestophttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestophttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestophttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestophttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestoptcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobe"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobeexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobegrpc"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.grpc </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobehttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobehttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobetcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersports"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].ports[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> containerPort </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> hostIP </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostPort </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> protocol </td> <td> string </td> <td> Default : TCP </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobe"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobeexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobegrpc"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.grpc </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobehttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobehttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobetcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersresources"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].resources </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersresourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersresourcesclaims"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].resources.claims[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersresources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontext"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].securityContext </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> allowPrivilegeEscalation </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontextcapabilities"> capabilities </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> privileged </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> procMount </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnlyRootFilesystem </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsGroup </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> runAsNonRoot </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUser </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontextselinuxoptions"> seLinuxOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontextseccompprofile"> seccompProfile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontextwindowsoptions"> windowsOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontextcapabilities"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].securityContext.capabilities </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> add </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> drop </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontextselinuxoptions"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].securityContext.seLinuxOptions </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> level </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> role </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontextseccompprofile"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].securityContext.seccompProfile </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> type </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> localhostProfile </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontextwindowsoptions"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].securityContext.windowsOptions </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gmsaCredentialSpec </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> gmsaCredentialSpecName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostProcess </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUserName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobe"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobeexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobegrpc"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.grpc </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobehttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobehttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobetcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersvolumedevices"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].volumeDevices[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> devicePath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesephemeralcontainersvolumemounts"> spec.redisEnterpriseAdditionalPodSpecAttributes.ephemeralContainers[].volumeMounts[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> mountPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mountPropagation </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> subPath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> subPathExpr </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributeshostaliases"> spec.redisEnterpriseAdditionalPodSpecAttributes.hostAliases[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> hostnames </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> ip </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesimagepullsecrets"> spec.redisEnterpriseAdditionalPodSpecAttributes.imagePullSecrets[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainers"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> args </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenv"> env </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvfrom"> envFrom </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> image </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> imagePullPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycle"> lifecycle </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobe"> livenessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersports"> ports </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobe"> readinessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersresources"> resources </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontext"> securityContext </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobe"> startupProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> stdin </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> stdinOnce </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> tty </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersvolumedevices"> volumeDevices </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersvolumemounts"> volumeMounts </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> workingDir </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersenv"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].env[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefrom"> valueFrom </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefrom"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].env[].valueFrom </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenv"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefromconfigmapkeyref"> configMapKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefromfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefromresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefromsecretkeyref"> secretKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefromconfigmapkeyref"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].env[].valueFrom.configMapKeyRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefromfieldref"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].env[].valueFrom.fieldRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefromresourcefieldref"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].env[].valueFrom.resourceFieldRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefromsecretkeyref"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].env[].valueFrom.secretKeyRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersenvfrom"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].envFrom[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvfromconfigmapref"> configMapRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> prefix </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvfromsecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersenvfromconfigmapref"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].envFrom[].configMapRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersenvfromsecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].envFrom[].secretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecycle"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststart"> postStart </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestop"> preStop </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststart"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststartexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststarthttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststarttcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststartexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststarthttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststarthttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststarthttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststarthttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststarttcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestop"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestopexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestophttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestoptcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestopexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestophttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestophttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestophttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestophttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestoptcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobe"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].livenessProbe </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobeexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].livenessProbe.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobegrpc"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].livenessProbe.grpc </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobehttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].livenessProbe.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobehttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].livenessProbe.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobetcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].livenessProbe.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersports"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].ports[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> containerPort </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> hostIP </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostPort </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> protocol </td> <td> string </td> <td> Default : TCP </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobe"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].readinessProbe </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobeexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].readinessProbe.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobegrpc"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].readinessProbe.grpc </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobehttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].readinessProbe.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobehttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].readinessProbe.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobetcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].readinessProbe.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersresources"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].resources </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersresourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersresourcesclaims"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].resources.claims[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersresources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontext"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].securityContext </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> allowPrivilegeEscalation </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontextcapabilities"> capabilities </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> privileged </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> procMount </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnlyRootFilesystem </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsGroup </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> runAsNonRoot </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUser </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontextselinuxoptions"> seLinuxOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontextseccompprofile"> seccompProfile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontextwindowsoptions"> windowsOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontextcapabilities"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].securityContext.capabilities </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> add </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> drop </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontextselinuxoptions"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].securityContext.seLinuxOptions </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> level </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> role </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontextseccompprofile"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].securityContext.seccompProfile </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> type </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> localhostProfile </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontextwindowsoptions"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].securityContext.windowsOptions </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gmsaCredentialSpec </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> gmsaCredentialSpecName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostProcess </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUserName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobe"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].startupProbe </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobeexec"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].startupProbe.exec </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobegrpc"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].startupProbe.grpc </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobehttpget"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].startupProbe.httpGet </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobehttpgethttpheaders"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].startupProbe.httpGet.httpHeaders[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobetcpsocket"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].startupProbe.tcpSocket </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersvolumedevices"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].volumeDevices[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> devicePath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesinitcontainersvolumemounts"> spec.redisEnterpriseAdditionalPodSpecAttributes.initContainers[].volumeMounts[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> mountPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mountPropagation </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> subPath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> subPathExpr </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesos"> spec.redisEnterpriseAdditionalPodSpecAttributes.os </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesreadinessgates"> spec.redisEnterpriseAdditionalPodSpecAttributes.readinessGates[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> conditionType </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesresourceclaims"> spec.redisEnterpriseAdditionalPodSpecAttributes.resourceClaims[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesresourceclaimssource"> source </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesresourceclaimssource"> spec.redisEnterpriseAdditionalPodSpecAttributes.resourceClaims[].source </h3> <a href="#specredisenterpriseadditionalpodspecattributesresourceclaims"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resourceClaimName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> resourceClaimTemplateName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesschedulinggates"> spec.redisEnterpriseAdditionalPodSpecAttributes.schedulingGates[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributessecuritycontext"> spec.redisEnterpriseAdditionalPodSpecAttributes.securityContext </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fsGroup </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> fsGroupChangePolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsGroup </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> runAsNonRoot </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUser </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributessecuritycontextselinuxoptions"> seLinuxOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributessecuritycontextseccompprofile"> seccompProfile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> supplementalGroups </td> <td> []integer </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributessecuritycontextsysctls"> sysctls </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributessecuritycontextwindowsoptions"> windowsOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributessecuritycontextselinuxoptions"> spec.redisEnterpriseAdditionalPodSpecAttributes.securityContext.seLinuxOptions </h3> <a href="#specredisenterpriseadditionalpodspecattributessecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> level </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> role </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributessecuritycontextseccompprofile"> spec.redisEnterpriseAdditionalPodSpecAttributes.securityContext.seccompProfile </h3> <a href="#specredisenterpriseadditionalpodspecattributessecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> type </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> localhostProfile </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributessecuritycontextsysctls"> spec.redisEnterpriseAdditionalPodSpecAttributes.securityContext.sysctls[] </h3> <a href="#specredisenterpriseadditionalpodspecattributessecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributessecuritycontextwindowsoptions"> spec.redisEnterpriseAdditionalPodSpecAttributes.securityContext.windowsOptions </h3> <a href="#specredisenterpriseadditionalpodspecattributessecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gmsaCredentialSpec </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> gmsaCredentialSpecName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostProcess </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUserName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributestolerations"> spec.redisEnterpriseAdditionalPodSpecAttributes.tolerations[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> effect </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> key </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> tolerationSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributestopologyspreadconstraints"> spec.redisEnterpriseAdditionalPodSpecAttributes.topologySpreadConstraints[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> maxSkew </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> whenUnsatisfiable </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributestopologyspreadconstraintslabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabelKeys </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> minDomains </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> nodeAffinityPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> nodeTaintsPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributestopologyspreadconstraintslabelselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.topologySpreadConstraints[].labelSelector </h3> <a href="#specredisenterpriseadditionalpodspecattributestopologyspreadconstraints"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributestopologyspreadconstraintslabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributestopologyspreadconstraintslabelselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.topologySpreadConstraints[].labelSelector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributestopologyspreadconstraintslabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumes"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[] </h3> <a href="#specredisenterpriseadditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesawselasticblockstore"> awsElasticBlockStore </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesazuredisk"> azureDisk </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesazurefile"> azureFile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumescephfs"> cephfs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumescinder"> cinder </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesconfigmap"> configMap </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumescsi"> csi </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesdownwardapi"> downwardAPI </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesemptydir"> emptyDir </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeral"> ephemeral </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesfc"> fc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesflexvolume"> flexVolume </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesflocker"> flocker </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesgcepersistentdisk"> gcePersistentDisk </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesgitrepo"> gitRepo </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesglusterfs"> glusterfs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumeshostpath"> hostPath </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesiscsi"> iscsi </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesnfs"> nfs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumespersistentvolumeclaim"> persistentVolumeClaim </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesphotonpersistentdisk"> photonPersistentDisk </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesportworxvolume"> portworxVolume </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojected"> projected </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesquobyte"> quobyte </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesrbd"> rbd </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesscaleio"> scaleIO </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumessecret"> secret </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesstorageos"> storageos </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesvspherevolume"> vsphereVolume </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesawselasticblockstore"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].awsElasticBlockStore </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumeID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> partition </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesazuredisk"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].azureDisk </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> diskName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> diskURI </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> cachingMode </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> kind </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesazurefile"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].azureFile </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> secretName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> shareName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumescephfs"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].cephfs </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> monitors </td> <td> []string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> secretFile </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumescephfssecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumescephfssecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].cephfs.secretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumescephfs"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumescinder"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].cinder </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumeID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumescindersecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumescindersecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].cinder.secretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumescinder"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesconfigmap"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].configMap </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesconfigmapitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesconfigmapitems"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].configMap.items[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesconfigmap"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumescsi"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].csi </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> driver </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumescsinodepublishsecretref"> nodePublishSecretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeAttributes </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumescsinodepublishsecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].csi.nodePublishSecretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumescsi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesdownwardapi"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].downwardAPI </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesdownwardapiitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesdownwardapiitems"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].downwardAPI.items[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesdownwardapi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesdownwardapiitemsfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesdownwardapiitemsresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesdownwardapiitemsfieldref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].downwardAPI.items[].fieldRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesdownwardapiitemsresourcefieldref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].downwardAPI.items[].resourceFieldRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesemptydir"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].emptyDir </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> medium </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> sizeLimit </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesephemeral"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].ephemeral </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplate"> volumeClaimTemplate </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplate"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeral"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> spec </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> metadata </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplate"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> accessModes </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecdatasource"> dataSource </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecdatasourceref"> dataSourceRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresources"> resources </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselector"> selector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> storageClassName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeMode </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecdatasource"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> kind </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiGroup </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecdatasourceref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> kind </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiGroup </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> namespace </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresources"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.resources </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresourcesclaims"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.resources.claims[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselector"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.selector </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselectormatchexpressions"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesfc"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].fc </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> lun </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> targetWWNs </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> wwids </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesflexvolume"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].flexVolume </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> driver </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> options </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesflexvolumesecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesflexvolumesecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].flexVolume.secretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesflexvolume"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesflocker"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].flocker </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> datasetName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> datasetUUID </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesgcepersistentdisk"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].gcePersistentDisk </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> pdName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> partition </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesgitrepo"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].gitRepo </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> repository </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> directory </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> revision </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesglusterfs"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].glusterfs </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> endpoints </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumeshostpath"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].hostPath </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesiscsi"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].iscsi </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> iqn </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> lun </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> targetPortal </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> chapAuthDiscovery </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> chapAuthSession </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> initiatorName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> iscsiInterface </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> portals </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesiscsisecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesiscsisecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].iscsi.secretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesiscsi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesnfs"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].nfs </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> server </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumespersistentvolumeclaim"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].persistentVolumeClaim </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> claimName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesphotonpersistentdisk"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].photonPersistentDisk </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> pdID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesportworxvolume"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].portworxVolume </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumeID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojected"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsources"> sources </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsources"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojected"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesconfigmap"> configMap </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapi"> downwardAPI </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcessecret"> secret </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesserviceaccounttoken"> serviceAccountToken </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesconfigmap"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[].configMap </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesconfigmapitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesconfigmapitems"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[].configMap.items[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesconfigmap"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapi"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[].downwardAPI </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapiitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapiitems"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[].downwardAPI.items[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapiitemsfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapiitemsresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapiitemsfieldref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[].downwardAPI.items[].fieldRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapiitemsresourcefieldref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcessecret"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[].secret </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcessecretitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcessecretitems"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[].secret.items[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcessecret"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesprojectedsourcesserviceaccounttoken"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].projected.sources[].serviceAccountToken </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> audience </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> expirationSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesquobyte"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].quobyte </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> registry </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> volume </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> group </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> tenant </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesrbd"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].rbd </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> image </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> monitors </td> <td> []string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> keyring </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> pool </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesrbdsecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesrbdsecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].rbd.secretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesrbd"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesscaleio"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].scaleIO </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gateway </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesscaleiosecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> system </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> protectionDomain </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> sslEnabled </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> storageMode </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> storagePool </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesscaleiosecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].scaleIO.secretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesscaleio"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumessecret"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].secret </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumessecretitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> secretName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumessecretitems"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].secret.items[] </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumessecret"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesstorageos"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].storageos </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseadditionalpodspecattributesvolumesstorageossecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeNamespace </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesstorageossecretref"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].storageos.secretRef </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumesstorageos"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseadditionalpodspecattributesvolumesvspherevolume"> spec.redisEnterpriseAdditionalPodSpecAttributes.volumes[].vsphereVolume </h3> <a href="#specredisenterpriseadditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumePath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> storagePolicyID </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> storagePolicyName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseimagespec"> spec.redisEnterpriseImageSpec </h3> <a href="#spec"> ↩ Parent </a> Specification for Redis Enterprise container image <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> digestHash </td> <td> string </td> <td> The digest hash of the container image to pull. When specified, the container image is pulled according to the digest hash instead of the image tag. The versionTag field must also be specified with the image tag matching this digest hash. Note: This field is only supported for OLM deployments. </td> <td> false </td> </tr> <tr> <td> imagePullPolicy </td> <td> string </td> <td> The image pull policy to be applied to the container image. One of Always, Never, IfNotPresent. </td> <td> false </td> </tr> <tr> <td> repository </td> <td> string </td> <td> The repository (name) of the container image to be deployed. </td> <td> false </td> </tr> <tr> <td> versionTag </td> <td> string </td> <td> The tag of the container image to be deployed. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterprisenoderesources"> spec.redisEnterpriseNodeResources </h3> <a href="#spec"> ↩ Parent </a> Compute resource requirements for Redis Enterprise containers <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterprisenoderesourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterprisenoderesourcesclaims"> spec.redisEnterpriseNodeResources.claims[] </h3> <a href="#specredisenterprisenoderesources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesconfiguration"> spec.redisEnterpriseServicesConfiguration </h3> <a href="#spec"> ↩ Parent </a> RS Cluster optional services settings <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseservicesconfigurationcmserver"> cmServer </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseservicesconfigurationcrdbcoordinator"> crdbCoordinator </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseservicesconfigurationcrdbworker"> crdbWorker </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseservicesconfigurationmdnsserver"> mdnsServer </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseservicesconfigurationpdnsserver"> pdnsServer </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseservicesconfigurationsaslauthd"> saslauthd </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specredisenterpriseservicesconfigurationstatsarchiver"> statsArchiver </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesconfigurationcmserver"> spec.redisEnterpriseServicesConfiguration.cmServer </h3> <a href="#specredisenterpriseservicesconfiguration"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> operatingMode </td> <td> enum </td> <td> Whether to enable/disable the CM server Enum : enabled, disabled </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesconfigurationcrdbcoordinator"> spec.redisEnterpriseServicesConfiguration.crdbCoordinator </h3> <a href="#specredisenterpriseservicesconfiguration"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> operatingMode </td> <td> enum </td> <td> Whether to enable/disable the crdb coordinator process Enum : enabled, disabled </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesconfigurationcrdbworker"> spec.redisEnterpriseServicesConfiguration.crdbWorker </h3> <a href="#specredisenterpriseservicesconfiguration"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> operatingMode </td> <td> enum </td> <td> Whether to enable/disable the crdb worker processes Enum : enabled, disabled </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesconfigurationmdnsserver"> spec.redisEnterpriseServicesConfiguration.mdnsServer </h3> <a href="#specredisenterpriseservicesconfiguration"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> operatingMode </td> <td> enum </td> <td> Whether to enable/disable the Multicast DNS server Enum : enabled, disabled </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesconfigurationpdnsserver"> spec.redisEnterpriseServicesConfiguration.pdnsServer </h3> <a href="#specredisenterpriseservicesconfiguration"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> operatingMode </td> <td> enum </td> <td> Whether to enable/disable the pdns server Enum : enabled, disabled </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesconfigurationsaslauthd"> spec.redisEnterpriseServicesConfiguration.saslauthd </h3> <a href="#specredisenterpriseservicesconfiguration"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> operatingMode </td> <td> enum </td> <td> Whether to enable/disable the saslauthd service Enum : enabled, disabled </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesconfigurationstatsarchiver"> spec.redisEnterpriseServicesConfiguration.statsArchiver </h3> <a href="#specredisenterpriseservicesconfiguration"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> operatingMode </td> <td> enum </td> <td> Whether to enable/disable the stats archiver service Enum : enabled, disabled </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesriggerimagespec"> spec.redisEnterpriseServicesRiggerImageSpec </h3> <a href="#spec"> ↩ Parent </a> Specification for Services Rigger container image <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> digestHash </td> <td> string </td> <td> The digest hash of the container image to pull. When specified, the container image is pulled according to the digest hash instead of the image tag. The versionTag field must also be specified with the image tag matching this digest hash. Note: This field is only supported for OLM deployments. </td> <td> false </td> </tr> <tr> <td> imagePullPolicy </td> <td> string </td> <td> The image pull policy to be applied to the container image. One of Always, Never, IfNotPresent. </td> <td> false </td> </tr> <tr> <td> repository </td> <td> string </td> <td> The repository (name) of the container image to be deployed. </td> <td> false </td> </tr> <tr> <td> versionTag </td> <td> string </td> <td> The tag of the container image to be deployed. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesriggerresources"> spec.redisEnterpriseServicesRiggerResources </h3> <a href="#spec"> ↩ Parent </a> Compute resource requirements for Services Rigger pod <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specredisenterpriseservicesriggerresourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisenterpriseservicesriggerresourcesclaims"> spec.redisEnterpriseServicesRiggerResources.claims[] </h3> <a href="#specredisenterpriseservicesriggerresources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specredisenterprisevolumemounts"> spec.redisEnterpriseVolumeMounts[] </h3> <a href="#spec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> mountPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mountPropagation </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> subPath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> subPathExpr </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specredisonflashspec"> spec.redisOnFlashSpec </h3> <a href="#spec"> ↩ Parent </a> Stores configurations specific to redis on flash. If provided, the cluster will be capable of creating redis on flash databases. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> enabled </td> <td> boolean </td> <td> </td> <td> true </td> </tr> <tr> <td> storageClassName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> bigStoreDriver </td> <td> enum </td> <td> Enum : rocksdb, speedb </td> <td> false </td> </tr> <tr> <td> flashDiskSize </td> <td> int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> flashStorageEngine </td> <td> enum </td> <td> Enum : rocksdb </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservices"> spec.services </h3> <a href="#spec"> ↩ Parent </a> Customization options for operator-managed service resources created for Redis Enterprise clusters and databases <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesapiservice"> apiService </a> </td> <td> object </td> <td> Customization options for the REC API service. </td> <td> false </td> </tr> <tr> <td> servicesAnnotations </td> <td> map[string]string </td> <td> Global additional annotations to set on service resources created by the operator. The specified annotations will not override annotations that already exist and didn't originate from the operator. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesapiservice"> spec.services.apiService </h3> <a href="#specservices"> ↩ Parent </a> Customization options for the REC API service. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> type </td> <td> enum </td> <td> Type of service to create for the REC API service. Defaults to ClusterIP service, if not specified otherwise. Enum : ClusterIP, NodePort, LoadBalancer </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspec"> spec.servicesRiggerSpec </h3> <a href="#spec"> ↩ Parent </a> Specification for service rigger <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> databaseServiceType </td> <td> string </td> <td> Service types for access to databases. should be a comma separated list. The possible values are cluster_ip, headless and load_balancer. </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecextraenvvars"> extraEnvVars </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> podAnnotations </td> <td> map[string]string </td> <td> annotations for the service rigger pod </td> <td> false </td> </tr> <tr> <td> serviceNaming </td> <td> enum </td> <td> Used to determine how to name the services created automatically when a database is created. When bdb_name is used, the database name will be also used for the service name. When redis-port is used, the service will be named redis- <port> . Enum : bdb_name, redis-port </port> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> servicesRiggerAdditionalPodSpecAttributes </a> </td> <td> object </td> <td> ADVANCED USAGE USE AT YOUR OWN RISK - specify pod attributes that are required for the rigger deployment pod. Pod attributes managed by the operator might override these settings (Containers, serviceAccountName, podTolerations, ImagePullSecrets, nodeSelector, PriorityClassName, PodSecurityContext). Also make sure the attributes are supported by the K8s version running on the cluster - the operator does not validate that. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecextraenvvars"> spec.servicesRiggerSpec.extraEnvVars[] </h3> <a href="#specservicesriggerspec"> ↩ Parent </a> EnvVar represents an environment variable present in a Container. More info: <a href="https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/"> https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/ </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> Name of the environment variable. </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecextraenvvarsvaluefrom"> valueFrom </a> </td> <td> object </td> <td> Source for the environment variable's value. Cannot be used if value is not empty. </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecextraenvvarsvaluefrom"> spec.servicesRiggerSpec.extraEnvVars[].valueFrom </h3> <a href="#specservicesriggerspecextraenvvars"> ↩ Parent </a> Source for the environment variable's value. Cannot be used if value is not empty. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecextraenvvarsvaluefromconfigmapkeyref"> configMapKeyRef </a> </td> <td> object </td> <td> Selects a key of a ConfigMap. </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecextraenvvarsvaluefromfieldref"> fieldRef </a> </td> <td> object </td> <td> Selects a field of the pod </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecextraenvvarsvaluefromresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> Selects a resource of the container: only resources limits and requests are currently supported. </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecextraenvvarsvaluefromsecretkeyref"> secretKeyRef </a> </td> <td> object </td> <td> Selects a key of a secret in the pod's namespace </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecextraenvvarsvaluefromconfigmapkeyref"> spec.servicesRiggerSpec.extraEnvVars[].valueFrom.configMapKeyRef </h3> <a href="#specservicesriggerspecextraenvvarsvaluefrom"> ↩ Parent </a> Selects a key of a ConfigMap. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> The key to select. </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> Name of the referent </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> Specify whether the ConfigMap or its key must be defined </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecextraenvvarsvaluefromfieldref"> spec.servicesRiggerSpec.extraEnvVars[].valueFrom.fieldRef </h3> <a href="#specservicesriggerspecextraenvvarsvaluefrom"> ↩ Parent </a> Selects a field of the pod <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> Path of the field to select in the specified API version. </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> Version of the schema the FieldPath is written in terms of, defaults to "v1". </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecextraenvvarsvaluefromresourcefieldref"> spec.servicesRiggerSpec.extraEnvVars[].valueFrom.resourceFieldRef </h3> <a href="#specservicesriggerspecextraenvvarsvaluefrom"> ↩ Parent </a> Selects a resource of the container: only resources limits and requests are currently supported. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> Required: resource to select </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> Container name: required for volumes, optional for env vars </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> Specifies the output format of the exposed resources, defaults to "1" </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecextraenvvarsvaluefromsecretkeyref"> spec.servicesRiggerSpec.extraEnvVars[].valueFrom.secretKeyRef </h3> <a href="#specservicesriggerspecextraenvvarsvaluefrom"> ↩ Parent </a> Selects a key of a secret in the pod's namespace <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> The key of the secret to select from. Must be a valid secret key. </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> Name of the referent </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> Specify whether the Secret or its key must be defined </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributes"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes </h3> <a href="#specservicesriggerspec"> ↩ Parent </a> ADVANCED USAGE USE AT YOUR OWN RISK - specify pod attributes that are required for the rigger deployment pod. Pod attributes managed by the operator might override these settings (Containers, serviceAccountName, podTolerations, ImagePullSecrets, nodeSelector, PriorityClassName, PodSecurityContext). Also make sure the attributes are supported by the K8s version running on the cluster - the operator does not validate that. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> activeDeadlineSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinity"> affinity </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> automountServiceAccountToken </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesdnsconfig"> dnsConfig </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> dnsPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> enableServiceLinks </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ephemeralContainers </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributeshostaliases"> hostAliases </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> hostIPC </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> hostNetwork </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> hostPID </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> hostUsers </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> hostname </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesimagepullsecrets"> imagePullSecrets </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> initContainers </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> nodeName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> nodeSelector </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesos"> os </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> overhead </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> preemptionPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> priority </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> priorityClassName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesreadinessgates"> readinessGates </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesresourceclaims"> resourceClaims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> restartPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> runtimeClassName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> schedulerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesschedulinggates"> schedulingGates </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontext"> securityContext </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> serviceAccount </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> serviceAccountName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> setHostnameAsFQDN </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> shareProcessNamespace </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> subdomain </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributestolerations"> tolerations </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributestopologyspreadconstraints"> topologySpreadConstraints </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> volumes </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinity"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinity"> nodeAffinity </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinity"> podAffinity </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinity"> podAntiAffinity </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinity"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.nodeAffinity </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecution"> preferredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecution"> requiredDuringSchedulingIgnoredDuringExecution </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecution"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference"> preference </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> weight </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfields"> matchFields </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfields"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecution"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms"> nodeSelectorTerms </a> </td> <td> []object </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfields"> matchFields </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfields"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinity"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecution"> preferredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecution"> requiredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecution"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> podAffinityTerm </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> weight </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecution"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinity"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution"> preferredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution"> requiredDuringSchedulingIgnoredDuringExecution </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> podAffinityTerm </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> weight </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinity"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> namespaceSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> namespaces </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesdnsconfig"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.dnsConfig </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> nameservers </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesdnsconfigoptions"> options </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> searches </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesdnsconfigoptions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.dnsConfig.options[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesdnsconfig"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> args </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenv"> env </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvfrom"> envFrom </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> image </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> imagePullPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycle"> lifecycle </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobe"> livenessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersports"> ports </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobe"> readinessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersresources"> resources </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontext"> securityContext </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobe"> startupProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> stdin </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> stdinOnce </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> targetContainerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> tty </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersvolumedevices"> volumeDevices </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersvolumemounts"> volumeMounts </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> workingDir </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenv"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].env[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefrom"> valueFrom </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefrom"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenv"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefromconfigmapkeyref"> configMapKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefromfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefromresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefromsecretkeyref"> secretKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefromconfigmapkeyref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom.configMapKeyRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefromfieldref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom.fieldRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefromresourcefieldref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom.resourceFieldRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefromsecretkeyref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].env[].valueFrom.secretKeyRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvfrom"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].envFrom[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvfromconfigmapref"> configMapRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> prefix </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvfromsecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvfromconfigmapref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].envFrom[].configMapRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvfromsecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].envFrom[].secretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycle"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststart"> postStart </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestop"> preStop </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststart"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststartexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststarttcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststartexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststarthttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststarttcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.postStart.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestop"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestopexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestophttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestoptcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestopexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestophttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestophttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestophttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestophttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestoptcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].lifecycle.preStop.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobe"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobeexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobegrpc"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.grpc </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobehttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobehttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobetcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].livenessProbe.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersports"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].ports[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> containerPort </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> hostIP </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostPort </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> protocol </td> <td> string </td> <td> Default : TCP </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobe"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobeexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobegrpc"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.grpc </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobehttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobehttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobetcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].readinessProbe.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersresources"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].resources </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersresourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersresourcesclaims"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].resources.claims[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersresources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontext"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].securityContext </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> allowPrivilegeEscalation </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontextcapabilities"> capabilities </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> privileged </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> procMount </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnlyRootFilesystem </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsGroup </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> runAsNonRoot </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUser </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontextselinuxoptions"> seLinuxOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontextseccompprofile"> seccompProfile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontextwindowsoptions"> windowsOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontextcapabilities"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].securityContext.capabilities </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> add </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> drop </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontextselinuxoptions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].securityContext.seLinuxOptions </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> level </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> role </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontextseccompprofile"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].securityContext.seccompProfile </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> type </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> localhostProfile </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontextwindowsoptions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].securityContext.windowsOptions </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gmsaCredentialSpec </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> gmsaCredentialSpecName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostProcess </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUserName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobe"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobeexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobegrpc"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.grpc </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobehttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobehttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobetcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].startupProbe.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersvolumedevices"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].volumeDevices[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> devicePath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainersvolumemounts"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.ephemeralContainers[].volumeMounts[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesephemeralcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> mountPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mountPropagation </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> subPath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> subPathExpr </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributeshostaliases"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.hostAliases[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> hostnames </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> ip </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesimagepullsecrets"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.imagePullSecrets[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> args </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenv"> env </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvfrom"> envFrom </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> image </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> imagePullPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycle"> lifecycle </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobe"> livenessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersports"> ports </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobe"> readinessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersresources"> resources </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontext"> securityContext </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobe"> startupProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> stdin </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> stdinOnce </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> tty </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersvolumedevices"> volumeDevices </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersvolumemounts"> volumeMounts </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> workingDir </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenv"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].env[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefrom"> valueFrom </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefrom"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].env[].valueFrom </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenv"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefromconfigmapkeyref"> configMapKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefromfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefromresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefromsecretkeyref"> secretKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefromconfigmapkeyref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].env[].valueFrom.configMapKeyRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefromfieldref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].env[].valueFrom.fieldRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefromresourcefieldref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].env[].valueFrom.resourceFieldRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefromsecretkeyref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].env[].valueFrom.secretKeyRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvfrom"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].envFrom[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvfromconfigmapref"> configMapRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> prefix </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvfromsecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvfromconfigmapref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].envFrom[].configMapRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvfromsecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].envFrom[].secretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycle"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststart"> postStart </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestop"> preStop </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststart"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststartexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststarthttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststarttcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststartexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststarthttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststarthttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststarthttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststarthttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststarttcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.postStart.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestop"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestopexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestophttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestoptcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestopexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestophttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestophttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestophttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestophttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestoptcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].lifecycle.preStop.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobe"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].livenessProbe </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobeexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].livenessProbe.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobegrpc"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].livenessProbe.grpc </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobehttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].livenessProbe.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobehttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].livenessProbe.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobetcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].livenessProbe.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerslivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersports"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].ports[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> containerPort </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> hostIP </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostPort </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> protocol </td> <td> string </td> <td> Default : TCP </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobe"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].readinessProbe </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobeexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].readinessProbe.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobegrpc"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].readinessProbe.grpc </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobehttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].readinessProbe.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobehttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].readinessProbe.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobetcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].readinessProbe.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersresources"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].resources </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersresourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersresourcesclaims"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].resources.claims[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersresources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontext"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].securityContext </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> allowPrivilegeEscalation </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontextcapabilities"> capabilities </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> privileged </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> procMount </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnlyRootFilesystem </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsGroup </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> runAsNonRoot </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUser </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontextselinuxoptions"> seLinuxOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontextseccompprofile"> seccompProfile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontextwindowsoptions"> windowsOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontextcapabilities"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].securityContext.capabilities </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> add </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> drop </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontextselinuxoptions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].securityContext.seLinuxOptions </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> level </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> role </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontextseccompprofile"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].securityContext.seccompProfile </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> type </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> localhostProfile </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontextwindowsoptions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].securityContext.windowsOptions </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainerssecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gmsaCredentialSpec </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> gmsaCredentialSpecName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostProcess </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUserName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobe"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].startupProbe </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobeexec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].startupProbe.exec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobegrpc"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].startupProbe.grpc </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobehttpget"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].startupProbe.httpGet </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobehttpgethttpheaders"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].startupProbe.httpGet.httpHeaders[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobetcpsocket"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].startupProbe.tcpSocket </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersvolumedevices"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].volumeDevices[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> devicePath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainersvolumemounts"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.initContainers[].volumeMounts[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesinitcontainers"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> mountPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mountPropagation </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> subPath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> subPathExpr </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesos"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.os </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesreadinessgates"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.readinessGates[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> conditionType </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesresourceclaims"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.resourceClaims[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesresourceclaimssource"> source </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesresourceclaimssource"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.resourceClaims[].source </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesresourceclaims"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resourceClaimName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> resourceClaimTemplateName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesschedulinggates"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.schedulingGates[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontext"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.securityContext </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fsGroup </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> fsGroupChangePolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsGroup </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> runAsNonRoot </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUser </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontextselinuxoptions"> seLinuxOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontextseccompprofile"> seccompProfile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> supplementalGroups </td> <td> []integer </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontextsysctls"> sysctls </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontextwindowsoptions"> windowsOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontextselinuxoptions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.securityContext.seLinuxOptions </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> level </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> role </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontextseccompprofile"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.securityContext.seccompProfile </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> type </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> localhostProfile </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontextsysctls"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.securityContext.sysctls[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontextwindowsoptions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.securityContext.windowsOptions </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributessecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gmsaCredentialSpec </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> gmsaCredentialSpecName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostProcess </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUserName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributestolerations"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.tolerations[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> effect </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> key </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> tolerationSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributestopologyspreadconstraints"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.topologySpreadConstraints[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> maxSkew </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> topologyKey </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> whenUnsatisfiable </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributestopologyspreadconstraintslabelselector"> labelSelector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabelKeys </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> minDomains </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> nodeAffinityPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> nodeTaintsPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributestopologyspreadconstraintslabelselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.topologySpreadConstraints[].labelSelector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributestopologyspreadconstraints"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributestopologyspreadconstraintslabelselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributestopologyspreadconstraintslabelselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.topologySpreadConstraints[].labelSelector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributestopologyspreadconstraintslabelselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesawselasticblockstore"> awsElasticBlockStore </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesazuredisk"> azureDisk </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesazurefile"> azureFile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescephfs"> cephfs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescinder"> cinder </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesconfigmap"> configMap </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescsi"> csi </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapi"> downwardAPI </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesemptydir"> emptyDir </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeral"> ephemeral </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesfc"> fc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesflexvolume"> flexVolume </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesflocker"> flocker </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesgcepersistentdisk"> gcePersistentDisk </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesgitrepo"> gitRepo </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesglusterfs"> glusterfs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumeshostpath"> hostPath </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesiscsi"> iscsi </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesnfs"> nfs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumespersistentvolumeclaim"> persistentVolumeClaim </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesphotonpersistentdisk"> photonPersistentDisk </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesportworxvolume"> portworxVolume </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojected"> projected </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesquobyte"> quobyte </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesrbd"> rbd </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesscaleio"> scaleIO </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumessecret"> secret </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesstorageos"> storageos </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesvspherevolume"> vsphereVolume </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesawselasticblockstore"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].awsElasticBlockStore </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumeID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> partition </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesazuredisk"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].azureDisk </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> diskName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> diskURI </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> cachingMode </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> kind </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesazurefile"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].azureFile </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> secretName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> shareName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescephfs"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].cephfs </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> monitors </td> <td> []string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> secretFile </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescephfssecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescephfssecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].cephfs.secretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescephfs"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescinder"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].cinder </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumeID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescindersecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescindersecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].cinder.secretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescinder"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesconfigmap"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].configMap </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesconfigmapitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesconfigmapitems"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].configMap.items[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesconfigmap"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescsi"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].csi </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> driver </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescsinodepublishsecretref"> nodePublishSecretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeAttributes </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescsinodepublishsecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].csi.nodePublishSecretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumescsi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapi"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].downwardAPI </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapiitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapiitems"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].downwardAPI.items[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapiitemsfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapiitemsresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapiitemsfieldref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].downwardAPI.items[].fieldRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapiitemsresourcefieldref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].downwardAPI.items[].resourceFieldRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesemptydir"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].emptyDir </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> medium </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> sizeLimit </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeral"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].ephemeral </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplate"> volumeClaimTemplate </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplate"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeral"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> spec </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> metadata </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplate"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> accessModes </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecdatasource"> dataSource </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecdatasourceref"> dataSourceRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresources"> resources </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselector"> selector </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> storageClassName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeMode </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecdatasource"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> kind </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiGroup </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecdatasourceref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> kind </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiGroup </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> namespace </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresources"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.resources </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresourcesclaims"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.resources.claims[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecresources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselector"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.selector </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselectormatchexpressions"> matchExpressions </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> matchLabels </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselectormatchexpressions"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesephemeralvolumeclaimtemplatespecselector"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> operator </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> values </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesfc"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].fc </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> lun </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> targetWWNs </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> wwids </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesflexvolume"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].flexVolume </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> driver </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> options </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesflexvolumesecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesflexvolumesecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].flexVolume.secretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesflexvolume"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesflocker"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].flocker </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> datasetName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> datasetUUID </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesgcepersistentdisk"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].gcePersistentDisk </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> pdName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> partition </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesgitrepo"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].gitRepo </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> repository </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> directory </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> revision </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesglusterfs"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].glusterfs </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> endpoints </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumeshostpath"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].hostPath </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesiscsi"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].iscsi </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> iqn </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> lun </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> targetPortal </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> chapAuthDiscovery </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> chapAuthSession </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> initiatorName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> iscsiInterface </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> portals </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesiscsisecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesiscsisecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].iscsi.secretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesiscsi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesnfs"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].nfs </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> server </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumespersistentvolumeclaim"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].persistentVolumeClaim </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> claimName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesphotonpersistentdisk"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].photonPersistentDisk </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> pdID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesportworxvolume"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].portworxVolume </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumeID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojected"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsources"> sources </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsources"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojected"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesconfigmap"> configMap </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapi"> downwardAPI </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcessecret"> secret </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesserviceaccounttoken"> serviceAccountToken </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesconfigmap"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[].configMap </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesconfigmapitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesconfigmapitems"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[].configMap.items[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesconfigmap"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapi"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[].downwardAPI </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapiitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapiitems"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[].downwardAPI.items[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapiitemsfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapiitemsresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapiitemsfieldref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[].downwardAPI.items[].fieldRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapiitemsresourcefieldref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcessecret"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[].secret </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcessecretitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcessecretitems"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[].secret.items[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcessecret"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsourcesserviceaccounttoken"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].projected.sources[].serviceAccountToken </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> audience </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> expirationSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesquobyte"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].quobyte </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> registry </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> volume </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> group </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> tenant </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesrbd"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].rbd </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> image </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> monitors </td> <td> []string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> keyring </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> pool </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesrbdsecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesrbdsecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].rbd.secretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesrbd"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesscaleio"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].scaleIO </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gateway </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesscaleiosecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> system </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> protectionDomain </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> sslEnabled </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> storageMode </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> storagePool </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesscaleiosecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].scaleIO.secretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesscaleio"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumessecret"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].secret </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumessecretitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> secretName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumessecretitems"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].secret.items[] </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumessecret"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesstorageos"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].storageos </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesstorageossecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeNamespace </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesstorageossecretref"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].storageos.secretRef </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesstorageos"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specservicesriggerspecservicesriggeradditionalpodspecattributesvolumesvspherevolume"> spec.servicesRiggerSpec.servicesRiggerAdditionalPodSpecAttributes.volumes[].vsphereVolume </h3> <a href="#specservicesriggerspecservicesriggeradditionalpodspecattributesvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumePath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> storagePolicyID </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> storagePolicyName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspec"> spec.sideContainersSpec[] </h3> <a href="#spec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> args </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecenv"> env </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecenvfrom"> envFrom </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> image </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> imagePullPolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclifecycle"> lifecycle </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclivenessprobe"> livenessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecports"> ports </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecreadinessprobe"> readinessProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecresources"> resources </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecsecuritycontext"> securityContext </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecstartupprobe"> startupProbe </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> stdin </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> stdinOnce </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationMessagePolicy </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> tty </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecvolumedevices"> volumeDevices </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecvolumemounts"> volumeMounts </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> workingDir </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecenv"> spec.sideContainersSpec[].env[] </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecenvvaluefrom"> valueFrom </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecenvvaluefrom"> spec.sideContainersSpec[].env[].valueFrom </h3> <a href="#specsidecontainersspecenv"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specsidecontainersspecenvvaluefromconfigmapkeyref"> configMapKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecenvvaluefromfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecenvvaluefromresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecenvvaluefromsecretkeyref"> secretKeyRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecenvvaluefromconfigmapkeyref"> spec.sideContainersSpec[].env[].valueFrom.configMapKeyRef </h3> <a href="#specsidecontainersspecenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecenvvaluefromfieldref"> spec.sideContainersSpec[].env[].valueFrom.fieldRef </h3> <a href="#specsidecontainersspecenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecenvvaluefromresourcefieldref"> spec.sideContainersSpec[].env[].valueFrom.resourceFieldRef </h3> <a href="#specsidecontainersspecenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecenvvaluefromsecretkeyref"> spec.sideContainersSpec[].env[].valueFrom.secretKeyRef </h3> <a href="#specsidecontainersspecenvvaluefrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecenvfrom"> spec.sideContainersSpec[].envFrom[] </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specsidecontainersspecenvfromconfigmapref"> configMapRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> prefix </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecenvfromsecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecenvfromconfigmapref"> spec.sideContainersSpec[].envFrom[].configMapRef </h3> <a href="#specsidecontainersspecenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecenvfromsecretref"> spec.sideContainersSpec[].envFrom[].secretRef </h3> <a href="#specsidecontainersspecenvfrom"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecycle"> spec.sideContainersSpec[].lifecycle </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specsidecontainersspeclifecyclepoststart"> postStart </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclifecycleprestop"> preStop </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecyclepoststart"> spec.sideContainersSpec[].lifecycle.postStart </h3> <a href="#specsidecontainersspeclifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specsidecontainersspeclifecyclepoststartexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclifecyclepoststarthttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclifecyclepoststarttcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecyclepoststartexec"> spec.sideContainersSpec[].lifecycle.postStart.exec </h3> <a href="#specsidecontainersspeclifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecyclepoststarthttpget"> spec.sideContainersSpec[].lifecycle.postStart.httpGet </h3> <a href="#specsidecontainersspeclifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclifecyclepoststarthttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecyclepoststarthttpgethttpheaders"> spec.sideContainersSpec[].lifecycle.postStart.httpGet.httpHeaders[] </h3> <a href="#specsidecontainersspeclifecyclepoststarthttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecyclepoststarttcpsocket"> spec.sideContainersSpec[].lifecycle.postStart.tcpSocket </h3> <a href="#specsidecontainersspeclifecyclepoststart"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecycleprestop"> spec.sideContainersSpec[].lifecycle.preStop </h3> <a href="#specsidecontainersspeclifecycle"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specsidecontainersspeclifecycleprestopexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclifecycleprestophttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclifecycleprestoptcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecycleprestopexec"> spec.sideContainersSpec[].lifecycle.preStop.exec </h3> <a href="#specsidecontainersspeclifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecycleprestophttpget"> spec.sideContainersSpec[].lifecycle.preStop.httpGet </h3> <a href="#specsidecontainersspeclifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclifecycleprestophttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecycleprestophttpgethttpheaders"> spec.sideContainersSpec[].lifecycle.preStop.httpGet.httpHeaders[] </h3> <a href="#specsidecontainersspeclifecycleprestophttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclifecycleprestoptcpsocket"> spec.sideContainersSpec[].lifecycle.preStop.tcpSocket </h3> <a href="#specsidecontainersspeclifecycleprestop"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclivenessprobe"> spec.sideContainersSpec[].livenessProbe </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specsidecontainersspeclivenessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclivenessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclivenessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclivenessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclivenessprobeexec"> spec.sideContainersSpec[].livenessProbe.exec </h3> <a href="#specsidecontainersspeclivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclivenessprobegrpc"> spec.sideContainersSpec[].livenessProbe.grpc </h3> <a href="#specsidecontainersspeclivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclivenessprobehttpget"> spec.sideContainersSpec[].livenessProbe.httpGet </h3> <a href="#specsidecontainersspeclivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspeclivenessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclivenessprobehttpgethttpheaders"> spec.sideContainersSpec[].livenessProbe.httpGet.httpHeaders[] </h3> <a href="#specsidecontainersspeclivenessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specsidecontainersspeclivenessprobetcpsocket"> spec.sideContainersSpec[].livenessProbe.tcpSocket </h3> <a href="#specsidecontainersspeclivenessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecports"> spec.sideContainersSpec[].ports[] </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> containerPort </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> hostIP </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostPort </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> protocol </td> <td> string </td> <td> Default : TCP </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecreadinessprobe"> spec.sideContainersSpec[].readinessProbe </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specsidecontainersspecreadinessprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecreadinessprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecreadinessprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecreadinessprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecreadinessprobeexec"> spec.sideContainersSpec[].readinessProbe.exec </h3> <a href="#specsidecontainersspecreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecreadinessprobegrpc"> spec.sideContainersSpec[].readinessProbe.grpc </h3> <a href="#specsidecontainersspecreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecreadinessprobehttpget"> spec.sideContainersSpec[].readinessProbe.httpGet </h3> <a href="#specsidecontainersspecreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecreadinessprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecreadinessprobehttpgethttpheaders"> spec.sideContainersSpec[].readinessProbe.httpGet.httpHeaders[] </h3> <a href="#specsidecontainersspecreadinessprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecreadinessprobetcpsocket"> spec.sideContainersSpec[].readinessProbe.tcpSocket </h3> <a href="#specsidecontainersspecreadinessprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecresources"> spec.sideContainersSpec[].resources </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specsidecontainersspecresourcesclaims"> claims </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> limits </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> <tr> <td> requests </td> <td> map[string]int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecresourcesclaims"> spec.sideContainersSpec[].resources.claims[] </h3> <a href="#specsidecontainersspecresources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecsecuritycontext"> spec.sideContainersSpec[].securityContext </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> allowPrivilegeEscalation </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecsecuritycontextcapabilities"> capabilities </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> privileged </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> procMount </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnlyRootFilesystem </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsGroup </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> runAsNonRoot </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUser </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecsecuritycontextselinuxoptions"> seLinuxOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecsecuritycontextseccompprofile"> seccompProfile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecsecuritycontextwindowsoptions"> windowsOptions </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecsecuritycontextcapabilities"> spec.sideContainersSpec[].securityContext.capabilities </h3> <a href="#specsidecontainersspecsecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> add </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> drop </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecsecuritycontextselinuxoptions"> spec.sideContainersSpec[].securityContext.seLinuxOptions </h3> <a href="#specsidecontainersspecsecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> level </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> role </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecsecuritycontextseccompprofile"> spec.sideContainersSpec[].securityContext.seccompProfile </h3> <a href="#specsidecontainersspecsecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> type </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> localhostProfile </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecsecuritycontextwindowsoptions"> spec.sideContainersSpec[].securityContext.windowsOptions </h3> <a href="#specsidecontainersspecsecuritycontext"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gmsaCredentialSpec </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> gmsaCredentialSpecName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> hostProcess </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> runAsUserName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecstartupprobe"> spec.sideContainersSpec[].startupProbe </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specsidecontainersspecstartupprobeexec"> exec </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> failureThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecstartupprobegrpc"> grpc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecstartupprobehttpget"> httpGet </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> initialDelaySeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> periodSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> successThreshold </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecstartupprobetcpsocket"> tcpSocket </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> terminationGracePeriodSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> <tr> <td> timeoutSeconds </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecstartupprobeexec"> spec.sideContainersSpec[].startupProbe.exec </h3> <a href="#specsidecontainersspecstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> command </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecstartupprobegrpc"> spec.sideContainersSpec[].startupProbe.grpc </h3> <a href="#specsidecontainersspecstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> service </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecstartupprobehttpget"> spec.sideContainersSpec[].startupProbe.httpGet </h3> <a href="#specsidecontainersspecstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specsidecontainersspecstartupprobehttpgethttpheaders"> httpHeaders </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> scheme </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecstartupprobehttpgethttpheaders"> spec.sideContainersSpec[].startupProbe.httpGet.httpHeaders[] </h3> <a href="#specsidecontainersspecstartupprobehttpget"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> value </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecstartupprobetcpsocket"> spec.sideContainersSpec[].startupProbe.tcpSocket </h3> <a href="#specsidecontainersspecstartupprobe"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> port </td> <td> int or string </td> <td> </td> <td> true </td> </tr> <tr> <td> host </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecvolumedevices"> spec.sideContainersSpec[].volumeDevices[] </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> devicePath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> </tbody> </table> <h3 id="specsidecontainersspecvolumemounts"> spec.sideContainersSpec[].volumeMounts[] </h3> <a href="#specsidecontainersspec"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> mountPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mountPropagation </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> subPath </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> subPathExpr </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specslaveha"> spec.slaveHA </h3> <a href="#spec"> ↩ Parent </a> Slave high availability mechanism configuration. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> slaveHAGracePeriod </td> <td> integer </td> <td> Time in seconds between when a node fails, and when slave high availability mechanism starts relocating shards. If set to 0, will not affect cluster configuration. Format : int32 </td> <td> true </td> </tr> </tbody> </table> <h3 id="specupgradespec"> spec.upgradeSpec </h3> <a href="#spec"> ↩ Parent </a> Specification for upgrades of Redis Enterprise <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> autoUpgradeRedisEnterprise </td> <td> boolean </td> <td> Whether to upgrade Redis Enterprise automatically when operator is upgraded </td> <td> true </td> </tr> </tbody> </table> <h3 id="specvolumes"> spec.volumes[] </h3> <a href="#spec"> ↩ Parent </a> Volume represents a named volume in a pod that may be accessed by any container in the pod. More info: <a href="https://kubernetes.io/docs/concepts/storage/volumes"> https://kubernetes.io/docs/concepts/storage/volumes </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specvolumesawselasticblockstore"> awsElasticBlockStore </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesazuredisk"> azureDisk </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesazurefile"> azureFile </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumescephfs"> cephfs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumescinder"> cinder </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesconfigmap"> configMap </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumescsi"> csi </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesdownwardapi"> downwardAPI </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesemptydir"> emptyDir </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesfc"> fc </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesflexvolume"> flexVolume </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesflocker"> flocker </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesgcepersistentdisk"> gcePersistentDisk </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesgitrepo"> gitRepo </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesglusterfs"> glusterfs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumeshostpath"> hostPath </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesiscsi"> iscsi </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesnfs"> nfs </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumespersistentvolumeclaim"> persistentVolumeClaim </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesphotonpersistentdisk"> photonPersistentDisk </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesportworxvolume"> portworxVolume </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesprojected"> projected </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesquobyte"> quobyte </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesrbd"> rbd </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesscaleio"> scaleIO </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumessecret"> secret </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesstorageos"> storageos </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesvspherevolume"> vsphereVolume </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesawselasticblockstore"> spec.volumes[].awsElasticBlockStore </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumeID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> partition </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesazuredisk"> spec.volumes[].azureDisk </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> diskName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> diskURI </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> cachingMode </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> kind </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesazurefile"> spec.volumes[].azureFile </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> secretName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> shareName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumescephfs"> spec.volumes[].cephfs </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> monitors </td> <td> []string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> secretFile </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumescephfssecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumescephfssecretref"> spec.volumes[].cephfs.secretRef </h3> <a href="#specvolumescephfs"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumescinder"> spec.volumes[].cinder </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumeID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumescindersecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumescindersecretref"> spec.volumes[].cinder.secretRef </h3> <a href="#specvolumescinder"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesconfigmap"> spec.volumes[].configMap </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesconfigmapitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesconfigmapitems"> spec.volumes[].configMap.items[] </h3> <a href="#specvolumesconfigmap"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumescsi"> spec.volumes[].csi </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> driver </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumescsinodepublishsecretref"> nodePublishSecretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeAttributes </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumescsinodepublishsecretref"> spec.volumes[].csi.nodePublishSecretRef </h3> <a href="#specvolumescsi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesdownwardapi"> spec.volumes[].downwardAPI </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesdownwardapiitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesdownwardapiitems"> spec.volumes[].downwardAPI.items[] </h3> <a href="#specvolumesdownwardapi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specvolumesdownwardapiitemsfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesdownwardapiitemsresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesdownwardapiitemsfieldref"> spec.volumes[].downwardAPI.items[].fieldRef </h3> <a href="#specvolumesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesdownwardapiitemsresourcefieldref"> spec.volumes[].downwardAPI.items[].resourceFieldRef </h3> <a href="#specvolumesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesemptydir"> spec.volumes[].emptyDir </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> medium </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> sizeLimit </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesfc"> spec.volumes[].fc </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> lun </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> targetWWNs </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> wwids </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesflexvolume"> spec.volumes[].flexVolume </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> driver </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> options </td> <td> map[string]string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesflexvolumesecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesflexvolumesecretref"> spec.volumes[].flexVolume.secretRef </h3> <a href="#specvolumesflexvolume"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesflocker"> spec.volumes[].flocker </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> datasetName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> datasetUUID </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesgcepersistentdisk"> spec.volumes[].gcePersistentDisk </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> pdName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> partition </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesgitrepo"> spec.volumes[].gitRepo </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> repository </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> directory </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> revision </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesglusterfs"> spec.volumes[].glusterfs </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> endpoints </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumeshostpath"> spec.volumes[].hostPath </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> type </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesiscsi"> spec.volumes[].iscsi </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> iqn </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> lun </td> <td> integer </td> <td> Format : int32 </td> <td> true </td> </tr> <tr> <td> targetPortal </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> chapAuthDiscovery </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> chapAuthSession </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> initiatorName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> iscsiInterface </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> portals </td> <td> []string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesiscsisecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesiscsisecretref"> spec.volumes[].iscsi.secretRef </h3> <a href="#specvolumesiscsi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesnfs"> spec.volumes[].nfs </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> server </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumespersistentvolumeclaim"> spec.volumes[].persistentVolumeClaim </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> claimName </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesphotonpersistentdisk"> spec.volumes[].photonPersistentDisk </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> pdID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesportworxvolume"> spec.volumes[].portworxVolume </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumeID </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojected"> spec.volumes[].projected </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specvolumesprojectedsources"> sources </a> </td> <td> []object </td> <td> </td> <td> true </td> </tr> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsources"> spec.volumes[].projected.sources[] </h3> <a href="#specvolumesprojected"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specvolumesprojectedsourcesconfigmap"> configMap </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesprojectedsourcesdownwardapi"> downwardAPI </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesprojectedsourcessecret"> secret </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesprojectedsourcesserviceaccounttoken"> serviceAccountToken </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsourcesconfigmap"> spec.volumes[].projected.sources[].configMap </h3> <a href="#specvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specvolumesprojectedsourcesconfigmapitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsourcesconfigmapitems"> spec.volumes[].projected.sources[].configMap.items[] </h3> <a href="#specvolumesprojectedsourcesconfigmap"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsourcesdownwardapi"> spec.volumes[].projected.sources[].downwardAPI </h3> <a href="#specvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specvolumesprojectedsourcesdownwardapiitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsourcesdownwardapiitems"> spec.volumes[].projected.sources[].downwardAPI.items[] </h3> <a href="#specvolumesprojectedsourcesdownwardapi"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specvolumesprojectedsourcesdownwardapiitemsfieldref"> fieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesprojectedsourcesdownwardapiitemsresourcefieldref"> resourceFieldRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsourcesdownwardapiitemsfieldref"> spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef </h3> <a href="#specvolumesprojectedsourcesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fieldPath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> apiVersion </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsourcesdownwardapiitemsresourcefieldref"> spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef </h3> <a href="#specvolumesprojectedsourcesdownwardapiitems"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> resource </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> containerName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> divisor </td> <td> int or string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsourcessecret"> spec.volumes[].projected.sources[].secret </h3> <a href="#specvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#specvolumesprojectedsourcessecretitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsourcessecretitems"> spec.volumes[].projected.sources[].secret.items[] </h3> <a href="#specvolumesprojectedsourcessecret"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesprojectedsourcesserviceaccounttoken"> spec.volumes[].projected.sources[].serviceAccountToken </h3> <a href="#specvolumesprojectedsources"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> audience </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> expirationSeconds </td> <td> integer </td> <td> Format : int64 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesquobyte"> spec.volumes[].quobyte </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> registry </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> volume </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> group </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> tenant </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesrbd"> spec.volumes[].rbd </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> image </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> monitors </td> <td> []string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> keyring </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> pool </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesrbdsecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> user </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesrbdsecretref"> spec.volumes[].rbd.secretRef </h3> <a href="#specvolumesrbd"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesscaleio"> spec.volumes[].scaleIO </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> gateway </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> <a href="#specvolumesscaleiosecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> true </td> </tr> <tr> <td> system </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> protectionDomain </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> sslEnabled </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> storageMode </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> storagePool </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesscaleiosecretref"> spec.volumes[].scaleIO.secretRef </h3> <a href="#specvolumesscaleio"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumessecret"> spec.volumes[].secret </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> defaultMode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumessecretitems"> items </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> optional </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> secretName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumessecretitems"> spec.volumes[].secret.items[] </h3> <a href="#specvolumessecret"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> key </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> path </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> mode </td> <td> integer </td> <td> Format : int32 </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesstorageos"> spec.volumes[].storageos </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> readOnly </td> <td> boolean </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#specvolumesstorageossecretref"> secretRef </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> volumeNamespace </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesstorageossecretref"> spec.volumes[].storageos.secretRef </h3> <a href="#specvolumesstorageos"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="specvolumesvspherevolume"> spec.volumes[].vsphereVolume </h3> <a href="#specvolumes"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> volumePath </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> fsType </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> storagePolicyID </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> storagePolicyName </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="status"> status </h3> <a href="#"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> <a href="#statusbundleddatabaseversions"> bundledDatabaseVersions </a> </td> <td> []object </td> <td> Versions of open source databases bundled by Redis Enterprise Software - please note that in order to use a specific version it should be supported by the ‘upgradePolicy’ - ‘major’ or ‘latest’ according to the desired version (major/minor) </td> <td> false </td> </tr> <tr> <td> ingressOrRouteMethodStatus </td> <td> string </td> <td> The ingressOrRouteSpec/ActiveActive spec method that exist </td> <td> false </td> </tr> <tr> <td> <a href="#statuslicensestatus"> licenseStatus </a> </td> <td> object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#statusmanagedapis"> managedAPIs </a> </td> <td> object </td> <td> Indicates cluster APIs that are being managed by the operator. This only applies to cluster APIs which are optionally-managed by the operator, such as cluster LDAP configuration. Most other APIs are automatically managed by the operator, and are not listed here. </td> <td> false </td> </tr> <tr> <td> <a href="#statusmodules"> modules </a> </td> <td> []object </td> <td> </td> <td> false </td> </tr> <tr> <td> <a href="#statusocspstatus"> ocspStatus </a> </td> <td> object </td> <td> An API object that represents the cluster's OCSP status </td> <td> false </td> </tr> <tr> <td> <a href="#statuspersistencestatus"> persistenceStatus </a> </td> <td> object </td> <td> The status of the Persistent Volume Claims that are used for Redis Enterprise Cluster persistence. The status will correspond to the status of one or more of the PVCs (failed/resizing if one of them is in resize or failed to resize) </td> <td> false </td> </tr> <tr> <td> redisEnterpriseIPFamily </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> specStatus </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> state </td> <td> string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="statusbundleddatabaseversions"> status.bundledDatabaseVersions[] </h3> <a href="#status"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> dbType </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> version </td> <td> string </td> <td> </td> <td> true </td> </tr> <tr> <td> major </td> <td> boolean </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="statuslicensestatus"> status.licenseStatus </h3> <a href="#status"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> activationDate </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> expirationDate </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> licenseState </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> shardsLimit </td> <td> integer </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="statusmanagedapis"> status.managedAPIs </h3> <a href="#status"> ↩ Parent </a> Indicates cluster APIs that are being managed by the operator. This only applies to cluster APIs which are optionally-managed by the operator, such as cluster LDAP configuration. Most other APIs are automatically managed by the operator, and are not listed here. <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> ldap </td> <td> boolean </td> <td> Indicate whether cluster LDAP configuration is managed by the operator. When this is enabled, the operator will reconcile the cluster LDAP configuration according to the '.spec.ldap' field in the RedisEnterpriseCluster resource. </td> <td> false </td> </tr> </tbody> </table> <h3 id="statusmodules"> status.modules[] </h3> <a href="#status"> ↩ Parent </a> <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> displayName </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> name </td> <td> string </td> <td> </td> <td> false </td> </tr> <tr> <td> versions </td> <td> []string </td> <td> </td> <td> false </td> </tr> </tbody> </table> <h3 id="statusocspstatus"> status.ocspStatus </h3> <a href="#status"> ↩ Parent </a> An API object that represents the cluster's OCSP status <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> certStatus </td> <td> string </td> <td> Indicates the proxy certificate status - GOOD/REVOKED/UNKNOWN. </td> <td> false </td> </tr> <tr> <td> nextUpdate </td> <td> string </td> <td> The time at or before which newer information will be available about the status of the certificate (if available) </td> <td> false </td> </tr> <tr> <td> producedAt </td> <td> string </td> <td> The time at which the OCSP responder signed this response. </td> <td> false </td> </tr> <tr> <td> responderUrl </td> <td> string </td> <td> The OCSP responder url from which this status came from. </td> <td> false </td> </tr> <tr> <td> revocationTime </td> <td> string </td> <td> The time at which the certificate was revoked or placed on hold. </td> <td> false </td> </tr> <tr> <td> thisUpdate </td> <td> string </td> <td> The most recent time at which the status being indicated is known by the responder to have been correct. </td> <td> false </td> </tr> </tbody> </table> <h3 id="statuspersistencestatus"> status.persistenceStatus </h3> <a href="#status"> ↩ Parent </a> The status of the Persistent Volume Claims that are used for Redis Enterprise Cluster persistence. The status will correspond to the status of one or more of the PVCs (failed/resizing if one of them is in resize or failed to resize) <table> <thead> <tr> <th> Name </th> <th> Type </th> <th> Description </th> <th> Required </th> </tr> </thead> <tbody> <tr> <td> status </td> <td> string </td> <td> The current status of the PVCs </td> <td> false </td> </tr> <tr> <td> succeeded </td> <td> string </td> <td> The number of PVCs that are provisioned with the expected size </td> <td> false </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/kubernetes/reference/redis_enterprise_cluster_api/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.6-release-notes/.html

<section class="prose w-full py-12 max-w-none"> <h1> RedisJSON 2.6 release notes </h1> RESP3 support. New commands JSON.MERGE and JSON.MSET. <h2 id="requirements"> Requirements </h2> RedisJSON v2.6.12 requires: <ul> <li> Minimum Redis compatibility version (database): 7.2 </li> <li> Minimum Redis Enterprise Software version (cluster): 7.2.4 </li> </ul> <h2 id="v2612-september-2024"> v2.6.12 (September 2024) </h2> This is a maintenance release for RedisJSON 2.6 Update urgency: <code> MODERATE </code> : Program an upgrade of the server, but it's not urgent. Details: <ul> <li> Bug fixes: <ul> <li> <a href="https://github.com/redisjson/redisjson/pull/1225"> #1225 </a> Crash on SET commands with recursive overlapping paths (MOD-7279) </li> <li> HDT#261 (Redis Enterprise A-A only) Crash when a JSON contains an EOF character (MOD-7464) </li> </ul> </li> </ul> <h2 id="v2610-april-2024"> v2.6.10 (April 2024) </h2> This is a maintenance release for RedisJSON 2.6. Update urgency: <code> MODERATE </code> : Program an upgrade of the server, but it's not urgent. Details: <ul> <li> Bug fixes: <ul> <li> <a href="https://github.com/RedisJSON/RedisJSON/pull/1192"> #1192 </a> Crashes with numeric values greater than i64::MAX (MOD-6501, MOD-4551, MOD-4856, MOD-5714) </li> <li> HDT#228 (Redis Enterprise A-A only) Incorrect error when processing escaped characters (MOD-6645) </li> </ul> </li> </ul> <h2 id="v269-january-2024"> v2.6.9 (January 2024) </h2> This is a maintenance release for RedisJSON 2.6. Update urgency: <code> MODERATE </code> : Program an upgrade of the server, but it's not urgent. Details: <ul> <li> Improvements: <ul> <li> <a href="https://github.com/RedisJSON/RedisJSON/issues/1131"> #1131 </a> , <a href="https://github.com/RedisJSON/RedisJSON/pull/1143"> #1143 </a> BREAKING - Revert JSONPath default path value from <code> $ </code> to <code> . </code> under RESP3 (MOD-6156) </li> </ul> </li> <li> Bug fixes: <ul> <li> <a href="https://github.com/RedisJSON/RedisJSON/pull/1095"> #1095 </a> Fix for RediSearch deadlock. See RediSearch 2.8.10 release notes (MOD-5895) </li> </ul> </li> </ul> <h2 id="v268-november-2023"> v2.6.8 (November 2023) </h2> This is a maintenance release for RedisJSON 2.6. Update urgency: <code> LOW </code> : No need to upgrade unless there are new features you want to use. Details: <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> RHEL 7 is no longer supported as of v2.6.8. </div> </div> This is a version number alignment with RedisJSON for Redis Enterprise (with Active-Active support). <h2 id="v267-october-2023"> v2.6.7 (October 2023) </h2> This is a maintenance release for RedisJSON 2.6. Update urgency: <code> LOW </code> : No need to upgrade unless there are new features you want to use. Details: <ul> <li> Improvements: <ul> <li> <a href="https://github.com/RedisJSON/RedisJSON/pull/1102"> #1102 </a> Added support for CBL-Mariner 2 </li> <li> <a href="https://github.com/RedisJSON/RedisJSON/pull/1099"> #1099 </a> Added support for RHEL9 and Rocky Linux 9 </li> </ul> </li> </ul> <h2 id="v266-august-2023"> v2.6.6 (August 2023) </h2> This is a maintenance release for RedisJSON 2.6. Update urgency: <code> LOW </code> : No need to upgrade unless there are new features you want to use. Details: This is just a version number alignment with RedisJSON for Redis Enterprise (with Active-Active support). <h2 id="v26-ga-v264-july-2023"> v2.6 GA (v2.6.4) (July 2023) </h2> This is the General Availability release of RedisJSON 2.6. <h3 id="headlines"> Headlines </h3> RedisJSON 2.6 introduces support for RESP3 and new commands. <h3 id="whats-new-in-26"> What's new in 2.6 </h3> <ul> <li> Introduce <a href="/docs/latest/commands/json.merge"> <code> JSON.MERGE </code> </a> in compliance with <a href="https://datatracker.ietf.org/doc/html/rfc7396"> RFC 7396 </a> , supporting: <ul> <li> Creating new attributes on an existing JSON document </li> <li> Updating and replacing values in parent and child attributes </li> <li> Deleting existing attributes (by setting the value to <code> null </code> ) </li> <li> Array update - replacing an entire array with the new value </li> </ul> </li> <li> Introduce <a href="/docs/latest/commands/json.mset"> <code> JSON.MSET </code> </a> , supporting atomic multiple sets for keys in the same hash slot </li> <li> New <code> FORMAT </code> argument in <code> JSON.ARRPOP </code> and <code> JSON.GET </code> to retrieve the results as JSON strings or RESP3 hierarchical structures (RESP3 only) </li> <li> <code> JSON.RESP </code> is now regarded as deprecated </li> <li> Legacy paths (paths that don't start with either <code> $. </code> or <code> $[ </code> or equal to <code> $ </code> ), except those starting with <code> . </code> , are now deprecated </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"> Note: </div> <ul> <li> The version inside Redis will be 2.6.4 in semantic versioning. Since the version of a module in Redis is numeric, we could not add a GA flag. </li> <li> Minimal Redis version: 7.2 </li> </ul> </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/oss_and_stack/stack-with-enterprise/release-notes/redisjson/redisjson-2.6-release-notes/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/cli-utilities/rladmin/cluster/ocsp/.html

<section class="prose w-full py-12 max-w-none"> <h1> rladmin cluster ocsp </h1> Manages OCSP. Manages OCSP configuration and verifies the status of a server certificate maintained by a third-party <a href="https://en.wikipedia.org/wiki/Certificate_authority"> certificate authority (CA) </a> . <h2 id="ocsp-certificate_compatible"> <code> ocsp certificate_compatible </code> </h2> Checks if the proxy certificate contains an OCSP URI. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin cluster ocsp certificate_compatible </code></pre> </div> <h3 id="parameters"> Parameters </h3> None <h3 id="returns"> Returns </h3> Returns the OCSP URI if it exists. Otherwise, it returns an error. <h3 id="example"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin cluster ocsp certificate_compatible Success. OCSP URI is http://responder.ocsp.url.com </code></pre> </div> <h2 id="ocsp-config"> <code> ocsp config </code> </h2> Displays or updates OCSP configuration. Run the command without the <code> set </code> option to display the current configuration of a parameter. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin cluster ocsp config <OCSP parameter> [set <value>] </code></pre> </div> <h3 id="parameters-1"> Parameters </h3> <table> <thead> <tr> <th> Parameter </th> <th> Type/Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> ocsp_functionality </td> <td> enabled disabled </td> <td> Enables or turns off OCSP for the cluster </td> </tr> <tr> <td> query_frequency </td> <td> integer (range: 60-86400) (default: 3600) </td> <td> The time interval in seconds between OCSP queries to check the certificate's status </td> </tr> <tr> <td> recovery_frequency </td> <td> integer (range: 60-86400) (default: 60) </td> <td> The time interval in seconds between retries after a failed query </td> </tr> <tr> <td> recovery_max_tries </td> <td> integer (range: 1-100) (default: 5) </td> <td> The number of retries before the validation query fails and invalidates the certificate </td> </tr> <tr> <td> responder_url </td> <td> string </td> <td> The OCSP server URL embedded in the proxy certificate (you cannot manually set this parameter) </td> </tr> <tr> <td> response_timeout </td> <td> integer (range: 1-60) (default: 1) </td> <td> The time interval in seconds to wait for a response before timing out </td> </tr> </tbody> </table> <h3 id="returns-1"> Returns </h3> If you run the <code> ocsp config </code> command without the <code> set </code> option, it displays the specified parameter's current configuration. <h3 id="example-1"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin cluster ocsp config recovery_frequency Recovery frequency of the OCSP server is 60 seconds $ rladmin cluster ocsp config recovery_frequency set 30 $ rladmin cluster ocsp config recovery_frequency Recovery frequency of the OCSP server is 30 seconds </code></pre> </div> <h2 id="ocsp-status"> <code> ocsp status </code> </h2> Returns the latest cached status of the certificate's OCSP response. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin cluster ocsp status </code></pre> </div> <h3 id="parameters-2"> Parameters </h3> None <h3 id="returns-2"> Returns </h3> Returns the latest cached status of the certificate's OCSP response. <h3 id="example-2"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin cluster ocsp status OCSP certificate status is: REVOKED produced_at: Wed, 22 Dec 2021 12:50:11 GMT responder_url: http://responder.ocsp.url.com revocation_time: Wed, 22 Dec 2021 12:50:04 GMT this_update: Wed, 22 Dec 2021 12:50:11 GMT </code></pre> </div> <h2 id="ocsp-test_certificate"> <code> ocsp test_certificate </code> </h2> Queries the OCSP server for the certificate's latest status, then caches and displays the response. <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">rladmin cluster ocsp test_certificate </code></pre> </div> <h3 id="parameters-3"> Parameters </h3> None <h3 id="returns-3"> Returns </h3> Returns the latest status of the certificate's OCSP response. <h3 id="example-3"> Example </h3> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rladmin cluster ocsp test_certificate Initiating a query to OCSP server ...OCSP certificate status is: REVOKED produced_at: Wed, 22 Dec 2021 12:50:11 GMT responder_url: http://responder.ocsp.url.com revocation_time: Wed, 22 Dec 2021 12:50:04 GMT this_update: Wed, 22 Dec 2021 12:50:11 GMT </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/7.4/references/cli-utilities/rladmin/cluster/ocsp/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/config/.html

<section class="prose w-full py-12"> <h1 class="command-name"> CONFIG </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">CONFIG</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"> 2.0.0 </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> Depends on subcommand. </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @slow </code> , </dd> </dl> This is a container command for runtime configuration commands. To see the list of available commands you can call <a href="/docs/latest/commands/config-help/"> <code> CONFIG HELP </code> </a> . <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/config/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/tools/insight/release-notes/v.2.60.0/.html

<section class="prose w-full py-12"> <h1> Redis Insight v2.60.0, October 2024 </h1> Redis Insight v2.60 <h2 id="260-october-2024"> 2.60 (October 2024) </h2> This is the General Availability (GA) release of Redis Insight 2.60. <h3 id="highlights"> Highlights </h3> <ul> <li> Advanced and schema-aware command auto-complete for <a href="https://redis.io/docs/latest/develop/interact/search-and-query/?utm_source=redisinsight&utm_medium=main&utm_campaign=release_notes"> Redis Query Engine </a> is now available in Workbench, enabling faster and more accurate query building with smart suggestions for indexes, schemas, and expressions. </li> <li> Support for adding multiple elements to the head or tail of lists, for both new or existing keys. </li> <li> Multiple UI enhancements for clarity and ease of use when editing Redis Data Integration (RDI) jobs. </li> </ul> <h3 id="details"> Details </h3> Features and improvements <ul> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/3553"> #3553 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/3647"> #3647 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/3669"> #3669 </a> Advanced, schema-aware auto-complete for <a href="https://redis.io/docs/latest/develop/interact/search-and-query/?utm_source=redisinsight&utm_medium=main&utm_campaign=release_notes"> Redis Query Engine </a> in Workbench. Enjoy faster query building with context-sensitive suggestions that recognize indexes, schemas, and fields based on your current query. Start typing any <a href="https://redis.io/docs/latest/commands/?group=search"> Redis Query Engine </a> command in Workbench to try this feature. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/3891"> #3891 </a> Allows to easily push multiple elements to the head or tail of list data types, whether creating new or updating existing lists. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/3891"> #3891 </a> UX/UI enhancements to provide more details about Redis Data Integration (RDI) job transformation and output results in the dry-run section. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/3981"> #3981 </a> Removes confirmation prompts for template insertions in Redis Data Integration jobs, simplifying a workflow. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/3827"> #3827 </a> Provides easy-to-understand metrics of network input/output by automatically converting units in Browser Overview. </li> <li> <a href="https://github.com/RedisInsight/RedisInsight/pull/3982"> #3982 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/3975"> #3975 </a> , <a href="https://github.com/RedisInsight/RedisInsight/pull/3941"> #3941 </a> Various vulnerabilities have been fixed. </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/develop/tools/insight/release-notes/v.2.60.0/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/import-export/.html

<section class="prose w-full py-12 max-w-none"> <h1> Import and export data </h1> How to import, export, flush, and migrate your data. <nav> <a href="/docs/latest/operate/rs/databases/import-export/import-data/"> Import data into a database </a> You can import export or backup files of a specific Redis Enterprise Software database to restore data. You can either import from a single file or from multiple files, such as when you want to import from a backup of a clustered database. <a href="/docs/latest/operate/rs/databases/import-export/export-data/"> Export data from a database </a> You can export data to import it into a new database or to make a backup. This article shows how to do so. <a href="/docs/latest/operate/rs/databases/import-export/flush/"> Flush database data </a> To delete the data in a database without deleting the database, you can use Redis CLI to flush it from the database. You can also use Redis CLI, the admin console, and the Redis Software REST API to flush data from Active-Active databases. <a href="/docs/latest/operate/rs/databases/import-export/schedule-backups/"> Schedule periodic backups </a> Schedule backups of your databases to make sure you always have valid backups. <a href="/docs/latest/operate/rs/databases/import-export/migrate-to-active-active/"> Migrate a database to Active-Active </a> Use Replica Of to migrate your database to an Active-Active database. <a href="/docs/latest/operate/rs/databases/import-export/replica-of/"> Replica Of geo-distributed Redis </a> Replica Of provides read-only access to replicas of the dataset from different geographical locations. </nav> <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/import-export/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/clusters/configure/cluster-settings/.html

<section class="prose w-full py-12 max-w-none"> <h1> Cluster settings </h1> You can view and set various cluster settings such as cluster name, email service, time zone, and license. You can view and set various cluster settings, such as cluster name, email service, time zone, and license, on the Cluster > Configuration page. <h2 id="general-configuration-tab"> General configuration tab </h2> <h3 id="upload-cluster-license-key"> Upload cluster license key </h3> After purchasing a cluster license and if your account has the "Admin" role, you can upload the cluster license key, either during initial cluster creation or at any time afterward. The license key defines various cluster settings, such as the maximum number of shards you can have in the cluster. For more detailed information see <a href="/docs/latest/operate/rs/7.4/clusters/configure/license-keys/"> Cluster license keys </a> . <h3 id="view-max-number-of-allowed-shards"> View max number of allowed shards </h3> The maximum number of allowed shards, which is determined by the cluster license key, appears in the Max number of shards field in the License section. <h3 id="view-cluster-name"> View cluster name </h3> The cluster name appears in the Cluster name field in the License section. This gives a common name that your team or Redis support can refer to. It is especially helpful if you have multiple clusters. <h3 id="set-time-zone"> Set time zone </h3> You can change the Time zone field to ensure the date, time fields, and log entries in the Cluster Manager UI are shown in your preferred time zone. This setting doesn't affect other system logs or services. <h2 id="alert-settings-tab"> Alert settings tab </h2> The Alert Settings tab lets you configure alerts that are relevant to the entire cluster, such as alerts for cluster utilization, nodes, node utilization, security, and database utilization. You can also configure email server settings and <a href="/docs/latest/operate/rs/7.4/clusters/monitoring/#send-alerts-by-email"> send alerts by email </a> to relevant users. <h3 id="configure-email-server-settings"> Configure email server settings </h3> To enable email alerts: <ol> <li> Enter your email server details in the Email server settings section. </li> <li> Select a connection security method: <ul> <li> TLS/SSL </li> <li> STARTTLS </li> <li> None </li> </ul> </li> <li> Send a test email to verify your email server settings. </li> </ol> <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/clusters/configure/cluster-settings/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/hmset/.html

<section class="prose w-full py-12"> <h1 class="command-name"> HMSET (deprecated) </h1> <div class="border-l-8 pl-4"> As of Redis version 4.0.0, this command is regarded as deprecated. It can be replaced by <a href="/docs/latest/commands/hset/"> <code> HSET </code> </a> with multiple field-value pairs when migrating or writing new code. </div> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">HMSET key field value [field value ...]</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"> 2.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 number of fields being set. </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @write </code> , <code> @hash </code> , <code> @fast </code> , </dd> </dl> Sets the specified fields to their respective values in the hash stored at <code> key </code> . This command overwrites any specified fields already existing in the hash. If <code> key </code> does not exist, a new key holding a hash is created. <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> HMSET myhash field1 "Hello" field2 "World" "OK" redis> HGET myhash field1 "Hello" redis> HGET myhash field2 "World" </pre> <div class="prompt" style=""> redis> <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#simple-strings"> Simple string reply </a> : <code> OK </code> . <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/hmset/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/objects/statistics/node-metrics/.html

<section class="prose w-full py-12 max-w-none"> <h1> Node metrics </h1> Documents the node metrics used with Redis Enterprise Software REST API calls. <table> <thead> <tr> <th> Metric name </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> available_flash </td> <td> float </td> <td> Available flash on the node (bytes) </td> </tr> <tr> <td> available_memory </td> <td> float </td> <td> Available RAM on the node (bytes) </td> </tr> <tr> <td> avg_latency </td> <td> float </td> <td> Average latency of requests handled by endpoints on the node (micro-sec); returned only when there is traffic </td> </tr> <tr> <td> bigstore_free </td> <td> float </td> <td> Free space of backend flash (used by flash DB's BigRedis) (bytes); returned only when BigRedis is enabled </td> </tr> <tr> <td> bigstore_iops </td> <td> float </td> <td> Rate of I/O operations against backend flash for all shards which are part of a flash-based DB (BigRedis) on the node (ops/sec); returned only when BigRedis is enabled </td> </tr> <tr> <td> bigstore_kv_ops </td> <td> float </td> <td> Rate of value read/write operations against backend flash for all shards which are part of a flash-based DB (BigRedis) on the node (ops/sec); returned only when BigRedis is enabled </td> </tr> <tr> <td> bigstore_throughput </td> <td> float </td> <td> Throughput of I/O operations against backend flash for all shards which are part of a flash-based DB (BigRedis) on the node (bytes/sec); returned only when BigRedis is enabled </td> </tr> <tr> <td> conns </td> <td> float </td> <td> Number of clients connected to endpoints on the node </td> </tr> <tr> <td> cpu_idle </td> <td> float </td> <td> CPU idle time portion (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> cpu_system </td> <td> float </td> <td> CPU time portion spent in kernel (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> cpu_user </td> <td> float </td> <td> CPU time portion spent by users-pace processes (0-1, multiply by 100 to get percent) </td> </tr> <tr> <td> cur_aof_rewrites </td> <td> float </td> <td> Number of current AOF rewrites by shards on this node </td> </tr> <tr> <td> egress_bytes </td> <td> float </td> <td> Rate of outgoing network traffic to the node (bytes/sec) </td> </tr> <tr> <td> ephemeral_storage_avail </td> <td> float </td> <td> Disk space available to Redis Enterprise processes on configured ephemeral disk (bytes) </td> </tr> <tr> <td> ephemeral_storage_free </td> <td> float </td> <td> Free disk space on configured ephemeral disk (bytes) </td> </tr> <tr> <td> free_memory </td> <td> float </td> <td> Free memory on the node (bytes) </td> </tr> <tr> <td> ingress_bytes </td> <td> float </td> <td> Rate of incoming network traffic to the node (bytes/sec) </td> </tr> <tr> <td> persistent_storage_avail </td> <td> float </td> <td> Disk space available to Redis Enterprise processes on configured persistent disk (bytes) </td> </tr> <tr> <td> persistent_storage_free </td> <td> float </td> <td> Free disk space on configured persistent disk (bytes) </td> </tr> <tr> <td> provisional_flash </td> <td> float </td> <td> Amount of flash available for new shards on this node, taking into account overbooking, max Redis servers, reserved flash, and provision and migration thresholds (bytes) </td> </tr> <tr> <td> provisional_memory </td> <td> float </td> <td> Amount of RAM available for new shards on this node, taking into account overbooking, max Redis servers, reserved memory, and provision and migration thresholds (bytes) </td> </tr> <tr> <td> total_req </td> <td> float </td> <td> Request rate handled by endpoints on the node (ops/sec) </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/references/rest-api/objects/statistics/node-metrics/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/ft.aliasupdate/.html

<section class="prose w-full py-12"> <h1 class="command-name"> FT.ALIASUPDATE </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">FT.ALIASUPDATE alias index </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/interact/search-and-query"> Search 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(1) </dd> </dl> Add an alias to an index. If the alias is already associated with another index, FT.ALIASUPDATE removes the alias association with the previous index. <a href="#examples"> Examples </a> <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> alias index </code> </summary> is alias to be added to an index. </details> <h2 id="return"> Return </h2> FT.ALIASUPDATE returns a simple string reply <code> OK </code> if executed correctly, or an error reply otherwise. <h2 id="examples"> Examples </h2> <details open=""> <summary> Update an index alias </summary> Update the alias of an index. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">127.0.0.1:6379> FT.ALIASUPDATE alias idx OK</code></pre> </div> <h2 id="see-also"> See also </h2> <a href="/docs/latest/commands/ft.aliasadd/"> <code> FT.ALIASADD </code> </a> | <a href="/docs/latest/commands/ft.aliasdel/"> <code> FT.ALIASDEL </code> </a> <h2 id="related-topics"> Related topics </h2> <a href="/docs/latest/develop/interact/search-and-query/"> RediSearch </a> <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/ft.aliasupdate/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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> </details> </section>

https://redis.io/docs/latest/operate/rs/7.4/databases/active-active/develop/data-types/sorted-sets/.html

<section class="prose w-full py-12 max-w-none"> <h1> Sorted sets in Active-Active databases </h1> Information about using sorted sets with an Active-Active database. <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> <a href="/docs/latest/commands/geoadd/"> Redis Geospatial (Geo) </a> is based on Sorted Sets, so the same Active-Active database development instructions apply to Geo. </div> </div> Similar to Redis Sets, Redis Sorted Sets are non-repeating collections of Strings. The difference between the two is that every member of a Sorted Set is associated with a score used to order the Sorted Set from lowest to highest. While members are unique, they may have the same score. With Sorted Sets, you can quickly add, remove or update elements as well as get ranges by score or by rank (position). Sorted Sets in Active-Active databases behave the same and maintain additional metadata to handle concurrent conflicting writes. Conflict resolution is done in two phases: <ol> <li> First, the database resolves conflict at the set level using "OR Set" (Observed-Remove Set). With OR-Set behavior, writes across multiple Active-Active database instances are typically unioned except in cases of conflicts. Conflicting writes can happen when an Active-Active database instance deletes an element while the other adds or updates the same element. In this case, an observed Remove rule is followed, and only instances it has already seen are removed. In all other cases, the Add / Update element wins. </li> <li> Second, the database resolves conflict at the score level. In this case, the score is treated as a counter and applies the same conflict resolution as regular counters. </li> </ol> See the following examples to get familiar with Sorted Sets' behavior in Active-Active database: Example of Simple Sorted Set with No Conflict: <table> <thead> <tr> <th style="text-align:right"> Time </th> <th style="text-align:center"> CRDB Instance 1 </th> <th style="text-align:center"> CRDB Instance 2 </th> </tr> </thead> <tbody> <tr> <td style="text-align:right"> t1 </td> <td style="text-align:center"> ZADD Z 1.1 x </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t2 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t3 </td> <td style="text-align:center"> </td> <td style="text-align:center"> ZADD Z 1.2 y </td> </tr> <tr> <td style="text-align:right"> t4 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t5 </td> <td style="text-align:center"> ZRANGE Z 0 -1 => x y </td> <td style="text-align:center"> ZRANGE Z 0 -1 => x y </td> </tr> </tbody> </table> Explanation : When adding two different elements to a Sorted Set from different replicas (in this example, x with score 1.1 was added by Instance 1 to Sorted Set Z, and y with score 1.2 was added by Instance 2 to Sorted Set Z) in a non-concurrent manner (i.e. each operation happened separately and after both instances were in sync), the end result is a Sorted Set including both elements in each Active-Active database instance. Example of Sorted Set and Concurrent Add: <table> <thead> <tr> <th style="text-align:right"> Time </th> <th style="text-align:center"> CRDB Instance 1 </th> <th style="text-align:center"> CRDB Instance 2 </th> </tr> </thead> <tbody> <tr> <td style="text-align:right"> t1 </td> <td style="text-align:center"> ZADD Z 1.1 x </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t2 </td> <td style="text-align:center"> </td> <td style="text-align:center"> ZADD Z 2.1 x </td> </tr> <tr> <td style="text-align:right"> t3 </td> <td style="text-align:center"> ZSCORE Z x => 1.1 </td> <td style="text-align:center"> ZSCORE Z x => 2.1 </td> </tr> <tr> <td style="text-align:right"> t4 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t5 </td> <td style="text-align:center"> ZSCORE Z x => 2.1 </td> <td style="text-align:center"> ZSCORE Z x => 2.1 </td> </tr> </tbody> </table> Explanation : When concurrently adding an element x to a Sorted Set Z by two different Active-Active database instances (Instance 1 added score 1.1 and Instance 2 added score 2.1), the Active-Active database implements Last Write Win (LWW) to determine the score of x. In this scenario, Instance 2 performed the ZADD operation at time t2>t1 and therefore the Active-Active database sets the score 2.1 to x. Example of Sorted Set with Concurrent Add Happening at the Exact Same Time: <table> <thead> <tr> <th style="text-align:right"> Time </th> <th style="text-align:center"> CRDB Instance 1 </th> <th style="text-align:center"> CRDB Instance 2 </th> </tr> </thead> <tbody> <tr> <td style="text-align:right"> t1 </td> <td style="text-align:center"> ZADD Z 1.1 x </td> <td style="text-align:center"> ZADD Z 2.1 x </td> </tr> <tr> <td style="text-align:right"> t2 </td> <td style="text-align:center"> ZSCORE Z x => 1.1 </td> <td style="text-align:center"> ZSCORE Z x => 2.1 </td> </tr> <tr> <td style="text-align:right"> t3 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t4 </td> <td style="text-align:center"> ZSCORE Z x => 1.1 </td> <td style="text-align:center"> ZSCORE Z x => 1.1 </td> </tr> </tbody> </table> Explanation : The example above shows a relatively rare situation, in which two Active-Active database instances concurrently added the same element x to a Sorted Set at the same exact time but with a different score, i.e. Instance 1 added x with a 1.1 score and Instance 2 added x with a 2.1 score. After syncing, the Active-Active database realized that both operations happened at the same time and resolved the conflict by arbitrarily (but consistently across all Active-Active database instances) giving precedence to Instance 1. Example of Sorted Set with Concurrent Counter Increment: <table> <thead> <tr> <th style="text-align:right"> Time </th> <th style="text-align:center"> CRDB Instance 1 </th> <th style="text-align:center"> CRDB Instance 2 </th> </tr> </thead> <tbody> <tr> <td style="text-align:right"> t1 </td> <td style="text-align:center"> ZADD Z 1.1 x </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t2 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t3 </td> <td style="text-align:center"> ZINCRBY Z 1.0 x </td> <td style="text-align:center"> ZINCRBY Z 1.0 x </td> </tr> <tr> <td style="text-align:right"> t4 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t5 </td> <td style="text-align:center"> ZSCORE Z x => 3.1 </td> <td style="text-align:center"> ZSCORE Z x => 3.1 </td> </tr> </tbody> </table> Explanation : The result is the sum of all ZINCRBY operations performed by all Active-Active database instances. Example of Removing an Element from a Sorted Set: <table> <thead> <tr> <th style="text-align:right"> Time </th> <th style="text-align:center"> CRDB Instance 1 </th> <th style="text-align:center"> CRDB Instance 2 </th> </tr> </thead> <tbody> <tr> <td style="text-align:right"> t1 </td> <td style="text-align:center"> ZADD Z 4.1 x </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t2 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t3 </td> <td style="text-align:center"> ZSCORE Z x => 4.1 </td> <td style="text-align:center"> ZSCORE Z x => 4.1 </td> </tr> <tr> <td style="text-align:right"> t4 </td> <td style="text-align:center"> ZREM Z x </td> <td style="text-align:center"> ZINCRBY Z 2.0 x </td> </tr> <tr> <td style="text-align:right"> t5 </td> <td style="text-align:center"> ZSCORE Z x => nill </td> <td style="text-align:center"> ZSCORE Z x => 6.1 </td> </tr> <tr> <td style="text-align:right"> t6 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t7 </td> <td style="text-align:center"> ZSCORE Z x => 2.0 </td> <td style="text-align:center"> ZSCORE Z x => 2.0 </td> </tr> </tbody> </table> Explanation : At t4 - t5, concurrent ZREM and ZINCRBY operations ran on Instance 1 and Instance 2 respectively. Before the instances were in sync, the ZREM operation could only delete what had been seen by Instance 1, so Instance 2 was not affected. Therefore, the ZSCORE operation shows the local effect on x. At t7, after both instances were in-sync, the Active-Active database resolved the conflict by subtracting 4.1 (the value of element x in Instance 1) from 6.1 (the value of element x in Instance 2). <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/databases/active-active/develop/data-types/sorted-sets/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/changelog/2023/may-2023/.html

<section class="prose w-full py-12 max-w-none"> <h1> Redis Cloud changelog (May 2023) </h1> New features, enhancements, and other changes added to Redis Cloud during May 2023. This changelog lists new features, enhancements, and other changes added to Redis Cloud during May 2023. <h2 id="new-features-and-enhancements"> New features and enhancements </h2> <h3 id="cloud-api---fixed-plans-support"> Cloud API - Fixed plans support </h3> The <a href="/docs/latest/operate/rc/api/"> Redis Cloud API </a> supports new endpoints to manage fixed subscriptions and databases. The new fixed endpoints can be viewed in the <a href="https://api.redislabs.com/v1/swagger-ui/index.html#/Subscriptions%20-%20Fixed"> Redis Cloud Swagger UI </a> . For more information about using the Redis Cloud API, see <a href="/docs/latest/operate/rc/api/get-started/use-rest-api/"> Use the REST API </a> . <h3 id="active-active-access-roles"> Active-Active access roles </h3> For <a href="/docs/latest/operate/rc/databases/configuration/active-active-redis/"> Active-Active databases </a> , you can now define roles with different levels of access for different regions. For more information, see <a href="/docs/latest/operate/rc/security/access-control/data-access-control/active-active-roles/"> Active-Active roles </a> . <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/changelog/2023/may-2023/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/billing-and-payments/.html

<section class="prose w-full py-12 max-w-none"> <h1> Billing & payments </h1> Describes how to view billing transactions and manage payment methods for Redis Cloud subscriptions. The Billing & Payments screen: <ul> <li> Shows recent transactions for your account </li> <li> Helps you manage your payment methods </li> <li> Applies coupon credits to your account </li> </ul> <a href="/docs/latest/images/rc/billing-billing-history-tab.png" sdata-lightbox="/images/rc/billing-billing-history-tab.png"> <img alt="The Billing & Payments screen shows billing transactions and manage payment methods." src="/docs/latest/images/rc/billing-billing-history-tab.png"/> </a> The following tabs are available: <ul> <li> The Billing History tab displays recent charges and payments. Each transaction includes the following details: <table> <thead> <tr> <th style="text-align:left"> Detail </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> Date </td> <td style="text-align:left"> Date the transaction was recorded </td> </tr> <tr> <td style="text-align:left"> Description </td> <td style="text-align:left"> Description of the transaction </td> </tr> <tr> <td style="text-align:left"> Reference </td> <td style="text-align:left"> Reference number </td> </tr> <tr> <td style="text-align:left"> Amount </td> <td style="text-align:left"> Transaction amount </td> </tr> </tbody> </table> Billing details may vary between regions. You can <a href="#download-invoice"> download invoices </a> on this tab. A Pay Now button appears in selected regions. <a href="/docs/latest/images/rc/billing-payments-pay-now.png" sdata-lightbox="/images/rc/billing-payments-pay-now.png"> <img alt="Use the Pay Now button to Pay your invoice in selected regions." src="/docs/latest/images/rc/billing-payments-pay-now.png" width="100px"/> </a> Select this button to pay your invoice. </li> <li> The Payment Methods tab lists your current payment methods. You can add a new payment method, associate different payment methods with specific subscriptions, and remove payment methods. <a href="/docs/latest/images/rc/billing-payment-method-tab.png" sdata-lightbox="/images/rc/billing-payment-method-tab.png"> <img alt="The Payments Methods tab helps you manage payments for your subscriptions." src="/docs/latest/images/rc/billing-payment-method-tab.png"/> </a> Select Add Credit Card to enter new credit card details. </li> <li> The Credits tab shows coupon credits that have been applied to your account, if any. <a href="/docs/latest/images/rc/billing-payments-credits-tab.png" sdata-lightbox="/images/rc/billing-payments-credits-tab.png"> <img alt="The Credits tab lets you apply coupons to your account and shows credits that have already been applied." src="/docs/latest/images/rc/billing-payments-credits-tab.png"/> </a> <table> <thead> <tr> <th style="text-align:left"> Detail </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> Code </td> <td style="text-align:left"> Coupon code </td> </tr> <tr> <td style="text-align:left"> Coupon Amount </td> <td style="text-align:left"> Amount credited to your account </td> </tr> <tr> <td style="text-align:left"> Current Balance </td> <td style="text-align:left"> Amount left </td> </tr> <tr> <td style="text-align:left"> Date added </td> <td style="text-align:left"> Date applied to your account </td> </tr> <tr> <td style="text-align:left"> Expiration Date </td> <td style="text-align:left"> Date the amount expires </td> </tr> </tbody> </table> You can <a href="#apply-coupon"> apply a coupon </a> on this tab. </li> </ul> <h2 id="download-invoice"> Download invoice </h2> To download an invoice: <ol> <li> In the <a href="https://cloud.redis.io/"> Redis Cloud console </a> , select Billing & Payments . </li> <li> From the Billing History tab, locate and select the invoice. </li> <li> Select the Download invoice icon displayed to the right of the invoice amount. <a href="/docs/latest/images/rc/icon-billing-download.png" sdata-lightbox="/images/rc/icon-billing-download.png"> <img alt="Use the download icon to download a PDF for the selected invoice." src="/docs/latest/images/rc/icon-billing-download.png" width="50px"/> </a> </li> </ol> The invoice is downloaded as an Acrobat PDF file. Use your browser's download features to manage the file. <h2 id="add-payment-method"> Add payment method </h2> To add a new payment method: <ol> <li> In the <a href="https://cloud.redis.io/"> Redis Cloud console </a> , select Billing & Payments > Payment Methods . </li> <li> Select Add credit card and add the credit card details. <a href="/docs/latest/images/rc/billing-add-credit-card.png" sdata-lightbox="/images/rc/billing-add-credit-card.png"> <img alt="Select Add Credit Card to add a new payment method" src="/docs/latest/images/rc/billing-add-credit-card.png" width="80%"/> </a> </li> <li> If you need to change the account billing address for this card, activate the Change Address slider and enter the new billing address. <a href="/docs/latest/images/rc/billing-update-billing-address.png" sdata-lightbox="/images/rc/billing-update-billing-address.png"> <img alt="Deactivate the Use account address slider to specify a different billing address." src="/docs/latest/images/rc/billing-update-billing-address.png" width="80%"/> </a> <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> Changing the billing address for your account will remove any payment methods associated with the old billing address. </div> </div> </li> <li> Select the Add Credit Card button to save your changes. <a href="/docs/latest/images/rc/button-billing-save-card.png" sdata-lightbox="/images/rc/button-billing-save-card.png"> <img alt="Use the Save Card button to save new payment details." src="/docs/latest/images/rc/button-billing-save-card.png" width="150px"/> </a> </li> </ol> <h2 id="edit-billing-address"> Edit billing address </h2> To edit the Redis Cloud account billing address: <ol> <li> In the <a href="https://cloud.redis.io/"> Redis Cloud console </a> , select Billing & Payments > Payment Methods . </li> <li> Select Credit card options > Edit billing address . <a href="/docs/latest/images/rc/billing-credit-card-options-menu.png" sdata-lightbox="/images/rc/billing-credit-card-options-menu.png"> <img alt="The Credit card options menu on the upper-right hand corner of the payment method." src="/docs/latest/images/rc/billing-credit-card-options-menu.png" width="200px"/> </a> </li> <li> Enter the new billing address. You must re-enter your payment method details to confirm your address change. <a href="/docs/latest/images/rc/account-settings-change-billing-address.png" sdata-lightbox="/images/rc/account-settings-change-billing-address.png"> <img alt="The Edit account billing address screen." src="/docs/latest/images/rc/account-settings-change-billing-address.png" width="80%"/> </a> Select the checkbox to confirm that your previous payment methods will be removed. <a href="/docs/latest/images/rc/account-settings-confirm-billing-address.png" sdata-lightbox="/images/rc/account-settings-confirm-billing-address.png"> <img alt="The Edit account billing address screen." src="/docs/latest/images/rc/account-settings-confirm-billing-address.png" width="80%"/> </a> Select Continue to save your new address. <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> Changing the billing address for your account will remove any payment methods associated with the old billing address. See <a href="#add-payment-method"> Add payment method </a> to learn how to add a payment method back to your account. </div> </div> </li> </ol> <h2 id="edit-mailing-address"> Edit mailing address </h2> To edit the mailing address associated with a payment method: <ol> <li> In the <a href="https://cloud.redis.io/"> Redis Cloud console </a> , select Billing & Payments and then select the Payment Methods tab. </li> <li> Select Credit card options > Edit mailing address . <a href="/docs/latest/images/rc/billing-credit-card-options-menu.png" sdata-lightbox="/images/rc/billing-credit-card-options-menu.png"> <img alt="The Credit card options menu on the upper-right hand corner of the payment method." src="/docs/latest/images/rc/billing-credit-card-options-menu.png" width="200px"/> </a> </li> <li> If the mailing address is different from the billing address, deactivate the Use billing address slider and enter the new mailing address. <a href="/docs/latest/images/rc/billing-change-mailing-address.png" sdata-lightbox="/images/rc/billing-change-mailing-address.png"> <img alt="The Edit mailing address screen." src="/docs/latest/images/rc/billing-change-mailing-address.png" width="80%"/> </a> </li> </ol> <h2 id="apply-coupon"> Apply coupon </h2> Coupons apply credits to your Redis Cloud account. To redeem a coupon: <ol> <li> In the <a href="https://cloud.redis.io/"> Redis Cloud console </a> , select Billing & Payments and then select the Credits tab. </li> <li> Enter the coupon code and then select the Apply button. <a href="/docs/latest/images/rc/button-billing-payments-apply.png" sdata-lightbox="/images/rc/button-billing-payments-apply.png"> <img alt="Use the Apply button to redeem a coupon." src="/docs/latest/images/rc/button-billing-payments-apply.png" width="80px"/> </a> The value of the coupon is applied to your account when accepted. </li> </ol> For help, contact <a href="https://support.redislabs.com"> Support </a> . <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> Generally, charges are non-refundable. For any special circumstances that may warrant a refund, please contact <a href="https://support.redislabs.com"> Support </a> and be sure to provide detail about the reasons for the refund request. </div> </div> <h2 id="download-cost-report"> Download cost report </h2> Select the Cost report button to download a report of all shard costs in CSV format. <a href="/docs/latest/images/rc/button-cost-report-download.png" sdata-lightbox="/images/rc/button-cost-report-download.png"> <img alt="The cost report download button." src="/docs/latest/images/rc/button-cost-report-download.png" width="150px"/> </a> The report gives a breakdown of all your Redis billing unit costs, per subscription and database, by month. Subscriptions under the minimum subscription price are broken down into actual billing unit prices and the difference from minimum price. <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/billing-and-payments/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/objects/services_configuration/pdns_server/.html

<section class="prose w-full py-12 max-w-none"> <h1> PDNS server object </h1> Documents the pdns_server object used with Redis Enterprise Software REST API calls. <table> <thead> <tr> <th> Name </th> <th> Type/Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> operating_mode </td> <td> 'disabled' 'enabled' </td> <td> Enable/disable the PDNS server </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/rest-api/objects/services_configuration/pdns_server/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/acl-genpass/.html

<section class="prose w-full py-12"> <h1 class="command-name"> ACL GENPASS </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">ACL GENPASS [bits]</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"> 6.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> , </dd> </dl> ACL users need a solid password in order to authenticate to the server without security risks. Such password does not need to be remembered by humans, but only by computers, so it can be very long and strong (unguessable by an external attacker). The <code> ACL GENPASS </code> command generates a password starting from /dev/urandom if available, otherwise (in systems without /dev/urandom) it uses a weaker system that is likely still better than picking a weak password by hand. By default (if /dev/urandom is available) the password is strong and can be used for other uses in the context of a Redis application, for instance in order to create unique session identifiers or other kind of unguessable and not colliding IDs. The password generation is also very cheap because we don't really ask /dev/urandom for bits at every execution. At startup Redis creates a seed using /dev/urandom, then it will use SHA256 in counter mode, with HMAC-SHA256(seed,counter) as primitive, in order to create more random bytes as needed. This means that the application developer should be feel free to abuse <code> ACL GENPASS </code> to create as many secure pseudorandom strings as needed. The command output is a hexadecimal representation of a binary string. By default it emits 256 bits (so 64 hex characters). The user can provide an argument in form of number of bits to emit from 1 to 1024 to change the output length. Note that the number of bits provided is always rounded to the next multiple of 4. So for instance asking for just 1 bit password will result in 4 bits to be emitted, in the form of a single hex character. <h2 id="examples"> Examples </h2> <pre tabindex="0"><code>> ACL GENPASS "dd721260bfe1b3d9601e7fbab36de6d04e2e67b0ef1c53de59d45950db0dd3cc" > ACL GENPASS 32 "355ef3dd" > ACL GENPASS 5 "90" </code></pre> <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> <a href="../../develop/reference/protocol-spec#bulk-strings"> Bulk string reply </a> : pseudorandom data. By default it contains 64 bytes, representing 256 bits of data. If <code> bits </code> was given, the output string length is the number of specified bits (rounded to the next multiple of 4) divided by 4. <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/acl-genpass/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/ft.config-help.html

<section class="prose w-full py-12"> <h1 class="command-name"> FT.CONFIG HELP </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">FT.CONFIG HELP option </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/interact/search-and-query"> Search 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(1) </dd> </dl> Describe configuration options <a href="#examples"> Examples </a> <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> option </code> </summary> is name of the configuration option, or '*' for all. </details> <h2 id="return"> Return </h2> FT.CONFIG HELP returns an array reply of the configuration name and value. <h2 id="examples"> Examples </h2> <details open=""> <summary> Get configuration details </summary> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">127.0.0.1:6379> FT.CONFIG HELP TIMEOUT 1) 1) TIMEOUT 2) Description 3) Query (search) timeout 4) Value 5) "42"</code></pre> </div> </details> <h2 id="see-also"> See also </h2> <a href="/docs/latest/commands/ft.config-set/"> <code> FT.CONFIG SET </code> </a> | <a href="/docs/latest/commands/ft.config-get/"> <code> FT.CONFIG GET </code> </a> <h2 id="related-topics"> Related topics </h2> <a href="/docs/latest/develop/interact/search-and-query/"> RediSearch </a> <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/ft.config-help/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/networking/mdns/.html

<section class="prose w-full py-12 max-w-none"> <h1> Client prerequisites for mDNS </h1> Requirements for using the mDNS protocol in development and testing environments. <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> mDNS is only supported for development and testing environments. </div> </div> If you choose to use the mDNS protocol when <a href="/docs/latest/operate/rs/networking/cluster-dns/"> you set the cluster name </a> , make sure that the configurations and prerequisites for resolving database endpoints are met on the client machines. If you have <a href="/docs/latest/operate/rs/databases/import-export/replica-of/"> Replica Of </a> databases on the cluster, the configurations and prerequisites are also required for the Redis Enterprise Software nodes. To prepare a client or node for mDNS: <ol> <li> Make sure that the clients and cluster nodes are on the same physical network or have the network infrastructure configured to allow multicasting between them. </li> <li> Install these prerequisite packages: <ul> <li> For Ubuntu: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">apt-get install libnss-mdns </code></pre> </div> </li> <li> For RHEL/CentOS 6.x: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rpm -ivh http://download.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm $ yum install nss-mdns $ service avahi-daemon start </code></pre> </div> </li> <li> For RHEL/CentOS 7: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">$ rpm -ivh https://dl.fedoraproject.org/pub/epel/7/x86_64/Packages/e/epel-release-7-12.noarch.rpm $ yum install nss-mdns $ service avahi-daemon start </code></pre> </div> </li> </ul> </li> <li> If you are using <a href="/docs/latest/operate/rs/networking/multi-ip-ipv6/"> mDNS with IPv6 addresses </a> , update the hosts line in <code> /etc/nsswitch.conf </code> to: <div class="highlight"> <pre class="chroma"><code class="language-yaml" data-lang="yaml">hosts: files mdns4_minimal \[NOTFOUND=return\] mdns </code></pre> </div> </li> </ol> <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/networking/mdns/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/json.get.html

<section class="prose w-full py-12"> <h1 class="command-name"> JSON.GET </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">JSON.GET key [INDENT indent] [NEWLINE newline] [SPACE space] [path [path ...]]</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/json"> JSON 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(N) when path is evaluated to a single value where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key </dd> </dl> Return the value at <code> path </code> in JSON serialized form <a href="#examples"> Examples </a> <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> key </code> </summary> is key to parse. </details> <h2 id="optional-arguments"> Optional arguments </h2> <details open=""> <summary> <code> path </code> </summary> is JSONPath to specify. Default is root <code> $ </code> . JSON.GET accepts multiple <code> path </code> arguments. <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 using a single JSONPath, the root of the matching values is a JSON string with a top-level array of serialized JSON value. In contrast, a legacy path returns a single value. When using multiple JSONPath arguments, the root of the matching values is a JSON string with a top-level object , with each object value being a top-level array of serialized JSON value. In contrast, if all paths are legacy paths, each object value is a single serialized JSON value. If there are multiple paths that include both legacy path and JSONPath, the returned value conforms to the JSONPath version (an array of values). </div> </div> </details> <details open=""> <summary> <code> INDENT </code> </summary> sets the indentation string for nested levels. </details> <details open=""> <summary> <code> NEWLINE </code> </summary> sets the string that's printed at the end of each line. </details> <details open=""> <summary> <code> SPACE </code> </summary> sets the string that's put between a key and a value. </details> <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> Produce pretty-formatted JSON with <code> redis-cli </code> by following this example: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">~/$ redis-cli --raw redis> JSON.GET myjsonkey INDENT "\t" NEWLINE "\n" SPACE " " path.to.value[1]</code></pre> </div> </div> </div> <h2 id="return"> Return </h2> JSON.GET returns a bulk string representing a JSON array of string replies. Each string is the JSON serialization of each JSON value that matches a path. Using multiple paths, JSON.GET returns a bulk string representing a JSON object with string values. Each string value is an array of the JSON serialization of each JSON value that matches a path. For more information about replies, see <a href="/docs/latest/develop/reference/protocol-spec/"> Redis serialization protocol specification </a> . <h2 id="examples"> Examples </h2> <details open=""> <summary> Return the value at <code> path </code> in JSON serialized form </summary> Create a JSON document. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.SET doc $ '{"a":2, "b": 3, "nested": {"a": 4, "b": null}}' OK</code></pre> </div> With a single JSONPath (JSON array bulk string): <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.GET doc $..b "[3,null]"</code></pre> </div> Using multiple paths with at least one JSONPath returns a JSON string with a top-level object with an array of JSON values per path: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> JSON.GET doc ..a $..b "{\"$..b\":[3,null],\"..a\":[2,4]}"</code></pre> </div> </details> <h2 id="see-also"> See also </h2> <a href="/docs/latest/commands/json.set/"> <code> JSON.SET </code> </a> | <a href="/docs/latest/commands/json.mget/"> <code> JSON.MGET </code> </a> <h2 id="related-topics"> Related topics </h2> <ul> <li> <a href="/docs/latest/develop/data-types/json/"> RedisJSON </a> </li> <li> <a href="/docs/latest/develop/interact/search-and-query/indexing/"> Index and search JSON documents </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/commands/json.get/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/script-flush/.html

<section class="prose w-full py-12"> <h1 class="command-name"> SCRIPT FLUSH </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">SCRIPT FLUSH [ASYNC | SYNC]</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"> 2.6.0 </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(N) with N being the number of scripts in cache </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @slow </code> , <code> @scripting </code> , </dd> </dl> Flush the Lua scripts cache. By default, <code> SCRIPT FLUSH </code> will synchronously flush the cache. Starting with Redis 6.2, setting the lazyfree-lazy-user-flush configuration directive to "yes" changes the default flush mode to asynchronous. It is possible to use one of the following modifiers to dictate the flushing mode explicitly: <ul> <li> <code> ASYNC </code> : flushes the cache asynchronously </li> <li> <code> SYNC </code> : flushes the cache synchronously </li> </ul> For more information about <a href="/docs/latest/commands/eval/"> <code> EVAL </code> </a> scripts please refer to <a href="/docs/latest/develop/interact/programmability/eval-intro/"> Introduction to Eval Scripts </a> . <h2 id="behavior-change-history"> Behavior change history </h2> <ul> <li> <code> >= 6.2.0 </code> : Default flush behavior now configurable by the lazyfree-lazy-user-flush configuration directive. </li> </ul> <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> <a href="../../develop/reference/protocol-spec#simple-strings"> Simple string reply </a> : <code> OK </code> . <h2> History </h2> <ul> <li> Starting with Redis version 6.2.0: Added the <code> ASYNC </code> and <code> SYNC </code> flushing mode modifiers. </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/commands/script-flush/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/requests/bdbs/actions/rebalance/.html

<section class="prose w-full py-12 max-w-none"> <h1> Rebalance database requests </h1> REST API requests to rebalance database shards <table> <thead> <tr> <th> Method </th> <th> Path </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="#put-bdbs-actions-rebalance"> PUT </a> </td> <td> <code> /v1/bdbs/{uid}/actions/rebalance </code> </td> <td> Rebalance database shards </td> </tr> </tbody> </table> <h2 id="put-bdbs-actions-rebalance"> Rebalance database shards </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">PUT /v1/bdbs/{int: uid}/actions/rebalance </code></pre> </div> Distributes the database's shards across nodes based on the database's shard placement policy. See <a href="/docs/latest/operate/rs/databases/memory-performance/shard-placement-policy/"> Shard placement policy </a> for more information about shard placement and available policies. <h4 id="required-permissions"> Required permissions </h4> <table> <thead> <tr> <th> Permission name </th> <th> Roles </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_bdb_info"> view_bdb_info </a> </td> <td> admin cluster_member cluster_viewer db_member db_viewer </td> </tr> </tbody> </table> <h3 id="put-request"> Request </h3> <h4 id="example-http-request"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">PUT /bdbs/1/actions/rebalance </code></pre> </div> Dry-run example: <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">PUT /bdbs/1/actions/rebalance?only_failovers=true&dry_run=true </code></pre> </div> <h4 id="url-parameters"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> uid </td> <td> integer </td> <td> The unique ID of the database to rebalance. </td> </tr> </tbody> </table> <h4 id="query-parameters"> Query parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> dry_run </td> <td> boolean </td> <td> If true, returns the blueprint of the rebalanced database without actually changing the database. Default is false. </td> </tr> <tr> <td> only_failovers </td> <td> boolean </td> <td> If true, only runs failovers and no migrations. Default is false. </td> </tr> <tr> <td> max_operations </td> <td> integer </td> <td> Optional. The number of operations to do. Only works if <code> only_failovers </code> is true. If not provided, uses the number of the database's primary-replica pairs. </td> </tr> </tbody> </table> <h3 id="put-response"> Response </h3> <ul> <li> If <code> dry_run </code> is <code> false </code> , returns an <code> action_uid </code> . You can track the action's progress with a <a href="/docs/latest/operate/rs/references/rest-api/requests/actions/#get-action"> <code> GET /v1/actions/<action_uid> </code> </a> request. </li> <li> If <code> dry_run </code> is <code> true </code> , returns the balanced shards' blueprint. You can rearrange shards according to this blueprint if you use it in the <code> shards_blueprint </code> field of a <a href="/docs/latest/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement/#put-bdbs-rearrange-shards"> rearrange database shards </a> request. You should also pass the rebalance shards' <code> cluster-state-id </code> response header as a request header of the rearrange database shards request to make sure the optimized shard placement is relevant for the current cluster state. The cluster will reject the update if its state changed since the optimal shards placement blueprint was generated. </li> </ul> <h4 id="example-response"> Example response </h4> If <code> dry_run </code> is <code> false </code> : <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">{ "action_uid": "21ad01d5-55aa-4ec6-b5c0-44dc95176486" } </code></pre> </div> If <code> dry_run </code> is <code> true </code> : <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">[ { "nodes": [ { "node_uid": "3", "role": "master" }, { "node_uid": "1", "role": "slave" } ], "slot_range": "5461-10922" }, { "nodes": [ { "node_uid": "3", "role": "master" }, { "node_uid": "1", "role": "slave" } ], "slot_range": "10923-16383" }, { "nodes": [ { "node_uid": "3", "role": "master" }, { "node_uid": "1", "role": "slave" } ], "slot_range": "0-5460" } ] </code></pre> </div> <h4 id="put-status-codes"> Status codes </h4> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok"> 200 OK </a> </td> <td> When <code> dry_run </code> is false: The request is accepted and is being processed. When the database is recovered, its status will become active. When <code> dry_run </code> is true: No error. </td> </tr> <tr> <td> <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request"> 400 Bad Request </a> </td> <td> Bad request. Invalid input parameters. </td> </tr> <tr> <td> <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found"> 404 Not Found </a> </td> <td> Attempting to perform an action on a nonexistent database. </td> </tr> <tr> <td> <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable"> 406 Not Acceptable </a> </td> <td> Not enough resources in the cluster to host the database. </td> </tr> <tr> <td> <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict"> 409 Conflict </a> </td> <td> Database is currently busy with another action, recovery is already in progress, or is not in a recoverable state. </td> </tr> <tr> <td> <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error"> 500 Internal Server Error </a> </td> <td> Internal server error. </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/references/rest-api/requests/bdbs/actions/rebalance/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/echo/.html

<section class="prose w-full py-12"> <h1 class="command-name"> ECHO </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">ECHO message</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"> 1.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> @fast </code> , <code> @connection </code> , </dd> </dl> Returns <code> message </code> . <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> ECHO "Hello World!" "Hello World!" </pre> <div class="prompt" style=""> redis> <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#bulk-strings"> Bulk string reply </a> : the given string. <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/echo/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/installing-upgrading/install/prepare-install/.html

<section class="prose w-full py-12 max-w-none"> <h1> Prepare to install Redis Enterprise Software </h1> Prepare to install Redis Enterprise Software. Before you install Redis Enterprise Software: <ul> <li> <a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/prepare-install/download-install-package/"> Download an installation package </a> . </li> <li> <a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/manage-installation-questions/"> View installation questions </a> and optionally prepare answers before installation. </li> <li> Review the <a href="/docs/latest/operate/rs/7.4/security/"> security considerations </a> for your deployment. </li> <li> Check that you have root-level access to each node, either directly or with <code> sudo </code> . </li> <li> Check that all <a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/prepare-install/port-availability/"> required ports are available </a> . </li> <li> <a href="/docs/latest/operate/rs/7.4/installing-upgrading/configuring/linux-swap/"> Turn off Linux swap </a> on all cluster nodes. </li> <li> If you require the <code> redislabs </code> UID (user ID) and GID (group ID) numbers to be the same on all the nodes, create the <code> redislabs </code> user and group with the required numbers on each node. </li> <li> If you want to use Auto Tiering for your databases, see <a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/install-on-linux/#auto-tiering-installation"> Auto Tiering installation </a> . </li> </ul> <h2 id="next-steps"> Next steps </h2> <ul> <li> View <a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/install-script/"> installation script options </a> before starting the installation. </li> <li> <a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/"> Install Redis Enterprise Software </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/installing-upgrading/install/prepare-install/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/integrate/redis-data-integration/data-pipelines/deploy/.html

<section class="prose w-full py-12 max-w-none"> <h1> Deploy a pipeline </h1> Learn how to deploy an RDI pipeline The sections below explain how to deploy a pipeline after you have created the required <a href="/docs/latest/integrate/redis-data-integration/data-pipelines/data-pipelines/"> configuration </a> . <h2 id="set-secrets"> Set secrets </h2> Before you deploy your pipeline, you must set the authentication secrets for the source and target databases. Each secret has a corresponding property name that you can pass to the <a href="/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-set-secret/"> <code> redis-di set-secret </code> </a> command to set the property's value. You can then refer to these properties in <code> config.yaml </code> using the syntax " <code> ${PROPERTY_NAME} </code> " (the sample <a href="#the-configyaml-file"> config.yaml file </a> shows these properties in use). For example, you would use the following command line to set the source database username to <code> myUserName </code> : <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis-di set-secret SOURCE_DB_USERNAME myUserName </code></pre> </div> The table below shows the property name for each secret. Note that the username and password are required for the source and target, but the other secrets are only relevant to TLS/mTLS connections. <table> <thead> <tr> <th style="text-align:left"> Property name </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> <code> SOURCE_DB_USERNAME </code> </td> <td style="text-align:left"> Username for the source database </td> </tr> <tr> <td style="text-align:left"> <code> SOURCE_DB_PASSWORD </code> </td> <td style="text-align:left"> Password for the source database </td> </tr> <tr> <td style="text-align:left"> <code> SOURCE_DB_CACERT </code> </td> <td style="text-align:left"> (For TLS only) Source database trust certificate </td> </tr> <tr> <td style="text-align:left"> <code> SOURCE_DB_KEY </code> </td> <td style="text-align:left"> (For mTLS only) Source database private key </td> </tr> <tr> <td style="text-align:left"> <code> SOURCE_DB_CERT </code> </td> <td style="text-align:left"> (For mTLS only) Source database public key </td> </tr> <tr> <td style="text-align:left"> <code> SOURCE_DB_KEY_PASSWORD </code> </td> <td style="text-align:left"> (For mTLS only) Source database private key password </td> </tr> <tr> <td style="text-align:left"> <code> TARGET_DB_USERNAME </code> </td> <td style="text-align:left"> Username for the target database </td> </tr> <tr> <td style="text-align:left"> <code> TARGET_DB_PASSWORD </code> </td> <td style="text-align:left"> Password for the target database </td> </tr> <tr> <td style="text-align:left"> <code> TARGET_DB_CACERT </code> </td> <td style="text-align:left"> (For TLS only) Target database trust certificate </td> </tr> <tr> <td style="text-align:left"> <code> TARGET_DB_KEY </code> </td> <td style="text-align:left"> (For mTLS only) Target database private key </td> </tr> <tr> <td style="text-align:left"> <code> TARGET_DB_CERT </code> </td> <td style="text-align:left"> (For mTLS only) Target database public key </td> </tr> <tr> <td style="text-align:left"> <code> TARGET_DB_KEY_PASSWORD </code> </td> <td style="text-align:left"> (For mTLS only) Target database private key password </td> </tr> </tbody> </table> <h2 id="deploy-a-pipeline"> Deploy a pipeline </h2> When you have created your configuration, including the <a href="/docs/latest/integrate/redis-data-integration/data-pipelines/data-pipelines/#job-files"> jobs </a> , use the <a href="/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-deploy/"> <code> redis-di deploy </code> </a> command to deploy them: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis-di deploy --dir <path to pipeline folder> </code></pre> </div> You can also deploy a pipeline using <a href="/docs/latest/develop/tools/insight/rdi-connector/"> Redis Insight </a> . <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/integrate/redis-data-integration/data-pipelines/deploy/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/objects/.html

<section class="prose w-full py-12 max-w-none"> <h1> Redis Enterprise REST API objects </h1> Documents the objects used with Redis Enterprise Software REST API calls. Certain <a href="/docs/latest/operate/rs/references/rest-api/requests/"> REST API requests </a> require you to include specific objects in the request body. Many requests also return objects in the response body. Both REST API requests and responses represent these objects as <a href="https://www.json.org"> JSON </a> . <table> <thead> <tr> <th style="text-align:left"> Object </th> <th style="text-align:left"> Description </th> </tr> </thead> <tbody> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/action/"> action </a> </td> <td style="text-align:left"> An object that represents cluster actions </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/alert/"> alert </a> </td> <td style="text-align:left"> An object that contains alert info </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/"> bdb </a> </td> <td style="text-align:left"> An object that represents a database </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/bdb_group/"> bdb_group </a> </td> <td style="text-align:left"> An object that represents a group of databases with a shared memory pool </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/bootstrap/"> bootstrap </a> </td> <td style="text-align:left"> An object for bootstrap configuration </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/check_result/"> check_result </a> </td> <td style="text-align:left"> An object that contains the results of a cluster check </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/cluster/"> cluster </a> </td> <td style="text-align:left"> An object that represents a cluster </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/cluster_settings/"> cluster_settings </a> </td> <td style="text-align:left"> An object for cluster resource management settings </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/cm_settings/"> cm_settings </a> </td> <td style="text-align:left"> A REST API object that represents Cluster Manager UI settings </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb/"> crdb </a> </td> <td style="text-align:left"> An object that represents an Active-Active database </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/crdb_task/"> crdb_task </a> </td> <td style="text-align:left"> An object that represents a CRDB task </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/db_alerts_settings/"> db_alerts_settings </a> </td> <td style="text-align:left"> An object for database alerts configuration </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/db-conns-auditing-config/"> db_conns_auditing_config </a> </td> <td style="text-align:left"> An object for database connection auditing settings </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/job_scheduler/"> job_scheduler </a> </td> <td style="text-align:left"> An object for job scheduler settings </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/jwt_authorize/"> jwt_authorize </a> </td> <td style="text-align:left"> An object for user authentication or a JW token refresh request </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/ldap/"> ldap </a> </td> <td style="text-align:left"> An object that contains the cluster's LDAP configuration </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/ldap_mapping/"> ldap_mapping </a> </td> <td style="text-align:left"> An object that represents a mapping between an LDAP group and roles </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/module/"> module </a> </td> <td style="text-align:left"> An object that represents a Redis module </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/node/"> node </a> </td> <td style="text-align:left"> An object that represents a node in the cluster </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/ocsp/"> ocsp </a> </td> <td style="text-align:left"> An object that represents the cluster's OCSP configuration </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/ocsp_status/"> ocsp_status </a> </td> <td style="text-align:left"> An object that represents the cluster's OCSP status </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/proxy/"> proxy </a> </td> <td style="text-align:left"> An object that represents a proxy in the cluster </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/redis_acl/"> redis_acl </a> </td> <td style="text-align:left"> An object that represents a Redis access control list (ACL) </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/role/"> role </a> </td> <td style="text-align:left"> An object that represents a role </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/services_configuration/"> services_configuration </a> </td> <td style="text-align:left"> An object for optional cluster services settings </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/shard/"> shard </a> </td> <td style="text-align:left"> An object that represents a database shard </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/state-machine/"> state-machine </a> </td> <td style="text-align:left"> An object that represents a state machine. </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/statistics/"> statistics </a> </td> <td style="text-align:left"> An object that contains metrics for clusters, databases, nodes, or shards </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/suffix/"> suffix </a> </td> <td style="text-align:left"> An object that represents a DNS suffix </td> </tr> <tr> <td style="text-align:left"> <a href="/docs/latest/operate/rs/references/rest-api/objects/user/"> user </a> </td> <td style="text-align:left"> An API object that represents a Redis Enterprise user </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/references/rest-api/objects/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/installing-upgrading/install/offline-installation/.html

<section class="prose w-full py-12 max-w-none"> <h1> Offline installation </h1> If you install Redis Enterprise Software on a machine with no internet connection, you need to perform two tasks manually. By default, the installation process requires an internet connection to enable installing dependency packages and for <a href="/docs/latest/operate/rs/7.4/clusters/configure/sync-clocks/"> synchronizing the operating system clock </a> against an NTP server. If you install Redis Enterprise Software on a machine without an internet connection, you need to perform two tasks manually. <h2 id="install-required-dependency-packages"> Install required dependency packages </h2> When you install Redis Enterprise Software on a machine that is not connected to the internet, the installation process fails and displays an error message informing you it failed to automatically install dependencies. Review the installation steps in the console to see which missing dependencies the process attempted to install. Install all these dependency packages and then run the installation again. <h2 id="set-up-ntp-time-synchronization"> Set up NTP time synchronization </h2> At the end of the installation, the process asks if you want to set up NTP time synchronization. If you choose <code> Yes </code> while you are not connected to the internet, the action fails and displays the appropriate error message, but the installation completes successfully. Despite the successful completion of the installation, you still have to configure all nodes for <a href="/docs/latest/operate/rs/7.4/clusters/configure/sync-clocks/"> NTP time synchronization </a> . <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/installing-upgrading/install/offline-installation/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/tdigest.min.html

<section class="prose w-full py-12"> <h1 class="command-name"> TDIGEST.MIN </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">TDIGEST.MIN key</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/probabilistic"> Bloom 2.4.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(1) </dd> </dl> Returns the minimum observation value from a t-digest sketch. <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> key </code> </summary> is key name for an existing t-digest sketch. </details> <h2 id="return-value"> Return value </h2> <a href="/docs/latest/develop/reference/protocol-spec/#simple-strings"> Simple string reply </a> of minimum observation value from a sketch. The result is always accurate. 'nan' if the sketch is empty. <h2 id="examples"> Examples </h2> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> TDIGEST.CREATE t OK redis> TDIGEST.MIN t "nan" redis> TDIGEST.ADD t 3 4 1 2 5 OK redis> TDIGEST.MIN t "1"</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/commands/tdigest.min/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/cf.insert.html

<section class="prose w-full py-12"> <h1 class="command-name"> CF.INSERT </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">CF.INSERT key [CAPACITY capacity] [NOCREATE] ITEMS item [item ...]</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/probabilistic"> Bloom 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(n * (k + i)), where n is the number of items, k is the number of sub-filters and i is maxIterations </dd> </dl> Adds one or more items to a cuckoo filter, allowing the filter to be created with a custom capacity if it does not exist yet. This command is similar to <a href="/docs/latest/commands/cf.add/"> <code> CF.ADD </code> </a> , except that more than one item can be added and capacity can be specified. <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> key </code> </summary> is key name for a cuckoo filter to add items to. If <code> key </code> does not exist - a new cuckoo filter is created. </details> <details open=""> <summary> <code> ITEMS item... </code> </summary> One or more items to add. </details> <h2 id="optional-arguments"> Optional arguments </h2> <details open=""> <summary> <code> CAPACITY capacity </code> </summary> Specifies the desired capacity of the new filter, if this filter does not exist yet. If the filter already exists, then this parameter is ignored. If the filter does not exist yet and this parameter is not specified, then the filter is created with the module-level default capacity which is 1024. See <a href="/docs/latest/commands/cf.reserve/"> <code> CF.RESERVE </code> </a> for more information on cuckoo filter capacities. </details> <details open=""> <summary> <code> NOCREATE </code> </summary> If specified, prevents automatic filter creation if the filter does not exist (Instead, an error is returned). This option is mutually exclusive with <code> CAPACITY </code> . </details> <h2 id="return-value"> Return value </h2> Returns one of these replies: <ul> <li> <a href="/docs/latest/develop/reference/protocol-spec/#arrays"> Array reply </a> of <a href="/docs/latest/develop/reference/protocol-spec/#integers"> Integer reply </a> - where "1" means that the item has been successfully added to the filter, and "-1" means that the item was not added because the filter is full. </li> <li> [] on error (invalid arguments, wrong key type, and so on) and also when <code> NOCREATE </code> is specified and <code> key </code> does not exist. </li> </ul> <h2 id="examples"> Examples </h2> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> CF.INSERT cf CAPACITY 1000 ITEMS item1 item2 1) (integer) 1 2) (integer) 1</code></pre> </div> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> CF.INSERT cf1 CAPACITY 1000 NOCREATE ITEMS item1 item2 (error) ERR not found</code></pre> </div> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> CF.RESERVE cf2 2 BUCKETSIZE 1 EXPANSION 0 OK redis> CF.INSERT cf2 ITEMS 1 1 1 1 1) (integer) 1 2) (integer) 1 3) (integer) -1 4) (integer) -1</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/commands/cf.insert/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/kubernetes/release-notes/previous-releases/k8s-5-4-10-8/.html

<section class="prose w-full py-12 max-w-none"> <h1> Redis Enterprise for Kubernetes Release Notes 5.4.10-8 (January 2020) </h1> Support for the Redis Enterprise Software 5.4.10 and multiple enhancements. <a href="https://github.com/RedisLabs/redis-enterprise-k8s-docs/releases/tag/5.4.10-8"> Redis Enterprise for Kubernetes 5.4.10-8 </a> is now available. This release includes Redis Enterprise (RS) version <a href="/docs/latest/operate/rs/release-notes/legacy-release-notes/rs-5-4-10-december-2019/"> 5.4.10-22 </a> and introduces new feature and bug fixes. <h2 id="overview"> Overview </h2> This is a maintenance release providing support for the Redis Enterprise Software release 5.4.10 and includes multiple enhancements. Follow these <a href="/docs/latest/operate/kubernetes/upgrade/upgrade-redis-cluster/"> instructions </a> for upgrading to this Kubernetes operator release. <h2 id="new-features"> New features </h2> <ul> <li> All-in-one deployment bundle and documentation enhancements - This release is the easiest to deploy yet, with a new quick start guide and an all-in-one file bundle for deploying the Redis Enterprise Operator. GitHub documentation was enhanced to cover advanced deployment scenarios with the complete reference to the custom resource specifications, guides, and examples. <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> <pre><code>Pay special attention to the yaml file naming changes and new yaml files that have been created for this release. These are highlighted in the quick start guide. </code></pre> </div> </div> </li> <li> Rack Awareness - Support for the [Redis Software Rack Awareness][/docs/latest/operate/rs/clusters/configure/rack-zone-awareness/] feature was introduced to the Kubernetes deployment. It enables deploying nodes to different zones, in a multi-zone Kubernetes cluster. Databases that are rack-aware will have the cluster populate their master shard and replica shards in different nodes, across different zones or failure domains. This enables maintaining data persistence in case of zone failure. </li> <li> OLM Support - Redis Enterprise for Kubernetes is now RedHat OpenShift certified and can be effortlessly configured and deployed in Kubernetes clusters supporting OLM, including OpenShift 4.x clusters, with just a few clicks. OLM based deployments do not require Kubernetes cluster administrator rights to deploy the operator. </li> <li> Improve cluster nodes' pod scheduling resiliency - Redis Enterprise Cluster pod scheduling is hardened by implementing Kubernetes best practices and providing configuration recommendations to cluster operators. Scheduling resiliency minimizes the chance of cluster node pods eviction or failure to schedule. See the top 4 articles in the new <a href="https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/92a2eff4b8c4ccafac459138f12e5f38acde825c/docs/topics.md#additional-topics"> Additonal Topics </a> documentation section. </li> <li> Update app.redislabs.com API version to stable - We've updated the Redis Enterprise Cluster custom resource API from <a href="https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-versioning"> alpha to stable </a> to reflect the current state of maturity of our implementation. </li> </ul> <a href="https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/"> Both versions of the API are supported </a> by Kubernetes versions that support specifying multiple API versions. For legacy Kubernetes versions, deployment files are available in the documentation repository that utilize the alpha version of the API. <h2 id="information"> Information </h2> <ul> <li> This new release deprecates the Redis Enterprise Operator support for legacy Kubernetes version 1.8. </li> </ul> <h2 id="known-limitations"> Known limitations </h2> <ul> <li> Custom Resource Definition Changes - In order to comply with OLM best practices, a change was required to the Redis Enterprise Cluster Custom Resource Defintion (CRD) to introduce the status sub-resource. As a result of this change, any upgrade from an older release to this release requires a change to the CRD. Once the CRD is updated, all Redis Enterprise Clusters in the same K8s cluster must be updated to the latest release in order to continue operating properly. </li> <li> Cluster Recovery - </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/kubernetes/release-notes/previous-releases/k8s-5-4-10-8/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/clusters/configure/.html

<section class="prose w-full py-12 max-w-none"> <h1> Configure clusters </h1> Configuration options for your Redis Enterprise cluster. You can manage your Redis Enterprise Software clusters with several different tools: <ul> <li> Cluster Manager UI (the web-based user interface) </li> <li> Command-line tools ( <a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/"> rladmin </a> , <a href="/docs/latest/develop/tools/cli/"> redis-cli </a> , <a href="/docs/latest/operate/rs/references/cli-utilities/crdb-cli/"> crdb-cli </a> ) </li> <li> <a href="/docs/latest/operate/rs/references/rest-api/"> REST API </a> </li> </ul> <nav> <a href="/docs/latest/operate/rs/clusters/configure/cluster-settings/"> Cluster settings </a> You can view and set various cluster settings such as cluster name, email service, time zone, and license. <a href="/docs/latest/operate/rs/clusters/configure/license-keys/"> Cluster license keys </a> The cluster key (or license) enables features and capacity within Redis Enterprise Software <a href="/docs/latest/operate/rs/clusters/configure/sync-clocks/"> Synchronize cluster node clocks </a> Sync node clocks to avoid problems with internal custer communication. <a href="/docs/latest/operate/rs/clusters/configure/rack-zone-awareness/"> Rack-zone awareness in Redis Enterprise Software </a> Rack-zone awareness ensures high availability in the event of a rack or zone failure. </nav> <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/clusters/configure/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/cf.exists.html

<section class="prose w-full py-12"> <h1 class="command-name"> CF.EXISTS </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">CF.EXISTS key item</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/probabilistic"> Bloom 1.0.0 </a> </dd> <dt class="font-semibold text-redis-ink-900 m-0"> Time complexity: </dt> <dd class="m-0"> O(k), where k is the number of sub-filters </dd> </dl> Determines whether a given item was added to a cuckoo filter. This command is similar to <a href="/docs/latest/commands/cf.mexists/"> <code> CF.MEXISTS </code> </a> , except that only one item can be checked. <h2 id="required-arguments"> Required arguments </h2> <details open=""> <summary> <code> key </code> </summary> is key name for a cuckoo filter. </details> <details open=""> <summary> <code> item </code> </summary> is an item to check. </details> <h2 id="return-value"> Return value </h2> Returns one of these replies: <ul> <li> <a href="/docs/latest/develop/reference/protocol-spec/#integers"> Integer reply </a> , where <code> 1 </code> means that, with high probability, <code> item </code> had already been added to the filter, and <code> 0 </code> means that <code> key </code> does not exist or that <code> item </code> had not been added to the filter. See note in <a href="/docs/latest/commands/cf.del/"> <code> CF.DEL </code> </a> . </li> <li> [] on error (invalid arguments, wrong key type, and so on) </li> </ul> <h2 id="examples"> Examples </h2> <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">redis> CF.ADD cf item1 (integer) 1 redis> CF.EXISTS cf item1 (integer) 1 redis> CF.EXISTS cf item2 (integer) 0</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/commands/cf.exists/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/hexists/.html

<section class="prose w-full py-12"> <h1 class="command-name"> HEXISTS </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">HEXISTS key field</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"> 2.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> @read </code> , <code> @hash </code> , <code> @fast </code> , </dd> </dl> Returns if <code> field </code> is an existing field in the hash stored at <code> key </code> . <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> HSET myhash field1 "foo" (integer) 1 redis> HEXISTS myhash field1 (integer) 1 redis> HEXISTS myhash field2 (integer) 0 </pre> <div class="prompt" style=""> redis> <input autocomplete="off" name="prompt" spellcheck="false" type="text"/> </div> </form> <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> One of the following: <ul> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> 0 </code> if the hash does not contain the field, or the key does not exist. </li> <li> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : <code> 1 </code> if the hash contains the field. </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/commands/hexists/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/get-started/faq/.html

<section class="prose w-full py-12"> <h1> Redis FAQ </h1> Commonly asked questions when getting started with Redis <h2 id="how-is-redis-different-from-other-key-value-stores"> How is Redis different from other key-value stores? </h2> <ul> <li> Redis has a different evolution path in the key-value DBs where values can contain more complex data types, with atomic operations defined on those data types. Redis data types are closely related to fundamental data structures and are exposed to the programmer as such, without additional abstraction layers. </li> <li> Redis is an in-memory but persistent on disk database, so it represents a different trade off where very high write and read speed is achieved with the limitation of data sets that can't be larger than memory. Another advantage of in-memory databases is that the memory representation of complex data structures is much simpler to manipulate compared to the same data structures on disk, so Redis can do a lot with little internal complexity. At the same time the two on-disk storage formats (RDB and AOF) don't need to be suitable for random access, so they are compact and always generated in an append-only fashion (Even the AOF log rotation is an append-only operation, since the new version is generated from the copy of data in memory). However this design also involves different challenges compared to traditional on-disk stores. Being the main data representation on memory, Redis operations must be carefully handled to make sure there is always an updated version of the data set on disk. </li> </ul> <h2 id="whats-the-redis-memory-footprint"> What's the Redis memory footprint? </h2> To give you a few examples (all obtained using 64-bit instances): <ul> <li> An empty instance uses ~ 3MB of memory. </li> <li> 1 Million small Keys -> String Value pairs use ~ 85MB of memory. </li> <li> 1 Million Keys -> Hash value, representing an object with 5 fields, use ~ 160 MB of memory. </li> </ul> Testing your use case is trivial. Use the <code> redis-benchmark </code> utility to generate random data sets then check the space used with the <code> INFO memory </code> command. 64-bit systems will use considerably more memory than 32-bit systems to store the same keys, especially if the keys and values are small. This is because pointers take 8 bytes in 64-bit systems. But of course the advantage is that you can have a lot of memory in 64-bit systems, so in order to run large Redis servers a 64-bit system is more or less required. The alternative is sharding. <h2 id="why-does-redis-keep-its-entire-dataset-in-memory"> Why does Redis keep its entire dataset in memory? </h2> In the past the Redis developers experimented with Virtual Memory and other systems in order to allow larger than RAM datasets, but after all we are very happy if we can do one thing well: data served from memory, disk used for storage. So for now there are no plans to create an on disk backend for Redis. Most of what Redis is, after all, a direct result of its current design. If your real problem is not the total RAM needed, but the fact that you need to split your data set into multiple Redis instances, please read the <a href="/docs/latest/operate/oss_and_stack/management/scaling/"> partitioning page </a> in this documentation for more info. Redis Ltd., the company sponsoring Redis development, has developed a "Redis on Flash" solution that uses a mixed RAM/flash approach for larger data sets with a biased access pattern. You may check their offering for more information, however this feature is not part of the Redis Community Edition code base. <h2 id="can-you-use-redis-with-a-disk-based-database"> Can you use Redis with a disk-based database? </h2> Yes, a common design pattern involves taking very write-heavy small data in Redis (and data you need the Redis data structures to model your problem in an efficient way), and big blobs of data into an SQL or eventually consistent on-disk database. Similarly sometimes Redis is used in order to take in memory another copy of a subset of the same data stored in the on-disk database. This may look similar to caching, but actually is a more advanced model since normally the Redis dataset is updated together with the on-disk DB dataset, and not refreshed on cache misses. <h2 id="how-can-i-reduce-redis-overall-memory-usage"> How can I reduce Redis' overall memory usage? </h2> A good practice is to consider memory consumption when mapping your logical data model to the physical data model within Redis. These considerations include using specific data types, key patterns, and normalization. Beyond data modeling, there is more info in the <a href="/docs/latest/operate/oss_and_stack/management/optimization/memory-optimization/"> Memory Optimization page </a> . <h2 id="what-happens-if-redis-runs-out-of-memory"> What happens if Redis runs out of memory? </h2> Redis has built-in protections allowing the users to set a max limit on memory usage, using the <code> maxmemory </code> option in the configuration file to put a limit to the memory Redis can use. If this limit is reached, Redis will start to reply with an error to write commands (but will continue to accept read-only commands). You can also configure Redis to evict keys when the max memory limit is reached. See the <a href="/docs/latest/develop/reference/eviction/"> eviction policy docs </a> for more information on this. <h2 id="background-saving-fails-with-a-fork-error-on-linux"> Background saving fails with a fork() error on Linux? </h2> Short answer: <code> echo 1 > /proc/sys/vm/overcommit_memory </code> :) And now the long one: The Redis background saving schema relies on the copy-on-write semantic of the <code> fork </code> system call in modern operating systems: Redis forks (creates a child process) that is an exact copy of the parent. The child process dumps the DB on disk and finally exits. In theory the child should use as much memory as the parent being a copy, but actually thanks to the copy-on-write semantic implemented by most modern operating systems the parent and child process will share the common memory pages. A page will be duplicated only when it changes in the child or in the parent. Since in theory all the pages may change while the child process is saving, Linux can't tell in advance how much memory the child will take, so if the <code> overcommit_memory </code> setting is set to zero the fork will fail unless there is as much free RAM as required to really duplicate all the parent memory pages. If you have a Redis dataset of 3 GB and just 2 GB of free memory it will fail. Setting <code> overcommit_memory </code> to 1 tells Linux to relax and perform the fork in a more optimistic allocation fashion, and this is indeed what you want for Redis. You can refer to the <a href="http://man7.org/linux/man-pages/man5/proc.5.html"> proc(5) </a> man page for explanations of the available values. <h2 id="are-redis-on-disk-snapshots-atomic"> Are Redis on-disk snapshots atomic? </h2> Yes, the Redis background saving process is always forked when the server is outside of the execution of a command, so every command reported to be atomic in RAM is also atomic from the point of view of the disk snapshot. <h2 id="how-can-redis-use-multiple-cpus-or-cores"> How can Redis use multiple CPUs or cores? </h2> It's not very frequent that CPU becomes your bottleneck with Redis, as usually Redis is either memory or network bound. For instance, when using pipelining a Redis instance running on an average Linux system can deliver 1 million requests per second, so if your application mainly uses O(N) or O(log(N)) commands, it is hardly going to use too much CPU. However, to maximize CPU usage you can start multiple instances of Redis in the same box and treat them as different servers. At some point a single box may not be enough anyway, so if you want to use multiple CPUs you can start thinking of some way to shard earlier. You can find more information about using multiple Redis instances in the <a href="/docs/latest/operate/oss_and_stack/management/scaling/"> Partitioning page </a> . As of version 4.0, Redis has started implementing threaded actions. For now this is limited to deleting objects in the background and blocking commands implemented via Redis modules. For subsequent releases, the plan is to make Redis more and more threaded. <h2 id="what-is-the-maximum-number-of-keys-a-single-redis-instance-can-hold-what-is-the-maximum-number-of-elements-in-a-hash-list-set-and-sorted-set"> What is the maximum number of keys a single Redis instance can hold? What is the maximum number of elements in a Hash, List, Set, and Sorted Set? </h2> Redis can handle up to 2^32 keys, and was tested in practice to handle at least 250 million keys per instance. Every hash, list, set, and sorted set, can hold 2^32 elements. In other words your limit is likely the available memory in your system. <h2 id="why-does-my-replica-have-a-different-number-of-keys-its-master-instance"> Why does my replica have a different number of keys its master instance? </h2> If you use keys with limited time to live (Redis expires) this is normal behavior. This is what happens: <ul> <li> The primary generates an RDB file on the first synchronization with the replica. </li> <li> The RDB file will not include keys already expired in the primary but which are still in memory. </li> <li> These keys are still in the memory of the Redis primary, even if logically expired. They'll be considered non-existent, and their memory will be reclaimed later, either incrementally or explicitly on access. While these keys are not logically part of the dataset, they are accounted for in the <a href="/docs/latest/commands/info/"> <code> INFO </code> </a> output and in the <a href="/docs/latest/commands/dbsize/"> <code> DBSIZE </code> </a> command. </li> <li> When the replica reads the RDB file generated by the primary, this set of keys will not be loaded. </li> </ul> Because of this, it's common for users with many expired keys to see fewer keys in the replicas. However, logically, the primary and replica will have the same content. <h2 id="where-does-the-name-redis-come-from"> Where does the name "Redis" come from? </h2> Redis is an acronym that stands for RE mote DI ctionary S erver. <h2 id="why-did-salvatore-sanfilippo-start-the-redis-project"> Why did Salvatore Sanfilippo start the Redis project? </h2> Salvatore originally created Redis to scale <a href="https://github.com/antirez/lloogg"> LLOOGG </a> , a real-time log analysis tool. But after getting the basic Redis server working, he decided to share the work with other people and turn Redis into an open source project. <h2 id="how-is-redis-pronounced"> How is Redis pronounced? </h2> "Redis" (/ˈrɛd-ɪs/) is pronounced like the word "red" plus the word "kiss" without the "k". <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/get-started/faq/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/config-rewrite/.html

<section class="prose w-full py-12"> <h1 class="command-name"> CONFIG REWRITE </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">CONFIG REWRITE</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"> 2.8.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> @admin </code> , <code> @slow </code> , <code> @dangerous </code> , </dd> </dl> The <code> CONFIG REWRITE </code> command rewrites the <code> redis.conf </code> file the server was started with, applying the minimal changes needed to make it reflect the configuration currently used by the server, which may be different compared to the original one because of the use of the <a href="/docs/latest/commands/config-set/"> <code> CONFIG SET </code> </a> command. The rewrite is performed in a very conservative way: <ul> <li> Comments and the overall structure of the original redis.conf are preserved as much as possible. </li> <li> If an option already exists in the old redis.conf file, it will be rewritten at the same position (line number). </li> <li> If an option was not already present, but it is set to its default value, it is not added by the rewrite process. </li> <li> If an option was not already present, but it is set to a non-default value, it is appended at the end of the file. </li> <li> Non used lines are blanked. For instance if you used to have multiple <code> save </code> directives, but the current configuration has fewer or none as you disabled RDB persistence, all the lines will be blanked. </li> </ul> CONFIG REWRITE is also able to rewrite the configuration file from scratch if the original one no longer exists for some reason. However if the server was started without a configuration file at all, the CONFIG REWRITE will just return an error. <h2 id="atomic-rewrite-process"> Atomic rewrite process </h2> In order to make sure the redis.conf file is always consistent, that is, on errors or crashes you always end with the old file, or the new one, the rewrite is performed with a single <code> write(2) </code> call that has enough content to be at least as big as the old file. Sometimes additional padding in the form of comments is added in order to make sure the resulting file is big enough, and later the file gets truncated to remove the padding at the end. <h2 id="resp2resp3-reply"> RESP2/RESP3 Reply </h2> <a href="../../develop/reference/protocol-spec#simple-strings"> Simple string reply </a> : <code> OK </code> when the configuration was rewritten properly. Otherwise an error is returned. <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/config-rewrite/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/interact/programmability/lua-api/.html

<section class="prose w-full py-12"> <h1> Redis Lua API reference </h1> Executing Lua in Redis Redis includes an embedded <a href="https://www.lua.org/"> Lua 5.1 </a> interpreter. The interpreter runs user-defined <a href="/docs/latest/develop/interact/programmability/eval-intro/"> ephemeral scripts </a> and <a href="/docs/latest/develop/interact/programmability/functions-intro/"> functions </a> . Scripts run in a sandboxed context and can only access specific Lua packages. This page describes the packages and APIs available inside the execution's context. <h2 id="sandbox-context"> Sandbox context </h2> The sandboxed Lua context attempts to prevent accidental misuse and reduce potential threats from the server's environment. Scripts should never try to access the Redis server's underlying host systems. That includes the file system, network, and any other attempt to perform a system call other than those supported by the API. Scripts should operate solely on data stored in Redis and data provided as arguments to their execution. <h3 id="global-variables-and-functions"> Global variables and functions </h3> The sandboxed Lua execution context blocks the declaration of global variables and functions. The blocking of global variables is in place to ensure that scripts and functions don't attempt to maintain any runtime context other than the data stored in Redis. In the (somewhat uncommon) use case that a context needs to be maintain between executions, you should store the context in Redis' keyspace. Redis will return a "Script attempted to create global variable 'my_global_variable" error when trying to execute the following snippet: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">my_global_variable = 'some value' </code></pre> </div> And similarly for the following global function declaration: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">function my_global_function() -- Do something amazing end </code></pre> </div> You'll also get a similar error when your script attempts to access any global variables that are undefined in the runtime's context: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">-- The following will surely raise an error return an_undefined_global_variable </code></pre> </div> Instead, all variable and function definitions are required to be declared as local. To do so, you'll need to prepend the <a href="https://www.lua.org/manual/5.1/manual.html#2.4.7"> local </a> keyword to your declarations. For example, the following snippet will be considered perfectly valid by Redis: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">local my_local_variable = 'some value' local function my_local_function() -- Do something else, but equally amazing end </code></pre> </div> Note: the sandbox attempts to prevent the use of globals. Using Lua's debugging functionality or other approaches such as altering the meta table used for implementing the globals' protection to circumvent the sandbox isn't hard. However, it is difficult to circumvent the protection by accident. If the user messes with the Lua global state, the consistency of AOF and replication can't be guaranteed. In other words, just don't do it. <h3 id="imported-lua-modules"> Imported Lua modules </h3> Using imported Lua modules is not supported inside the sandboxed execution context. The sandboxed execution context prevents the loading modules by disabling Lua's <a href="https://www.lua.org/pil/8.1.html"> <code> require </code> function </a> . The only libraries that Redis ships with and that you can use in scripts are listed under the <a href="#runtime-libraries"> Runtime libraries </a> section. <h2 id="runtime-globals"> Runtime globals </h2> While the sandbox prevents users from declaring globals, the execution context is pre-populated with several of these. <h3 id="the-_redis_-singleton"> The redis singleton </h3> The redis singleton is an object instance that's accessible from all scripts. It provides the API to interact with Redis from scripts. Its description follows <a href="#redis_object"> below </a> . <h3 id="the-keys-global-variable"> The KEYS global variable </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: no </li> </ul> Important: to ensure the correct execution of scripts, both in standalone and clustered deployments, all names of keys that a function accesses must be explicitly provided as input key arguments. The script should only access keys whose names are given as input arguments. Scripts should never access keys with programmatically-generated names or based on the contents of data structures stored in the database. The KEYS global variable is available only for <a href="/docs/latest/develop/interact/programmability/eval-intro/"> ephemeral scripts </a> . It is pre-populated with all key name input arguments. <h3 id="the-argv-global-variable"> The ARGV global variable </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: no </li> </ul> The ARGV global variable is available only in <a href="/docs/latest/develop/interact/programmability/eval-intro/"> ephemeral scripts </a> . It is pre-populated with all regular input arguments. <h2 id="redis_object"> redis object </h2> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> The Redis Lua execution context always provides a singleton instance of an object named redis . The redis instance enables the script to interact with the Redis server that's running it. Following is the API provided by the redis object instance. <h3 id="redis.call"> <code> redis.call(command [,arg...]) </code> </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> The <code> redis.call() </code> function calls a given Redis command and returns its reply. Its inputs are the command and arguments, and once called, it executes the command in Redis and returns the reply. For example, we can call the <a href="/docs/latest/commands/echo/"> <code> ECHO </code> </a> command from a script and return its reply like so: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">return redis.call('ECHO', 'Echo, echo... eco... o...') </code></pre> </div> If and when <code> redis.call() </code> triggers a runtime exception, the raw exception is raised back to the user as an error, automatically. Therefore, attempting to execute the following ephemeral script will fail and generate a runtime exception because <a href="/docs/latest/commands/echo/"> <code> ECHO </code> </a> accepts exactly one argument: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">redis> EVAL "return redis.call('ECHO', 'Echo,', 'echo... ', 'eco... ', 'o...')" 0 (error) ERR Wrong number of args calling Redis command from script script: b0345693f4b77517a711221050e76d24ae60b7f7, on @user_script:1. </code></pre> </div> Note that the call can fail due to various reasons, see <a href="/docs/latest/develop/interact/programmability/eval-intro/#execution-under-low-memory-conditions"> Execution under low memory conditions </a> and <a href="#script_flags"> Script flags </a> To handle Redis runtime errors use <code> redis.pcall() </code> instead. <h3 id="redis.pcall"> <code> redis.pcall(command [,arg...]) </code> </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> This function enables handling runtime errors raised by the Redis server. The <code> redis.pcall() </code> function behaves exactly like <a href="#redis.call"> <code> redis.call() </code> </a> , except that it: <ul> <li> Always returns a reply. </li> <li> Never throws a runtime exception, and returns in its stead a <a href="#redis.error_reply"> <code> redis.error_reply </code> </a> in case that a runtime exception is thrown by the server. </li> </ul> The following demonstrates how to use <code> redis.pcall() </code> to intercept and handle runtime exceptions from within the context of an ephemeral script. <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">local reply = redis.pcall('ECHO', unpack(ARGV)) if reply['err'] ~= nil then -- Handle the error sometime, but for now just log it redis.log(redis.LOG_WARNING, reply['err']) reply['err'] = 'ERR Something is wrong, but no worries, everything is under control' end return reply </code></pre> </div> Evaluating this script with more than one argument will return: <pre tabindex="0"><code>redis> EVAL "..." 0 hello world (error) ERR Something is wrong, but no worries, everything is under control </code></pre> <h3 id="redis.error_reply"> <code> redis.error_reply(x) </code> </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> This is a helper function that returns an <a href="/docs/latest/develop/reference/protocol-spec/#simple-errors"> error reply </a> . The helper accepts a single string argument and returns a Lua table with the err field set to that string. The outcome of the following code is that error1 and error2 are identical for all intents and purposes: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">local text = 'ERR My very special error' local reply1 = { err = text } local reply2 = redis.error_reply(text) </code></pre> </div> Therefore, both forms are valid as means for returning an error reply from scripts: <pre tabindex="0"><code>redis> EVAL "return { err = 'ERR My very special table error' }" 0 (error) ERR My very special table error redis> EVAL "return redis.error_reply('ERR My very special reply error')" 0 (error) ERR My very special reply error </code></pre> For returning Redis status replies refer to <a href="#redis.status_reply"> <code> redis.status_reply() </code> </a> . Refer to the <a href="#data-type-conversion"> Data type conversion </a> for returning other response types. Note: By convention, Redis uses the first word of an error string as a unique error code for specific errors or <code> ERR </code> for general-purpose errors. Scripts are advised to follow this convention, as shown in the example above, but this is not mandatory. <h3 id="redis.status_reply"> <code> redis.status_reply(x) </code> </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> This is a helper function that returns a <a href="/docs/latest/develop/reference/protocol-spec#simple-strings"> simple string reply </a> . "OK" is an example of a standard Redis status reply. The Lua API represents status replies as tables with a single field, ok , set with a simple status string. The outcome of the following code is that status1 and status2 are identical for all intents and purposes: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">local text = 'Frosty' local status1 = { ok = text } local status2 = redis.status_reply(text) </code></pre> </div> Therefore, both forms are valid as means for returning status replies from scripts: <pre tabindex="0"><code>redis> EVAL "return { ok = 'TICK' }" 0 TICK redis> EVAL "return redis.status_reply('TOCK')" 0 TOCK </code></pre> For returning Redis error replies refer to <a href="#redis.error_reply"> <code> redis.error_reply() </code> </a> . Refer to the <a href="#data-type-conversion"> Data type conversion </a> for returning other response types. <h3 id="redis.sha1hex"> <code> redis.sha1hex(x) </code> </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> This function returns the SHA1 hexadecimal digest of its single string argument. You can, for example, obtain the empty string's SHA1 digest: <pre tabindex="0"><code>redis> EVAL "return redis.sha1hex('')" 0 "da39a3ee5e6b4b0d3255bfef95601890afd80709" </code></pre> <h3 id="redis.log"> <code> redis.log(level, message) </code> </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> This function writes to the Redis server log. It expects two input arguments: the log level and a message. The message is a string to write to the log file. Log level can be on of these: <ul> <li> <code> redis.LOG_DEBUG </code> </li> <li> <code> redis.LOG_VERBOSE </code> </li> <li> <code> redis.LOG_NOTICE </code> </li> <li> <code> redis.LOG_WARNING </code> </li> </ul> These levels map to the server's log levels. The log only records messages equal or greater in level than the server's <code> loglevel </code> configuration directive. The following snippet: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">redis.log(redis.LOG_WARNING, 'Something is terribly wrong') </code></pre> </div> will produce a line similar to the following in your server's log: <pre tabindex="0"><code>[32343] 22 Mar 15:21:39 # Something is terribly wrong </code></pre> <h3 id="redis.setresp"> <code> redis.setresp(x) </code> </h3> <ul> <li> Since version: 6.0.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> This function allows the executing script to switch between <a href="/docs/latest/develop/reference/protocol-spec/"> Redis Serialization Protocol (RESP) </a> versions for the replies returned by <a href="#redis.call"> <code> redis.call() </code> </a> and <a href="#redis.pcall"> <code> redis.pcall() </code> </a> . It expects a single numerical argument as the protocol's version. The default protocol version is 2 , but it can be switched to version 3 . Here's an example of switching to RESP3 replies: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">redis.setresp(3) </code></pre> </div> Please refer to the <a href="#data-type-conversion"> Data type conversion </a> for more information about type conversions. <h3 id="redis.set_repl"> <code> redis.set_repl(x) </code> </h3> <ul> <li> Since version: 3.2.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: no </li> </ul> Note: this feature is only available when script effects replication is employed. Calling it when using verbatim script replication will result in an error. As of Redis version 2.6.0, scripts were replicated verbatim, meaning that the scripts' source code was sent for execution by replicas and stored in the AOF. An alternative replication mode added in version 3.2.0 allows replicating only the scripts' effects. As of Redis version 7.0, script replication is no longer supported, and the only replication mode available is script effects replication. Warning: this is an advanced feature. Misuse can cause damage by violating the contract that binds the Redis master, its replicas, and AOF contents to hold the same logical content. This function allows a script to assert control over how its effects are propagated to replicas and the AOF afterward. A script's effects are the Redis write commands that it calls. By default, all write commands that a script executes are replicated. Sometimes, however, better control over this behavior can be helpful. This can be the case, for example, when storing intermediate values in the master alone. Consider a script that intersects two sets and stores the result in a temporary key with <a href="/docs/latest/commands/sunionstore/"> <code> SUNIONSTORE </code> </a> . It then picks five random elements ( <a href="/docs/latest/commands/srandmember/"> <code> SRANDMEMBER </code> </a> ) from the intersection and stores ( <a href="/docs/latest/commands/sadd/"> <code> SADD </code> </a> ) them in another set. Finally, before returning, it deletes the temporary key that stores the intersection of the two source sets. In this case, only the new set with its five randomly-chosen elements needs to be replicated. Replicating the <a href="/docs/latest/commands/sunionstore/"> <code> SUNIONSTORE </code> </a> command and the <a href="/docs/latest/commands/del/"> <code> DEL </code> </a> ition of the temporary key is unnecessary and wasteful. The <code> redis.set_repl() </code> function instructs the server how to treat subsequent write commands in terms of replication. It accepts a single input argument that only be one of the following: <ul> <li> <code> redis.REPL_ALL </code> : replicates the effects to the AOF and replicas. </li> <li> <code> redis.REPL_AOF </code> : replicates the effects to the AOF alone. </li> <li> <code> redis.REPL_REPLICA </code> : replicates the effects to the replicas alone. </li> <li> <code> redis.REPL_SLAVE </code> : same as <code> REPL_REPLICA </code> , maintained for backward compatibility. </li> <li> <code> redis.REPL_NONE </code> : disables effect replication entirely. </li> </ul> By default, the scripting engine is initialized to the <code> redis.REPL_ALL </code> setting when a script begins its execution. You can call the <code> redis.set_repl() </code> function at any time during the script's execution to switch between the different replication modes. A simple example follows: <div class="highlight"> <pre class="chroma"><code class="language-lua" data-lang="lua">redis.replicate_commands() -- Enable effects replication in versions lower than Redis v7.0 redis.call('SET', KEYS[1], ARGV[1]) redis.set_repl(redis.REPL_NONE) redis.call('SET', KEYS[2], ARGV[2]) redis.set_repl(redis.REPL_ALL) redis.call('SET', KEYS[3], ARGV[3]) </code></pre> </div> If you run this script by calling <code> EVAL "..." 3 A B C 1 2 3 </code> , the result will be that only the keys A and C are created on the replicas and AOF. <h3 id="redis.replicate_commands"> <code> redis.replicate_commands() </code> </h3> <ul> <li> Since version: 3.2.0 </li> <li> Until version: 7.0.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: no </li> </ul> This function switches the script's replication mode from verbatim replication to effects replication. You can use it to override the default verbatim script replication mode used by Redis until version 7.0. Note: as of Redis v7.0, verbatim script replication is no longer supported. The default, and only script replication mode supported, is script effects' replication. For more information, please refer to <a href="/docs/latest/develop/interact/programmability/eval-intro/#replicating-commands-instead-of-scripts"> <code> Replicating commands instead of scripts </code> </a> <h3 id="redis.breakpoint"> <code> redis.breakpoint() </code> </h3> <ul> <li> Since version: 3.2.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: no </li> </ul> This function triggers a breakpoint when using the <a href="/docs/latest/develop/interact/programmability/lua-debugging/"> Redis Lua debugger </a> . <h3 id="redis.debug"> <code> redis.debug(x) </code> </h3> <ul> <li> Since version: 3.2.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: no </li> </ul> This function prints its argument in the <a href="/docs/latest/develop/interact/programmability/lua-debugging/"> Redis Lua debugger </a> console. <h3 id="redis.acl_check_cmd"> <code> redis.acl_check_cmd(command [,arg...]) </code> </h3> <ul> <li> Since version: 7.0.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> This function is used for checking if the current user running the script has <a href="/docs/latest/operate/oss_and_stack/management/security/acl/"> ACL </a> permissions to execute the given command with the given arguments. The return value is a boolean <code> true </code> in case the current user has permissions to execute the command (via a call to <a href="#redis.call"> redis.call </a> or <a href="#redis.pcall"> redis.pcall </a> ) or <code> false </code> in case they don't. The function will raise an error if the passed command or its arguments are invalid. <h3 id="redis.register_function"> <code> redis.register_function </code> </h3> <ul> <li> Since version: 7.0.0 </li> <li> Available in scripts: no </li> <li> Available in functions: yes </li> </ul> This function is only available from the context of the <a href="/docs/latest/commands/function-load/"> <code> FUNCTION LOAD </code> </a> command. When called, it registers a function to the loaded library. The function can be called either with positional or named arguments. <h4 id="redis.register_function_pos_args"> positional arguments: <code> redis.register_function(name, callback) </code> </h4> The first argument to <code> redis.register_function </code> is a Lua string representing the function name. The second argument to <code> redis.register_function </code> is a Lua function. Usage example: <pre tabindex="0"><code>redis> FUNCTION LOAD "#!lua name=mylib\n redis.register_function('noop', function() end)" </code></pre> <h4 id="redis.register_function_named_args"> Named arguments: <code> redis.register_function{function_name=name, callback=callback, flags={flag1, flag2, ..}, description=description} </code> </h4> The named arguments variant accepts the following arguments: <ul> <li> function_name : the function's name. </li> <li> callback : the function's callback. </li> <li> flags : an array of strings, each a function flag (optional). </li> <li> description : function's description (optional). </li> </ul> Both function_name and callback are mandatory. Usage example: <pre tabindex="0"><code>redis> FUNCTION LOAD "#!lua name=mylib\n redis.register_function{function_name='noop', callback=function() end, flags={ 'no-writes' }, description='Does nothing'}" </code></pre> <h4 id="script_flags"> Script flags </h4> Important: Use script flags with care, which may negatively impact if misused. Note that the default for Eval scripts are different than the default for functions that are mentioned below, see <a href="/docs/latest/develop/interact/programmability/eval-intro#eval-flags"> Eval Flags </a> When you register a function or load an Eval script, the server does not know how it accesses the database. By default, Redis assumes that all scripts read and write data. This results in the following behavior: <ol> <li> They can read and write data. </li> <li> They can run in cluster mode, and are not able to run commands accessing keys of different hash slots. </li> <li> Execution against a stale replica is denied to avoid inconsistent reads. </li> <li> Execution under low memory is denied to avoid exceeding the configured threshold. </li> </ol> You can use the following flags and instruct the server to treat the scripts' execution differently: <ul> <li> <code> no-writes </code> : this flag indicates that the script only reads data but never writes. By default, Redis will deny the execution of flagged scripts (Functions and Eval scripts with <a href="/docs/latest/develop/interact/programmability/eval-intro/#eval-flags"> shebang </a> ) against read-only replicas, as they may attempt to perform writes. Similarly, the server will not allow calling scripts with <a href="/docs/latest/commands/fcall_ro/"> <code> FCALL_RO </code> </a> / <a href="/docs/latest/commands/eval_ro/"> <code> EVAL_RO </code> </a> . Lastly, when data persistence is at risk due to a disk error, execution is blocked as well. Using this flag allows executing the script: <ol> <li> With <a href="/docs/latest/commands/fcall_ro/"> <code> FCALL_RO </code> </a> / <a href="/docs/latest/commands/eval_ro/"> <code> EVAL_RO </code> </a> </li> <li> On read-only replicas. </li> <li> Even if there's a disk error (Redis is unable to persist so it rejects writes). </li> <li> When over the memory limit since it implies the script doesn't increase memory consumption (see <code> allow-oom </code> below) </li> </ol> However, note that the server will return an error if the script attempts to call a write command. Also note that currently <a href="/docs/latest/commands/publish/"> <code> PUBLISH </code> </a> , <a href="/docs/latest/commands/spublish/"> <code> SPUBLISH </code> </a> and <a href="/docs/latest/commands/pfcount/"> <code> PFCOUNT </code> </a> are also considered write commands in scripts, because they could attempt to propagate commands to replicas and AOF file. For more information please refer to <a href="/docs/latest/develop/interact/programmability/#read-only_scripts"> Read-only scripts </a> </li> <li> <code> allow-oom </code> : use this flag to allow a script to execute when the server is out of memory (OOM). Unless used, Redis will deny the execution of flagged scripts (Functions and Eval scripts with <a href="/docs/latest/develop/interact/programmability/eval-intro/#eval-flags"> shebang </a> ) when in an OOM state. Furthermore, when you use this flag, the script can call any Redis command, including commands that aren't usually allowed in this state. Specifying <code> no-writes </code> or using <a href="/docs/latest/commands/fcall_ro/"> <code> FCALL_RO </code> </a> / <a href="/docs/latest/commands/eval_ro/"> <code> EVAL_RO </code> </a> also implies the script can run in OOM state (without specifying <code> allow-oom </code> ) </li> <li> <code> allow-stale </code> : a flag that enables running the flagged scripts (Functions and Eval scripts with <a href="/docs/latest/develop/interact/programmability/eval-intro/#eval-flags"> shebang </a> ) against a stale replica when the <code> replica-serve-stale-data </code> config is set to <code> no </code> . Redis can be set to prevent data consistency problems from using old data by having stale replicas return a runtime error. For scripts that do not access the data, this flag can be set to allow stale Redis replicas to run the script. Note however that the script will still be unable to execute any command that accesses stale data. </li> <li> <code> no-cluster </code> : the flag causes the script to return an error in Redis cluster mode. Redis allows scripts to be executed both in standalone and cluster modes. Setting this flag prevents executing the script against nodes in the cluster. </li> <li> <code> allow-cross-slot-keys </code> : The flag that allows a script to access keys from multiple slots. Redis typically prevents any single command from accessing keys that hash to multiple slots. This flag allows scripts to break this rule and access keys within the script that access multiple slots. Declared keys to the script are still always required to hash to a single slot. Accessing keys from multiple slots is discouraged as applications should be designed to only access keys from a single slot at a time, allowing slots to move between Redis servers. This flag has no effect when cluster mode is disabled. </li> </ul> Please refer to <a href="/docs/latest/develop/interact/programmability/functions-intro#function-flags"> Function Flags </a> and <a href="/docs/latest/develop/interact/programmability/eval-intro#eval-flags"> Eval Flags </a> for a detailed example. <h3 id="redis.redis_version"> <code> redis.REDIS_VERSION </code> </h3> <ul> <li> Since version: 7.0.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> Returns the current Redis server version as a Lua string. The reply's format is <code> MM.mm.PP </code> , where: <ul> <li> MM: is the major version. </li> <li> mm: is the minor version. </li> <li> PP: is the patch level. </li> </ul> <h3 id="redis.redis_version_num"> <code> redis.REDIS_VERSION_NUM </code> </h3> <ul> <li> Since version: 7.0.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> Returns the current Redis server version as a number. The reply is a hexadecimal value structured as <code> 0x00MMmmPP </code> , where: <ul> <li> MM: is the major version. </li> <li> mm: is the minor version. </li> <li> PP: is the patch level. </li> </ul> <h2 id="data-type-conversion"> Data type conversion </h2> Unless a runtime exception is raised, <code> redis.call() </code> and <code> redis.pcall() </code> return the reply from the executed command to the Lua script. Redis' replies from these functions are converted automatically into Lua's native data types. Similarly, when a Lua script returns a reply with the <code> return </code> keyword, that reply is automatically converted to Redis' protocol. Put differently; there's a one-to-one mapping between Redis' replies and Lua's data types and a one-to-one mapping between Lua's data types and the <a href="/docs/latest/develop/reference/protocol-spec/"> Redis Protocol </a> data types. The underlying design is such that if a Redis type is converted into a Lua type and converted back into a Redis type, the result is the same as the initial value. Type conversion from Redis protocol replies (i.e., the replies from <code> redis.call() </code> and <code> redis.pcall() </code> ) to Lua data types depends on the Redis Serialization Protocol version used by the script. The default protocol version during script executions is RESP2. The script may switch the replies' protocol versions by calling the <code> redis.setresp() </code> function. Type conversion from a script's returned Lua data type depends on the user's choice of protocol (see the <a href="/docs/latest/commands/hello/"> <code> HELLO </code> </a> command). The following sections describe the type conversion rules between Lua and Redis per the protocol's version. <h3 id="resp2-to-lua-type-conversion"> RESP2 to Lua type conversion </h3> The following type conversion rules apply to the execution's context by default as well as after calling <code> redis.setresp(2) </code> : <ul> <li> <a href="/docs/latest/develop/reference/protocol-spec#integers"> RESP2 integer reply </a> -> Lua number </li> <li> <a href="/docs/latest/develop/reference/protocol-spec#bulk-strings"> RESP2 bulk string reply </a> -> Lua string </li> <li> <a href="/docs/latest/develop/reference/protocol-spec#arrays"> RESP2 array reply </a> -> Lua table (may have other Redis data types nested) </li> <li> <a href="/docs/latest/develop/reference/protocol-spec#simple-strings"> RESP2 status reply </a> -> Lua table with a single ok field containing the status string </li> <li> <a href="/docs/latest/develop/reference/protocol-spec#simple-errors"> RESP2 error reply </a> -> Lua table with a single err field containing the error string </li> <li> <a href="/docs/latest/develop/reference/protocol-spec#bulk-strings"> RESP2 null bulk reply </a> and <a href="/docs/latest/develop/reference/protocol-spec#arrays"> RESP2 null multi-bulk reply </a> -> Lua false boolean type </li> </ul> <h2 id="lua-to-resp2-type-conversion"> Lua to RESP2 type conversion </h2> The following type conversion rules apply by default as well as after the user had called <code> HELLO 2 </code> : <ul> <li> Lua number -> <a href="/docs/latest/develop/reference/protocol-spec#integers"> RESP2 integer reply </a> (the number is converted into an integer) </li> <li> Lua string -> <a href="/docs/latest/develop/reference/protocol-spec#bulk-strings"> RESP2 bulk string reply </a> </li> <li> Lua table (indexed, non-associative array) -> <a href="/docs/latest/develop/reference/protocol-spec#arrays"> RESP2 array reply </a> (truncated at the first Lua <code> nil </code> value encountered in the table, if any) </li> <li> Lua table with a single ok field -> <a href="/docs/latest/develop/reference/protocol-spec#simple-strings"> RESP2 status reply </a> </li> <li> Lua table with a single err field -> <a href="/docs/latest/develop/reference/protocol-spec#simple-errors"> RESP2 error reply </a> </li> <li> Lua boolean false -> <a href="/docs/latest/develop/reference/protocol-spec#bulk-strings"> RESP2 null bulk reply </a> </li> </ul> There is an additional Lua-to-Redis conversion rule that has no corresponding Redis-to-Lua conversion rule: <ul> <li> Lua Boolean <code> true </code> -> <a href="/docs/latest/develop/reference/protocol-spec#integers"> RESP2 integer reply </a> with value of 1. </li> </ul> There are three additional rules to note about converting Lua to Redis data types: <ul> <li> Lua has a single numerical type, Lua numbers. There is no distinction between integers and floats. So we always convert Lua numbers into integer replies, removing the decimal part of the number, if any. If you want to return a Lua float, it should be returned as a string , exactly like Redis itself does (see, for instance, the <a href="/docs/latest/commands/zscore/"> <code> ZSCORE </code> </a> command). </li> <li> There's <a href="http://www.lua.org/pil/19.1.html"> no simple way to have nils inside Lua arrays </a> due to Lua's table semantics. Therefore, when Redis converts a Lua array to RESP, the conversion stops when it encounters a Lua <code> nil </code> value. </li> <li> When a Lua table is an associative array that contains keys and their respective values, the converted Redis reply will not include them. </li> </ul> Lua to RESP2 type conversion examples: <pre tabindex="0"><code>redis> EVAL "return 10" 0 (integer) 10 redis> EVAL "return { 1, 2, { 3, 'Hello World!' } }" 0 1) (integer) 1 2) (integer) 2 3) 1) (integer) 3 1) "Hello World!" redis> EVAL "return redis.call('get','foo')" 0 "bar" </code></pre> The last example demonstrates receiving and returning the exact return value of <code> redis.call() </code> (or <code> redis.pcall() </code> ) in Lua as it would be returned if the command had been called directly. The following example shows how floats and arrays that cont nils and keys are handled: <pre tabindex="0"><code>redis> EVAL "return { 1, 2, 3.3333, somekey = 'somevalue', 'foo', nil , 'bar' }" 0 1) (integer) 1 2) (integer) 2 3) (integer) 3 4) "foo" </code></pre> As you can see, the float value of 3.333 gets converted to an integer 3 , the somekey key and its value are omitted, and the string "bar" isn't returned as there is a <code> nil </code> value that precedes it. <h3 id="resp3-to-lua-type-conversion"> RESP3 to Lua type conversion </h3> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md"> RESP3 </a> is a newer version of the <a href="/docs/latest/develop/reference/protocol-spec/"> Redis Serialization Protocol </a> . It is available as an opt-in choice as of Redis v6.0. An executing script may call the <a href="#redis.setresp"> <code> redis.setresp </code> </a> function during its execution and switch the protocol version that's used for returning replies from Redis' commands (that can be invoked via <a href="#redis.call"> <code> redis.call() </code> </a> or <a href="#redis.pcall"> <code> redis.pcall() </code> </a> ). Once Redis' replies are in RESP3 protocol, all of the <a href="#resp2-to-lua-type-conversion"> RESP2 to Lua conversion </a> rules apply, with the following additions: <ul> <li> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#map-type"> RESP3 map reply </a> -> Lua table with a single map field containing a Lua table representing the fields and values of the map. </li> <li> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#set-reply"> RESP set reply </a> -> Lua table with a single set field containing a Lua table representing the elements of the set as fields, each with the Lua Boolean value of <code> true </code> . </li> <li> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#null-reply"> RESP3 null </a> -> Lua <code> nil </code> . </li> <li> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#boolean-reply"> RESP3 true reply </a> -> Lua true boolean value. </li> <li> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#boolean-reply"> RESP3 false reply </a> -> Lua false boolean value. </li> <li> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#double-type"> RESP3 double reply </a> -> Lua table with a single double field containing a Lua number representing the double value. </li> <li> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#big-number-type"> RESP3 big number reply </a> -> Lua table with a single big_number field containing a Lua string representing the big number value. </li> <li> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#verbatim-string-type"> Redis verbatim string reply </a> -> Lua table with a single verbatim_string field containing a Lua table with two fields, string and format , representing the verbatim string and its format, respectively. </li> </ul> Note: the RESP3 <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#big-number-type"> big number </a> and <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#verbatim-string-type"> verbatim strings </a> replies are only supported as of Redis v7.0 and greater. Also, presently, RESP3's <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#attribute-type"> attributes </a> , <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#streamed-strings"> streamed strings </a> and <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#streamed-aggregate-data-types"> streamed aggregate data types </a> are not supported by the Redis Lua API. <h3 id="lua-to-resp3-type-conversion"> Lua to RESP3 type conversion </h3> Regardless of the script's choice of protocol version set for replies with the [ <code> redis.setresp() </code> function] when it calls <code> redis.call() </code> or <code> redis.pcall() </code> , the user may opt-in to using RESP3 (with the <code> HELLO 3 </code> command) for the connection. Although the default protocol for incoming client connections is RESP2, the script should honor the user's preference and return adequately-typed RESP3 replies, so the following rules apply on top of those specified in the <a href="#lua-to-resp2-type-conversion"> Lua to RESP2 type conversion </a> section when that is the case. <ul> <li> Lua Boolean -> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#boolean-reply"> RESP3 Boolean reply </a> (note that this is a change compared to the RESP2, in which returning a Boolean Lua <code> true </code> returned the number 1 to the Redis client, and returning a <code> false </code> used to return a <code> null </code> . </li> <li> Lua table with a single map field set to an associative Lua table -> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#map-type"> RESP3 map reply </a> . </li> <li> Lua table with a single set field set to an associative Lua table -> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#set-type"> RESP3 set reply </a> . Values can be set to anything and are discarded anyway. </li> <li> Lua table with a single double field to an associative Lua table -> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#double-type"> RESP3 double reply </a> . </li> <li> Lua nil -> <a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#null-reply"> RESP3 null </a> . </li> </ul> However, if the connection is set use the RESP2 protocol, and even if the script replies with RESP3-typed responses, Redis will automatically perform a RESP3 to RESP2 conversion of the reply as is the case for regular commands. That means, for example, that returning the RESP3 map type to a RESP2 connection will result in the reply being converted to a flat RESP2 array that consists of alternating field names and their values, rather than a RESP3 map. <h2 id="additional-notes-about-scripting"> Additional notes about scripting </h2> <h3 id="using-select-inside-scripts"> Using <code> SELECT </code> inside scripts </h3> You can call the <a href="/docs/latest/commands/select/"> <code> SELECT </code> </a> command from your Lua scripts, like you can with any normal client connection. However, one subtle aspect of the behavior changed between Redis versions 2.8.11 and 2.8.12. Prior to Redis version 2.8.12, the database selected by the Lua script was set as the current database for the client connection that had called it. As of Redis version 2.8.12, the database selected by the Lua script only affects the execution context of the script, and does not modify the database that's selected by the client calling the script. This semantic change between patch level releases was required since the old behavior was inherently incompatible with Redis' replication and introduced bugs. <h2 id="runtime-libraries"> Runtime libraries </h2> The Redis Lua runtime context always comes with several pre-imported libraries. The following <a href="https://www.lua.org/manual/5.1/manual.html#5"> standard Lua libraries </a> are available to use: <ul> <li> The <a href="https://www.lua.org/manual/5.1/manual.html#5.4"> String Manipulation (string) library </a> </li> <li> The <a href="https://www.lua.org/manual/5.1/manual.html#5.5"> Table Manipulation (table) library </a> </li> <li> The <a href="https://www.lua.org/manual/5.1/manual.html#5.6"> Mathematical Functions (math) library </a> </li> <li> The <a href="#os-library"> Operating System Facilities (os) library </a> </li> </ul> In addition, the following external libraries are loaded and accessible to scripts: <ul> <li> The <a href="#struct-library"> struct library </a> </li> <li> The <a href="#cjson-library"> cjson library </a> </li> <li> The <a href="#cmsgpack-library"> cmsgpack library </a> </li> <li> The <a href="#bitop-library"> bitop library </a> </li> </ul> <h3 id="os-library"> os library </h3> <ul> <li> Since version: 7.4 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> os provides a set of functions for dealing with date, time, and system commands. More details can be found in the <a href="https://www.lua.org/manual/5.1/manual.html#5.8"> Operating System Facilities </a> . Note that for sandbox security, currently only the following os functions is exposed: <ul> <li> <code> os.clock() </code> </li> </ul> <h3 id="struct-library"> struct library </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> struct is a library for packing and unpacking C-like structures in Lua. It provides the following functions: <ul> <li> <a href="#struct.pack"> <code> struct.pack() </code> </a> </li> <li> <a href="#struct.unpack"> <code> struct.unpack() </code> </a> </li> <li> <a href="#struct.size"> <code> struct.size() </code> </a> </li> </ul> All of struct 's functions expect their first argument to be a <a href="#struct-formats"> format string </a> . <h4 id="struct-formats"> struct formats </h4> The following are valid format strings for struct 's functions: <ul> <li> <code> > </code> : big endian </li> <li> <code> < </code> : little endian </li> <li> <code> ![num] </code> : alignment </li> <li> <code> x </code> : padding </li> <li> <code> b/B </code> : signed/unsigned byte </li> <li> <code> h/H </code> : signed/unsigned short </li> <li> <code> l/L </code> : signed/unsigned long </li> <li> <code> T </code> : size_t </li> <li> <code> i/In </code> : signed/unsigned integer with size n (defaults to the size of int) </li> <li> <code> cn </code> : sequence of n chars (from/to a string); when packing, n == 0 means the whole string; when unpacking, n == 0 means use the previously read number as the string's length. </li> <li> <code> s </code> : zero-terminated string </li> <li> <code> f </code> : float </li> <li> <code> d </code> : double </li> <li> <code> </code> (space): ignored </li> </ul> <h4 id="struct.pack"> <code> struct.pack(x) </code> </h4> This function returns a struct-encoded string from values. It accepts a <a href="#struct-formats"> struct format string </a> as its first argument, followed by the values that are to be encoded. Usage example: <pre tabindex="0"><code>redis> EVAL "return struct.pack('HH', 1, 2)" 0 "\x01\x00\x02\x00" </code></pre> <h4 id="struct.unpack"> <code> struct.unpack(x) </code> </h4> This function returns the decoded values from a struct. It accepts a <a href="#struct-formats"> struct format string </a> as its first argument, followed by encoded struct's string. Usage example: <pre tabindex="0"><code>redis> EVAL "return { struct.unpack('HH', ARGV[1]) }" 0 "\x01\x00\x02\x00" 1) (integer) 1 2) (integer) 2 3) (integer) 5 </code></pre> <h4 id="struct.size"> <code> struct.size(x) </code> </h4> This function returns the size, in bytes, of a struct. It accepts a <a href="#struct-formats"> struct format string </a> as its only argument. Usage example: <pre tabindex="0"><code>redis> EVAL "return struct.size('HH')" 0 (integer) 4 </code></pre> <h3 id="cjson-library"> cjson library </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> The cjson library provides fast <a href="https://json.org"> JSON </a> encoding and decoding from Lua. It provides these functions. <h4 id="cjson.encode"> <code> cjson.encode(x) </code> </h4> This function returns a JSON-encoded string for the Lua data type provided as its argument. Usage example: <pre tabindex="0"><code>redis> EVAL "return cjson.encode({ ['foo'] = 'bar' })" 0 "{\"foo\":\"bar\"}" </code></pre> <h4 id="cjsondecodex-cjsondecode"> <code> cjson.decode(x) </code> {#cjson.decode()} </h4> This function returns a Lua data type from the JSON-encoded string provided as its argument. Usage example: <pre tabindex="0"><code>redis> EVAL "return cjson.decode(ARGV[1])['foo']" 0 '{"foo":"bar"}' "bar" </code></pre> <h3 id="cmsgpack-library"> cmsgpack library </h3> <ul> <li> Since version: 2.6.0 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> The cmsgpack library provides fast <a href="https://msgpack.org/index.html"> MessagePack </a> encoding and decoding from Lua. It provides these functions. <h4 id="cmsgpackpackx-cmsgpackpack"> <code> cmsgpack.pack(x) </code> {#cmsgpack.pack()} </h4> This function returns the packed string encoding of the Lua data type it is given as an argument. Usage example: <pre tabindex="0"><code>redis> EVAL "return cmsgpack.pack({'foo', 'bar', 'baz'})" 0 "\x93\xa3foo\xa3bar\xa3baz" </code></pre> <h4 id="cmsgpackunpackx-cmsgpackunpack"> <code> cmsgpack.unpack(x) </code> {#cmsgpack.unpack()} </h4> This function returns the unpacked values from decoding its input string argument. Usage example: <pre tabindex="0"><code>redis> EVAL "return cmsgpack.unpack(ARGV[1])" 0 "\x93\xa3foo\xa3bar\xa3baz" 1) "foo" 2) "bar" 3) "baz" </code></pre> <h3 id="bitop-library"> bit library </h3> <ul> <li> Since version: 2.8.18 </li> <li> Available in scripts: yes </li> <li> Available in functions: yes </li> </ul> The bit library provides bitwise operations on numbers. Its documentation resides at <a href="http://bitop.luajit.org/api.html"> Lua BitOp documentation </a> It provides the following functions. <h4 id="bittobitx-bittobit"> <code> bit.tobit(x) </code> {#bit.tobit()} </h4> Normalizes a number to the numeric range for bit operations and returns it. Usage example: <pre tabindex="0"><code>redis> EVAL 'return bit.tobit(1)' 0 (integer) 1 </code></pre> <h4 id="bittohexx-n-bittohex"> <code> bit.tohex(x [,n]) </code> {#bit.tohex()} </h4> Converts its first argument to a hex string. The number of hex digits is given by the absolute value of the optional second argument. Usage example: <pre tabindex="0"><code>redis> EVAL 'return bit.tohex(422342)' 0 "000671c6" </code></pre> <h4 id="bitbnotx-bitbnot"> <code> bit.bnot(x) </code> {#bit.bnot()} </h4> Returns the bitwise not of its argument. <h4 id="bit.ops"> <code> bit.bnot(x) </code> <code> bit.bor(x1 [,x2...]) </code> , <code> bit.band(x1 [,x2...]) </code> and <code> bit.bxor(x1 [,x2...]) </code> </h4> Returns either the bitwise or , bitwise and , or bitwise xor of all of its arguments. Note that more than two arguments are allowed. Usage example: <pre tabindex="0"><code>redis> EVAL 'return bit.bor(1,2,4,8,16,32,64,128)' 0 (integer) 255 </code></pre> <h4 id="bit.shifts"> <code> bit.lshift(x, n) </code> , <code> bit.rshift(x, n) </code> and <code> bit.arshift(x, n) </code> </h4> Returns either the bitwise logical left-shift , bitwise logical right-shift , or bitwise arithmetic right-shift of its first argument by the number of bits given by the second argument. <h4 id="bit.ro"> <code> bit.rol(x, n) </code> and <code> bit.ror(x, n) </code> </h4> Returns either the bitwise left rotation , or bitwise right rotation of its first argument by the number of bits given by the second argument. Bits shifted out on one side are shifted back in on the other side. <h4 id="bitbswapx-bitbswap"> <code> bit.bswap(x) </code> {#bit.bswap()} </h4> Swaps the bytes of its argument and returns it. This can be used to convert little-endian 32-bit numbers to big-endian 32-bit numbers and vice versa. <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/interact/programmability/lua-api/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/requests/bdbs/syncer_state/.html

<section class="prose w-full py-12 max-w-none"> <h1> Syncer state requests </h1> Syncer state requests <table> <thead> <tr> <th> Method </th> <th> Path </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="#get-syncer-state"> GET </a> </td> <td> <code> /v1/bdbs/{uid}/syncer_state </code> </td> <td> Get a CRDB's syncer state </td> </tr> </tbody> </table> <h2 id="get-syncer-state"> Get syncer state </h2> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /v1/bdbs/{int: uid}/syncer_state </code></pre> </div> Get a CRDB's syncer state as JSON. <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"> Warning: </div> This endpoint is deprecated as of Redis Enterprise Software version 7.2.4 and will be removed in a future release. Use <a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt/"> <code> /v1/bdbs/<uid>/syncer_state/crdt </code> </a> instead. </div> </div> <h3 id="permissions"> Permissions </h3> <table> <thead> <tr> <th> Permission name </th> <th> Roles </th> </tr> </thead> <tbody> <tr> <td> <a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_bdb_info"> view_bdb_info </a> </td> <td> admin cluster_member cluster_viewer db_member db_viewer </td> </tr> </tbody> </table> <h3 id="get-request"> Request </h3> <h4 id="example-http-request"> Example HTTP request </h4> <div class="highlight"> <pre class="chroma"><code class="language-sh" data-lang="sh">GET /v1/bdbs/1/syncer_state </code></pre> </div> <h4 id="headers"> Headers </h4> <table> <thead> <tr> <th> Key </th> <th> Value </th> </tr> </thead> <tbody> <tr> <td> Host </td> <td> The domain name or IP of the cluster. </td> </tr> <tr> <td> Accept </td> <td> application/json </td> </tr> </tbody> </table> <h4 id="url-parameters"> URL parameters </h4> <table> <thead> <tr> <th> Field </th> <th> Type </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> uid </td> <td> integer </td> <td> The unique ID of the database requested. </td> </tr> </tbody> </table> <h3 id="get-response"> Response </h3> Returns a JSON object that represents the syncer state. <h4 id="example-json-body"> Example JSON body </h4> <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "DB": 22, "RunID": 1584086516, // additional fields... } </code></pre> </div> <h4 id="get-status-codes"> Status codes </h4> <table> <thead> <tr> <th> Code </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1"> 200 OK </a> </td> <td> OK </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"> 404 Not Found </a> </td> <td> Syncer state key does not exist </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"> 500 Internal Server Error </a> </td> <td> Internal error </td> </tr> <tr> <td> <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4"> 503 Service Unavailable </a> </td> <td> Redis connection error, service unavailable </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/rest-api/requests/bdbs/syncer_state/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/rest-api/objects/user/.html

<section class="prose w-full py-12 max-w-none"> <h1> User object </h1> An API object that represents a Redis Enterprise user <table> <thead> <tr> <th> Name </th> <th> Type/Value </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> uid </td> <td> integer </td> <td> User's unique ID </td> </tr> <tr> <td> account_id </td> <td> integer </td> <td> SM account ID </td> </tr> <tr> <td> action_uid </td> <td> string </td> <td> Action UID. If it exists, progress can be tracked by the <code> GET </code> <code> /actions/{uid} </code> API request (read-only) </td> </tr> <tr> <td> auth_method </td> <td> 'regular' 'certificate' 'entraid' </td> <td> User's authentication method </td> </tr> <tr> <td> bdbs_email_alerts </td> <td> complex object </td> <td> UIDs of databases that user will receive alerts for </td> </tr> <tr> <td> cluster_email_alerts </td> <td> boolean </td> <td> Activate cluster email alerts for a user </td> </tr> <tr> <td> email </td> <td> string </td> <td> User's email (pattern matching only ASCII characters) </td> </tr> <tr> <td> email_alerts </td> <td> boolean (default: true) </td> <td> Activate email alerts for a user </td> </tr> <tr> <td> name </td> <td> string </td> <td> User's name (pattern does not allow non-ASCII and special characters &,<,>,") </td> </tr> <tr> <td> password </td> <td> string </td> <td> User's password. If <code> password_hash_method </code> is set to <code> 1 </code> , the password should be hashed using SHA-256. The format before hashing is <code> username:clustername:password </code> . </td> </tr> <tr> <td> password_hash_method </td> <td> '1' </td> <td> Used when password is passed pre-hashed to specify the hashing method </td> </tr> <tr> <td> password_issue_date </td> <td> string </td> <td> The date in which the password was set (read-only) </td> </tr> <tr> <td> role </td> <td> 'admin' 'cluster_member' 'cluster_viewer' 'db_member' 'db_viewer' 'user_manager' 'none' </td> <td> User's <a href="/docs/latest/operate/rs/references/rest-api/permissions/#roles"> role </a> </td> </tr> <tr> <td> role_uids </td> <td> array of integers </td> <td> UIDs of user's roles for role-based access control </td> </tr> <tr> <td> status </td> <td> 'active' 'locked' 'password_expired' </td> <td> User sign-in status (read-only) active : able to sign in locked : unable to sign in password_expired : unable to sign in because the password expired </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/references/rest-api/objects/user/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/hdel/.html

<section class="prose w-full py-12"> <h1 class="command-name"> HDEL </h1> <div class="font-semibold text-redis-ink-900"> Syntax </div> <pre class="command-syntax">HDEL key field [field ...]</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"> 2.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 number of fields to be removed. </dd> <dt class="font-semibold text-redis-ink-900 m-0"> ACL categories: </dt> <dd class="m-0"> <code> @write </code> , <code> @hash </code> , <code> @fast </code> , </dd> </dl> Removes the specified fields from the hash stored at <code> key </code> . Specified fields that do not exist within this hash are ignored. Deletes the hash if no fields remain. If <code> key </code> does not exist, it is treated as an empty hash and this command returns <code> 0 </code> . <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> HSET myhash field1 "foo" (integer) 1 redis> HDEL myhash field1 (integer) 1 redis> HDEL myhash field2 (integer) 0 </pre> <div class="prompt" style=""> redis> <input autocomplete="off" name="prompt" spellcheck="false" type="text"/> </div> </form> <h2 id="resp2-reply"> RESP2 Reply </h2> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : the number of fields that were removed from the hash, excluding any specified but non-existing fields. <h2 id="resp3-reply"> RESP3 Reply </h2> <a href="../../develop/reference/protocol-spec#integers"> Integer reply </a> : The number of fields that were removed from the hash, excluding any specified but non-existing fields. <h2> History </h2> <ul> <li> Starting with Redis version 2.4.0: Accepts multiple <code> field </code> arguments. </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/commands/hdel/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/integrate/redisom-for-python.html

<section class="prose w-full py-12 max-w-none"> <h1> RedisOM for Python </h1> Learn how to build with Redis Stack and Python <a href="https://github.com/redis/redis-om-python"> Redis OM Python </a> is a Redis client that provides high-level abstractions for managing document data in Redis. This tutorial shows you how to get up and running with Redis OM Python, Redis Stack, and the <a href="https://flask.palletsprojects.com/"> Flask </a> micro-framework. We'd love to see what you build with Redis Stack and Redis OM. <a href="https://discord.gg/redis"> Join the Redis community on Discord </a> to chat with us about all things Redis OM and Redis Stack. Read more about Redis OM Python <a href="https://redis.com/blog/introducing-redis-om-for-python/"> our announcement blog post </a> . <h2 id="overview"> Overview </h2> This application, an API built with Flask and a simple domain model, demonstrates common data manipulation patterns using Redis OM. Our entity is a Person, with the following JSON representation: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "first_name": "A string, the person's first or given name", "last_name": "A string, the person's last or surname", "age": 36, "address": { "street_number": 56, "unit": "A string, optional unit number e.g. B or 1", "street_name": "A string, name of the street they live on", "city": "A string, name of the city they live in", "state": "A string, state, province or county that they live in", "postal_code": "A string, their zip or postal code", "country": "A string, country that they live in." }, "personal_statement": "A string, free text personal statement", "skills": [ "A string: a skill the person has", "A string: another still that the person has" ] } </code></pre> </div> We'll let Redis OM handle generation of unique IDs, which it does using <a href="https://github.com/ulid/spec"> ULIDs </a> . Redis OM will also handle creation of unique Redis key names for us, as well as saving and retrieving entities from JSON documents stored in a Redis Stack database. <h2 id="getting-started"> Getting Started </h2> <h3 id="requirements"> Requirements </h3> To run this application you'll need: <ul> <li> <a href="https://git-scm.com/download"> git </a> - to clone the repo to your machine. </li> <li> <a href="https://www.python.org/downloads/"> Python 3.9 or higher </a> . </li> <li> A <a href="https://redis.io"> Redis Stack </a> database, or Redis with the <a href="/docs/latest/develop/interact/search-and-query/"> Search and Query </a> and <a href="/docs/latest/develop/data-types/json/"> JSON </a> features installed. We've provided a <code> docker-compose.yml </code> for this. You can also <a href="https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users"> sign up for a free 30Mb database with Redis Cloud </a> - be sure to check the Redis Stack option when creating your cloud database. </li> <li> <a href="https://curl.se/"> curl </a> , or <a href="https://www.postman.com/"> Postman </a> - to send HTTP requests to the application. We'll provide examples using curl in this document. </li> <li> Optional: <a href="https://redis.com/redis-enterprise/redis-insight/"> Redis Insight </a> , a free data visualization and database management tool for Redis. When downloading Redis Insight, be sure to select version 2.x or use the version that comes with Redis Stack. </li> </ul> <h3 id="get-the-source-code"> Get the Source Code </h3> Clone the repository from GitHub: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ git clone https://github.com/redis-developer/redis-om-python-flask-skeleton-app.git $ cd redis-om-python-flask-skeleton-app </code></pre> </div> <h3 id="start-a-redis-stack-database-or-configure-your-redis-cloud-credentials"> Start a Redis Stack Database, or Configure your Redis Cloud Credentials </h3> Next, we'll get a Redis Stack database up and running. If you're using Docker: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ docker-compose up -d Creating network "redis-om-python-flask-skeleton-app_default" with the default driver Creating redis_om_python_flask_starter ... done </code></pre> </div> If you're using Redis Cloud, you'll need the hostname, port number, and password for your database. Use these to set the <code> REDIS_OM_URL </code> environment variable like this: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ export REDIS_OM_URL=redis://default:<password>@<host>:<port> </code></pre> </div> (This step is not required when working with Docker as the Docker container runs Redis on <code> localhost </code> port <code> 6379 </code> with no password, which is the default connection that Redis OM uses.) For example if your Redis Cloud database is at port <code> 9139 </code> on host <code> enterprise.redis.com </code> and your password is <code> 5uper53cret </code> then you'd set <code> REDIS_OM_URL </code> as follows: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ export REDIS_OM_URL=redis://default:[email protected]:9139 </code></pre> </div> <h3 id="create-a-python-virtual-environment-and-install-the-dependencies"> Create a Python Virtual Environment and Install the Dependencies </h3> Create a Python virtual environment, and install the project dependencies which are <a href="https://pypi.org/project/Flask/"> Flask </a> , <a href="https://pypi.org/project/requests/"> Requests </a> (used only in the data loader script) and <a href="https://pypi.org/project/redis-om/"> Redis OM </a> : <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ python3 -m venv venv $ . ./venv/bin/activate $ pip install -r requirements.txt </code></pre> </div> <h3 id="start-the-flask-application"> Start the Flask Application </h3> Let's start the Flask application in development mode, so that Flask will restart the server for you each time you save code changes in <code> app.py </code> : <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ export FLASK_ENV=development $ flask run </code></pre> </div> If all goes well, you should see output similar to this: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ flask run * Environment: development * Debug mode: on * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit) * Restarting with stat * Debugger is active! * Debugger PIN: XXX-XXX-XXX </code></pre> </div> You're now up and running, and ready to perform CRUD operations on data with Redis, Search and Query, JSON and Redis OM for Python! To make sure the server's running, point your browser at <code> http://127.0.0.1:5000/ </code> , where you can expect to see the application's basic home page: <img alt="screenshot" src="./images/python_server_running.png"/> <h3 id="load-the-sample-data"> Load the Sample Data </h3> We've provided a small amount of sample data (it's in <code> data/people.json </code> . The Python script <code> dataloader.py </code> loads each person into Redis by posting the data to the application's create a new person endpoint. Run it like this: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ python dataloader.py Created person Robert McDonald with ID 01FX8RMR7NRS45PBT3XP9KNAZH Created person Kareem Khan with ID 01FX8RMR7T60ANQTS4P9NKPKX8 Created person Fernando Ortega with ID 01FX8RMR7YB283BPZ88HAG066P Created person Noor Vasan with ID 01FX8RMR82D091TC37B45RCWY3 Created person Dan Harris with ID 01FX8RMR8545RWW4DYCE5MSZA1 </code></pre> </div> Make sure to take a copy of the output of the data loader, as your IDs will differ from those used in the tutorial. To follow along, substitute your IDs for the ones shown above. e.g. whenever we are working with Kareem Khan, change <code> 01FX8RMR7T60ANQTS4P9NKPKX8 </code> for the ID that your data loader assigned to Kareem in your Redis database. <h3 id="problems"> Problems? </h3> If the Flask server fails to start, take a look at its output. If you see log entries similar to this: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py">raise ConnectionError(self._error_message(e)) redis.exceptions.ConnectionError: Error 61 connecting to localhost:6379. Connection refused. </code></pre> </div> then you need to start the Redis Docker container if using Docker, or set the <code> REDIS_OM_URL </code> environment variable if using Redis Cloud. If you've set the <code> REDIS_OM_URL </code> environment variable, and the code errors with something like this on startup: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py">raise ConnectionError(self._error_message(e)) redis.exceptions.ConnectionError: Error 8 connecting to enterprise.redis.com:9139. nodename nor servname provided, or not known. </code></pre> </div> then you'll need to check that you used the correct hostname, port, password and format when setting <code> REDIS_OM_URL </code> . If the data loader fails to post the sample data into the application, make sure that the Flask application is running before running the data loader. <h2 id="create-read-update-and-delete-data"> Create, Read, Update and Delete Data </h2> Let's create and manipulate some instances of our data model in Redis. Here we'll look at how to call the Flask API with curl (you could also use Postman), how the code works, and how the data's stored in Redis. <h3 id="building-a-person-model-with-redis-om"> Building a Person Model with Redis OM </h3> Redis OM allows us to model entities using Python classes, and the <a href="https://pypi.org/project/pydantic/"> Pydantic </a> framework. Our person model is contained in the file <code> person.py </code> . Here's some notes about how it works: <ul> <li> We declare a class <code> Person </code> which extends a Redis OM class <code> JsonModel </code> . This tells Redis OM that we want to store these entities in Redis as JSON documents. </li> <li> We then declare each field in our model, specifying the data type and whether or not we want to index on that field. For example, here's the <code> age </code> field, which we've declared as a positive integer that we want to index on: </li> </ul> <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py">age: PositiveInt = Field(index=True) </code></pre> </div> <ul> <li> The <code> skills </code> field is a list of strings, declared thus: </li> </ul> <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py">skills: List[str] = Field(index=True) </code></pre> </div> <ul> <li> For the <code> personal_statement </code> field, we don't want to index on the field's value, as it's a free text sentence rather than a single word or digit. For this, we'll tell Redis OM that we want to be able to perform full text searches on the values: </li> </ul> <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py">personal_statement: str = Field(index=True, full_text_search=True) </code></pre> </div> <ul> <li> <code> address </code> works differently from the other fields. Note that in our JSON representation of the model, address is an object rather than a string or numerical field. With Redis OM, this is modeled as a second class, which extends the Redis OM <code> EmbeddedJsonModel </code> class: </li> </ul> <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py">class Address(EmbeddedJsonModel): # field definitions... </code></pre> </div> <ul> <li> Fields in an <code> EmbeddedJsonModel </code> are defined in the same way, so our class contains a field definition for each data item in the address. </li> <li> Not every field in our JSON is present in every address, Redis OM allows us to declare a field as optional so long as we don't index it: </li> </ul> <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py">unit: Optional[str] = Field(index=False) </code></pre> </div> <ul> <li> We can also set a default value for a field... let's say country should be "United Kingdom" unless otherwise specified: </li> </ul> <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py">country: str = Field(index=True, default="United Kingdom") </code></pre> </div> <ul> <li> Finally, to add the embedded address object to our Person model, we declare a field of type <code> Address </code> in the Person class: </li> </ul> <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py">address: Address </code></pre> </div> <h3 id="adding-new-people"> Adding New People </h3> The function <code> create_person </code> in <code> app.py </code> handles the creation of a new person in Redis. It expects a JSON object that adheres to our Person model's schema. The code to then create a new Person object with that data and save it in Redis is simple: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> new_person = Person(**request.json) new_person.save() return new_person.pk </code></pre> </div> When a new Person instance is created, Redis OM assigns it a unique ULID primary key, which we can access as <code> .pk </code> . We return that to the caller, so that they know the ID of the object they just created. Persisting the object to Redis is then simply a matter of calling <code> .save() </code> on it. Try it out... with the server running, add a new person using curl: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">curl --location --request POST 'http://127.0.0.1:5000/person/new' \ --header 'Content-Type: application/json' \ --data-raw '{ "first_name": "Joanne", "last_name": "Peel", "age": 36, "personal_statement": "Music is my life, I love gigging and playing with my band.", "address": { "street_number": 56, "unit": "4A", "street_name": "The Rushes", "city": "Birmingham", "state": "West Midlands", "postal_code": "B91 6HG", "country": "United Kingdom" }, "skills": [ "synths", "vocals", "guitar" ] }' </code></pre> </div> Running the above curl command will return the unique ULID ID assigned to the newly created person. For example <code> 01FX8SSSDN7PT9T3N0JZZA758G </code> . <h3 id="examining-the-data-in-redis"> Examining the data in Redis </h3> Let's take a look at what we just saved in Redis. Using Redis Insight or redis-cli, connect to the database and look at the value stored at key <code> :person.Person:01FX8SSSDN7PT9T3N0JZZA758G </code> . This is stored as a JSON document in Redis, so if using redis-cli you'll need the following command: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ redis-cli 127.0.0.1:6379> json.get :person.Person:01FX8SSSDN7PT9T3N0JZZA758G </code></pre> </div> If you're using Redis Insight, the browser will render the key value for you when you click on the key name: <img alt="Data in Redis Insight" src="./images/python_insight_explore_person.png"/> When storing data as JSON in Redis, we can update and retrieve the whole document, or just parts of it. For example, to retrieve only the person's address and first skill, use the following command (Redis Insight users should use the built in redis-cli for this): <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ redis-cli 127.0.0.1:6379> json.get :person.Person:01FX8SSSDN7PT9T3N0JZZA758G $.address $.skills[0] "{\"$.skills[0]\":[\"synths\"],\"$.address\":[{\"pk\":\"01FX8SSSDNRDSRB3HMVH00NQTT\",\"street_number\":56,\"unit\":\"4A\",\"street_name\":\"The Rushes\",\"city\":\"Birmingham\",\"state\":\"West Midlands\",\"postal_code\":\"B91 6HG\",\"country\":\"United Kingdom\"}]}" </code></pre> </div> For more information on the JSON Path syntax used to query JSON documents in Redis, see the <a href="/docs/latest/develop/data-types/json/path/#jsonpath-syntax"> documentation </a> . <h3 id="find-a-person-by-id"> Find a Person by ID </h3> If we know a person's ID, we can retrieve their data. The function <code> find_by_id </code> in <code> app.py </code> receives an ID as its parameter, and asks Redis OM to retrieve and populate a Person object using the ID and the Person <code> .get </code> class method: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> try: person = Person.get(id) return person.dict() except NotFoundError: return {} </code></pre> </div> The <code> .dict() </code> method converts our Person object to a Python dictionary that Flask then returns to the caller. Note that if there is no Person with the supplied ID in Redis, <code> get </code> will throw a <code> NotFoundError </code> . Try this out with curl, substituting <code> 01FX8SSSDN7PT9T3N0JZZA758G </code> for the ID of a person that you just created in your database: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">curl --location --request GET 'http://localhost:5000/person/byid/01FX8SSSDN7PT9T3N0JZZA758G' </code></pre> </div> The server responds with a JSON object containing the user's data: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "address": { "city": "Birmingham", "country": "United Kingdom", "pk": "01FX8SSSDNRDSRB3HMVH00NQTT", "postal_code": "B91 6HG", "state": "West Midlands", "street_name": "The Rushes", "street_number": 56, "unit": null }, "age": 36, "first_name": "Joanne", "last_name": "Peel", "personal_statement": "Music is my life, I love gigging and playing with my band.", "pk": "01FX8SSSDN7PT9T3N0JZZA758G", "skills": [ "synths", "vocals", "guitar" ] } </code></pre> </div> <h3 id="find-people-with-matching-first-and-last-name"> Find People with Matching First and Last Name </h3> Let's find all the people who have a given first and last name... This is handled by the function <code> find_by_name </code> in <code> app.py </code> . Here, we're using Person's <code> find </code> class method that's provided by Redis OM. We pass it a search query, specifying that we want to find people whose <code> first_name </code> field contains the value of the <code> first_name </code> parameter passed to <code> find_by_name </code> AND whose <code> last_name </code> field contains the value of the <code> last_name </code> parameter: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> people = Person.find( (Person.first_name == first_name) & (Person.last_name == last_name) ).all() </code></pre> </div> <code> .all() </code> tells Redis OM that we want to retrieve all matching people. Try this out with curl as follows: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">curl --location --request GET 'http://127.0.0.1:5000/people/byname/Kareem/Khan' </code></pre> </div> Note: First and last name are case sensitive. The server responds with an object containing <code> results </code> , an array of matches: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "results": [ { "address": { "city": "Sheffield", "country": "United Kingdom", "pk": "01FX8RMR7THMGA84RH8ZRQRRP9", "postal_code": "S1 5RE", "state": "South Yorkshire", "street_name": "The Beltway", "street_number": 1, "unit": "A" }, "age": 27, "first_name": "Kareem", "last_name": "Khan", "personal_statement":"I'm Kareem, a multi-instrumentalist and singer looking to join a new rock band.", "pk":"01FX8RMR7T60ANQTS4P9NKPKX8", "skills": [ "drums", "guitar", "synths" ] } ] } </code></pre> </div> <h3 id="find-people-within-a-given-age-range"> Find People within a Given Age Range </h3> It's useful to be able to find people that fall into a given age range... the function <code> find_in_age_range </code> in <code> app.py </code> handles this as follows... We'll again use Person's <code> find </code> class method, this time passing it a minimum and maximum age, specifying that we want results where the <code> age </code> field is between those values only: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> people = Person.find( (Person.age >= min_age) & (Person.age <= max_age) ).sort_by("age").all() </code></pre> </div> Note that we can also use <code> .sort_by </code> to specify which field we want our results sorted by. Let's find everyone between 30 and 47 years old, sorted by age: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">curl --location --request GET 'http://127.0.0.1:5000/people/byage/30/47' </code></pre> </div> This returns a <code> results </code> object containing an array of matches: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "results": [ { "address": { "city": "Sheffield", "country": "United Kingdom", "pk": "01FX8RMR7NW221STN6NVRDPEDT", "postal_code": "S12 2MX", "state": "South Yorkshire", "street_name": "Main Street", "street_number": 9, "unit": null }, "age": 35, "first_name": "Robert", "last_name": "McDonald", "personal_statement": "My name is Robert, I love meeting new people and enjoy music, coding and walking my dog.", "pk": "01FX8RMR7NRS45PBT3XP9KNAZH", "skills": [ "guitar", "piano", "trombone" ] }, { "address": { "city": "Birmingham", "country": "United Kingdom", "pk": "01FX8SSSDNRDSRB3HMVH00NQTT", "postal_code": "B91 6HG", "state": "West Midlands", "street_name": "The Rushes", "street_number": 56, "unit": null }, "age": 36, "first_name": "Joanne", "last_name": "Peel", "personal_statement": "Music is my life, I love gigging and playing with my band.", "pk": "01FX8SSSDN7PT9T3N0JZZA758G", "skills": [ "synths", "vocals", "guitar" ] }, { "address": { "city": "Nottingham", "country": "United Kingdom", "pk": "01FX8RMR82DDJ90CW8D1GM68YZ", "postal_code": "NG1 1AA", "state": "Nottinghamshire", "street_name": "Broadway", "street_number": 12, "unit": "A-1" }, "age": 37, "first_name": "Noor", "last_name": "Vasan", "personal_statement": "I sing and play the guitar, I enjoy touring and meeting new people on the road.", "pk": "01FX8RMR82D091TC37B45RCWY3", "skills": [ "vocals", "guitar" ] }, { "address": { "city": "San Diego", "country": "United States", "pk": "01FX8RMR7YCDAVSWBMWCH2B07G", "postal_code": "92102", "state": "California", "street_name": "C Street", "street_number": 1299, "unit": null }, "age": 43, "first_name": "Fernando", "last_name": "Ortega", "personal_statement": "I'm in a really cool band that plays a lot of cover songs. I'm the drummer!", "pk": "01FX8RMR7YB283BPZ88HAG066P", "skills": [ "clarinet", "oboe", "drums" ] } ] } </code></pre> </div> <h3 id="find-people-in-a-given-city-with-a-specific-skill"> Find People in a Given City with a Specific Skill </h3> Now, we'll try a slightly different sort of query. We want to find all of the people that live in a given city AND who also have a certain skill. This requires a search over both the <code> city </code> field which is a string, and the <code> skills </code> field, which is an array of strings. Essentially we want to say "Find me all the people whose city is <code> city </code> AND whose skills array CONTAINS <code> desired_skill </code> ", where <code> city </code> and <code> desired_skill </code> are the parameters to the <code> find_matching_skill </code> function in <code> app.py </code> . Here's the code for that: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> people = Person.find( (Person.skills << desired_skill) & (Person.address.city == city) ).all() </code></pre> </div> The <code> << </code> operator here is used to indicate "in" or "contains". Let's find all the guitar players in Sheffield: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">curl --location --request GET 'http://127.0.0.1:5000/people/byskill/guitar/Sheffield' </code></pre> </div> Note: <code> Sheffield </code> is case sensitive. The server returns a <code> results </code> array containing matching people: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "results": [ { "address": { "city": "Sheffield", "country": "United Kingdom", "pk": "01FX8RMR7THMGA84RH8ZRQRRP9", "postal_code": "S1 5RE", "state": "South Yorkshire", "street_name": "The Beltway", "street_number": 1, "unit": "A" }, "age": 28, "first_name": "Kareem", "last_name": "Khan", "personal_statement": "I'm Kareem, a multi-instrumentalist and singer looking to join a new rock band.", "pk": "01FX8RMR7T60ANQTS4P9NKPKX8", "skills": [ "drums", "guitar", "synths" ] }, { "address": { "city": "Sheffield", "country": "United Kingdom", "pk": "01FX8RMR7NW221STN6NVRDPEDT", "postal_code": "S12 2MX", "state": "South Yorkshire", "street_name": "Main Street", "street_number": 9, "unit": null }, "age": 35, "first_name": "Robert", "last_name": "McDonald", "personal_statement": "My name is Robert, I love meeting new people and enjoy music, coding and walking my dog.", "pk": "01FX8RMR7NRS45PBT3XP9KNAZH", "skills": [ "guitar", "piano", "trombone" ] } ] } </code></pre> </div> <h3 id="find-people-using-full-text-search-on-their-personal-statements"> Find People using Full Text Search on their Personal Statements </h3> Each person has a <code> personal_statement </code> field, which is a free text string containing a couple of sentences about them. We chose to index this in a way that makes it full text searchable, so let's see how to use this now. The code for this is in the function <code> find_matching_statements </code> in <code> app.py </code> . To search for people who have the value of the parameter <code> search_term </code> in their <code> personal_statement </code> field, we use the <code> % </code> operator: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> Person.find(Person.personal_statement % search_term).all() </code></pre> </div> Let's find everyone who talks about "play" in their personal statement. <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">curl --location --request GET 'http://127.0.0.1:5000/people/bystatement/play' </code></pre> </div> The server responds with a <code> results </code> array of matching people: <div class="highlight"> <pre class="chroma"><code class="language-json" data-lang="json">{ "results": [ { "address": { "city": "San Diego", "country": "United States", "pk": "01FX8RMR7YCDAVSWBMWCH2B07G", "postal_code": "92102", "state": "California", "street_name": "C Street", "street_number": 1299, "unit": null }, "age": 43, "first_name": "Fernando", "last_name": "Ortega", "personal_statement": "I'm in a really cool band that plays a lot of cover songs. I'm the drummer!", "pk": "01FX8RMR7YB283BPZ88HAG066P", "skills": [ "clarinet", "oboe", "drums" ] }, { "address": { "city": "Nottingham", "country": "United Kingdom", "pk": "01FX8RMR82DDJ90CW8D1GM68YZ", "postal_code": "NG1 1AA", "state": "Nottinghamshire", "street_name": "Broadway", "street_number": 12, "unit": "A-1" }, "age": 37, "first_name": "Noor", "last_name": "Vasan", "personal_statement": "I sing and play the guitar, I enjoy touring and meeting new people on the road.", "pk": "01FX8RMR82D091TC37B45RCWY3", "skills": [ "vocals", "guitar" ] }, { "address": { "city": "Birmingham", "country": "United Kingdom", "pk": "01FX8SSSDNRDSRB3HMVH00NQTT", "postal_code": "B91 6HG", "state": "West Midlands", "street_name": "The Rushes", "street_number": 56, "unit": null }, "age": 36, "first_name": "Joanne", "last_name": "Peel", "personal_statement": "Music is my life, I love gigging and playing with my band.", "pk": "01FX8SSSDN7PT9T3N0JZZA758G", "skills": [ "synths", "vocals", "guitar" ] } ] } </code></pre> </div> Note that we get results including matches for "play", "plays" and "playing". <h3 id="update-a-persons-age"> Update a Person's Age </h3> As well as retrieving information from Redis, we'll also want to update a Person's data from time to time. Let's see how to do that with Redis OM for Python. The function <code> update_age </code> in <code> app.py </code> accepts two parameters: <code> id </code> and <code> new_age </code> . Using these, we first retrieve the person's data from Redis and create a new object with it: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> try: person = Person.get(id) except NotFoundError: return "Bad request", 400 </code></pre> </div> Assuming we find the person, let's update their age and save the data back to Redis: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> person.age = new_age person.save() </code></pre> </div> Let's change Kareem Khan's age from 27 to 28: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">curl --location --request POST 'http://127.0.0.1:5000/person/01FX8RMR7T60ANQTS4P9NKPKX8/age/28' </code></pre> </div> The server responds with <code> ok </code> . <h3 id="delete-a-person"> Delete a Person </h3> If we know a person's ID, we can delete them from Redis without first having to load their data into a Person object. In the function <code> delete_person </code> in <code> app.py </code> , we call the <code> delete </code> class method on the Person class to do this: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> Person.delete(id) </code></pre> </div> Let's delete Dan Harris, the person with ID <code> 01FX8RMR8545RWW4DYCE5MSZA1 </code> : <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">curl --location --request POST 'http://127.0.0.1:5000/person/01FX8RMR8545RWW4DYCE5MSZA1/delete' </code></pre> </div> The server responds with an <code> ok </code> response regardless of whether the ID provided existed in Redis. <h3 id="setting-an-expiry-time-for-a-person"> Setting an Expiry Time for a Person </h3> This is an example of how to run arbitrary Redis commands against instances of a model saved in Redis. Let's see how we can set the time to live (TTL) on a person, so that Redis will expire the JSON document after a configurable number of seconds have passed. The function <code> expire_by_id </code> in <code> app.py </code> handles this as follows. It takes two parameters: <code> id </code> - the ID of a person to expire, and <code> seconds </code> - the number of seconds in the future to expire the person after. This requires us to run the Redis <a href="/docs/latest/commands/expire/"> <code> EXPIRE </code> </a> command against the person's key. To do this, we need to access the Redis connection from the <code> Person </code> model like so: <div class="highlight"> <pre class="chroma"><code class="language-py" data-lang="py"> person_to_expire = Person.get(id) Person.db().expire(person_to_expire.key(), seconds) </code></pre> </div> Let's set the person with ID <code> 01FX8RMR82D091TC37B45RCWY3 </code> to expire in 600 seconds: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">curl --location --request POST 'http://localhost:5000/person/01FX8RMR82D091TC37B45RCWY3/expire/600' </code></pre> </div> Using <code> redis-cli </code> , you can check that the person now has a TTL set with the Redis <code> expire </code> command: <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">127.0.0.1:6379> ttl :person.Person:01FX8RMR82D091TC37B45RCWY3 (integer) 584 </code></pre> </div> This shows that Redis will expire the key 584 seconds from now. You can use the <code> .db() </code> function on your model class to get at the underlying redis-py connection whenever you want to run lower level Redis commands. For more details, see the <a href="https://redis-py.readthedocs.io/en/stable/"> redis-py documentation </a> . <h2 id="shutting-down-redis-docker"> Shutting Down Redis (Docker) </h2> If you're using Docker, and want to shut down the Redis container when you are finished with the application, use <code> docker-compose down </code> : <div class="highlight"> <pre class="chroma"><code class="language-bash" data-lang="bash">$ docker-compose down Stopping redis_om_python_flask_starter ... done Removing redis_om_python_flask_starter ... done Removing network redis-om-python-flask-skeleton-app_default </code></pre> </div> <nav> </nav> <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/integrate/redisom-for-python/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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/active-active/develop/data-types/lists/.html

<section class="prose w-full py-12 max-w-none"> <h1> Lists in Active-Active databases </h1> Information about using list with an Active-Active database. Redis lists are simply lists of strings, sorted by insertion order. It is possible to add elements to a Redis List that push new elements to the head (on the left) or to the tail (on the right) of the list. Redis lists can be used to easily implement queues (using LPUSH and RPOP, for example) and stacks (using LPUSH and LPOP, for example). Lists in Active-Active databases are just the same as regular Redis Lists. See the following examples to get familiar with Lists' behavior in an Active-Active database. Simple Lists example: <table> <thead> <tr> <th style="text-align:right"> Time </th> <th style="text-align:center"> CRDB Instance 1 </th> <th style="text-align:center"> CRDB Instance 2 </th> </tr> </thead> <tbody> <tr> <td style="text-align:right"> t1 </td> <td style="text-align:center"> LPUSH mylist “hello” </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t2 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t3 </td> <td style="text-align:center"> </td> <td style="text-align:center"> LPUSH mylist “world” </td> </tr> <tr> <td style="text-align:right"> t4 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t5 </td> <td style="text-align:center"> LRANGE mylist 0 -1 =>“world” “hello” </td> <td style="text-align:center"> LRANGE mylist 0 -1 => “world” “hello” </td> </tr> </tbody> </table> Explanation : The final list contains both the "world" and "hello" elements, in that order (Instance 2 observed "hello" when it added "world"). Example of Lists with Concurrent Insertions: <table> <thead> <tr> <th style="text-align:right"> Time </th> <th style="text-align:center"> CRDB Instance 1 </th> <th style="text-align:center"> CRDB Instance 2 </th> </tr> </thead> <tbody> <tr> <td style="text-align:right"> t1 </td> <td style="text-align:center"> LPUSH L x </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t2 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t3 </td> <td style="text-align:center"> LINSERT L AFTER x y1 </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t4 </td> <td style="text-align:center"> </td> <td style="text-align:center"> LINSERT L AFTER x y2 </td> </tr> <tr> <td style="text-align:right"> t5 </td> <td style="text-align:center"> LRANGE L 0 -1 => x y1 </td> <td style="text-align:center"> LRANGE L 0 -1 => x y2 </td> </tr> <tr> <td style="text-align:right"> t6 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t7 </td> <td style="text-align:center"> LRANGE L 0 -1 => x y1 y2 </td> <td style="text-align:center"> LRANGE L 0 -1 => x y1 y2 </td> </tr> </tbody> </table> Explanation : Instance 1 added an element y1 after x, and then Instance 2 added element y2 after x. The final List contains all three elements: x is the first element, after it y1 and then y2. The Active-Active database resolves the conflict arbitrarily but applies the resolution consistently across all Active-Active database instances. Example of Deleting a List while Pushing a New Element: <table> <thead> <tr> <th style="text-align:right"> Time </th> <th style="text-align:center"> CRDB Instance 1 </th> <th style="text-align:center"> CRDB Instance 2 </th> </tr> </thead> <tbody> <tr> <td style="text-align:right"> t1 </td> <td style="text-align:center"> LPUSH L x </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t2 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t3 </td> <td style="text-align:center"> LRANGE L 0 -1 => x </td> <td style="text-align:center"> LRANGE L 0 -1 => x </td> </tr> <tr> <td style="text-align:right"> t4 </td> <td style="text-align:center"> LPUSH L y </td> <td style="text-align:center"> DEL L </td> </tr> <tr> <td style="text-align:right"> t5 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t6 </td> <td style="text-align:center"> LRANGE L 0 -1 => y </td> <td style="text-align:center"> LRANGE L 0 -1 => y </td> </tr> </tbody> </table> Explanation At t4 - t6, DEL deletes only observed elements. This is why L still contains y. Example of Popping Elements from a List: <table> <thead> <tr> <th style="text-align:right"> Time </th> <th style="text-align:center"> CRDB Instance 1 </th> <th style="text-align:center"> CRDB Instance 2 </th> </tr> </thead> <tbody> <tr> <td style="text-align:right"> t1 </td> <td style="text-align:center"> LPUSH L x y z </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t2 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t3 </td> <td style="text-align:center"> </td> <td style="text-align:center"> RPOP L => x </td> </tr> <tr> <td style="text-align:right"> t4 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t5 </td> <td style="text-align:center"> RPOP L => y </td> <td style="text-align:center"> </td> </tr> <tr> <td style="text-align:right"> t6 </td> <td style="text-align:center"> — Sync — </td> <td style="text-align:center"> — Sync — </td> </tr> <tr> <td style="text-align:right"> t7 </td> <td style="text-align:center"> RPOP L => z </td> <td style="text-align:center"> RPOP L => z </td> </tr> </tbody> </table> Explanation : At t1, the operation pushes elements x, y, z to List L. At t3, the sequential pops behave as expected from a queue. At t7, the concurrent pop in both instances might show the same result. The instance was not able to sync regarding the z removal so, from the point of view of each instance, z is located in the List and can be popped. After syncing, both lists are empty. Be aware of the behavior of Lists in Active-Active databases when using List as a stack or queue. As seen in the above example, two parallel RPOP operations performed by two different Active-Active database instances can get the same element in the case of a concurrent operation. Lists in Active-Active databases guarantee that each element is POP-ed at least once, but cannot guarantee that each element is POP-ed only once. Such behavior should be taken into account when, for example, using Lists in Active-Active databases as building blocks for inter-process communication systems. In that case, if the same element cannot be handled twice by the applications, it's recommended that the POP operations be performed by one Active-Active database instance, whereas the PUSH operations can be performed by multiple instances. <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/active-active/develop/data-types/lists/"/> <div class="flex flex-row justify-between"> <div class="grid justify-center"> RATE THIS PAGE <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>