Merge branch 'main' into DOC-4563

Author: rrelledge

content/commands/ft.aggregate/index.md

@@ -139,6 +139,14 @@ arguments:
   name: params
   optional: true
   type: block
+- name: scorer
+  optional: true
+  token: SCORER
+  type: string
+- name: addscores
+  optional: true
+  token: ADDSCORES
+  type: pure-token
 - name: dialect
   optional: true
   since: 2.4.3
@@ -173,7 +181,8 @@ syntax: "FT.AGGREGATE index query \n  [VERBATIM] \n  [LOAD count field [field ..
   \ ...]] ...]] \n  [ SORTBY nargs [ property ASC | DESC [ property ASC | DESC ...]]\
   \ [MAX num] [WITHCOUNT] \n  [ APPLY expression AS name [ APPLY expression AS name\
   \ ...]] \n  [ LIMIT offset num] \n  [FILTER filter] \n  [ WITHCURSOR [COUNT read_size]\
-  \ [MAXIDLE idle_time]] \n  [ PARAMS nargs name value [ name value ...]] \n  [ADDSCORES] \n  [DIALECT\
+  \ [MAXIDLE idle_time]] \n  [ PARAMS nargs name value [ name value ...]] \n  [SCORER scorer]\n
+  \ [ADDSCORES] \n  [DIALECT\
   \ dialect]\n"
 syntax_fmt: "FT.AGGREGATE index query [VERBATIM] [LOAD\_count field [field ...]]\n\
   \  [TIMEOUT\_timeout] [LOAD *] [GROUPBY\_nargs property [property ...]\n  [REDUCE\_\
@@ -183,15 +192,15 @@ syntax_fmt: "FT.AGGREGATE index query [VERBATIM] [LOAD\_count field [field ...]]
   name] ...]] ...]]\n  [SORTBY\_nargs [property <ASC | DESC> [property <ASC | DESC>\
   \ ...]]\n  [MAX\_num]] [APPLY\_expression AS\_name [APPLY\_expression AS\_name\n\
   \  ...]] [LIMIT offset num] [FILTER\_filter] [WITHCURSOR\n  [COUNT\_read_size] [MAXIDLE\_\
-  idle_time]] [PARAMS nargs name value\n  [name value ...]]\n  [ADDSCORES]\n  [DIALECT\_dialect]"
+  idle_time]] [PARAMS nargs name value\n  [name value ...]]\n  [SCORER scorer]\n [ADDSCORES]\n  [DIALECT\_dialect]"
 syntax_str: "query [VERBATIM] [LOAD\_count field [field ...]] [TIMEOUT\_timeout] [LOAD\
   \ *] [GROUPBY\_nargs property [property ...] [REDUCE\_function nargs arg [arg ...]\
   \ [AS\_name] [REDUCE\_function nargs arg [arg ...] [AS\_name] ...]] [GROUPBY\_nargs\
   \ property [property ...] [REDUCE\_function nargs arg [arg ...] [AS\_name] [REDUCE\_\
   function nargs arg [arg ...] [AS\_name] ...]] ...]] [SORTBY\_nargs [property <ASC\
   \ | DESC> [property <ASC | DESC> ...]] [MAX\_num]] [APPLY\_expression AS\_name [APPLY\_\
   expression AS\_name ...]] [LIMIT offset num] [FILTER\_filter] [WITHCURSOR [COUNT\_\
-  read_size] [MAXIDLE\_idle_time]] [PARAMS nargs name value [name value ...]] [ADDSCORES] [DIALECT\_\
+  read_size] [MAXIDLE\_idle_time]] [PARAMS nargs name value [name value ...]] [SCORER scorer] [ADDSCORES] [DIALECT\_\
   dialect]"
 title: FT.AGGREGATE
 ---
@@ -316,6 +325,12 @@ defines one or more value parameters. Each parameter has a name and a value.
 You can reference parameters in the `query` by a `$`, followed by the parameter name, for example, `$user`. Each such reference in the search query to a parameter name is substituted by the corresponding parameter value. For example, with parameter definition `PARAMS 4 lon 29.69465 lat 34.95126`, the expression `@loc:[$lon $lat 10 km]` is evaluated to `@loc:[29.69465 34.95126 10 km]`. You cannot reference parameters in the query string where concrete values are not allowed, such as in field names, for example, `@loc`. To use `PARAMS`, set `DIALECT` to `2` or greater than `2`.
 </details>
 
+<details open>
+<summary><code>SCORER {scorer}</code></summary>
+
+uses a [built-in]({{< relref "/develop/interact/search-and-query/advanced-concepts/scoring" >}}) or a [user-provided]({{< relref "/develop/interact/search-and-query/administration/extensions" >}}) scoring function.
+</details>
+
 <details open>
 <summary><code>ADDSCORES</code></summary>
 

content/develop/clients/go/queryjson.md

@@ -31,6 +31,36 @@ Connect to the database:
 {{< clients-example go_home_json connect >}}
 {{< /clients-example >}}
 
+{{< note >}}The connection options in the example specify
+[RESP2]({{< relref "/develop/reference/protocol-spec" >}}) in the `Protocol`
+field. We recommend that you use RESP2 for Redis query engine operations in `go-redis`
+because some of the response structures for the default RESP3 are currently
+incomplete and so you must handle the "raw" responses in your own code.
+
+If you do want to use RESP3, you should set the `UnstableResp3` option when
+you connect:
+
+```go
+rdb := redis.NewClient(&redis.Options{
+    UnstableResp3: true,
+    // Other options...
+})
+```
+
+You must also access command results using the `RawResult()` and `RawVal()` methods
+rather than the usual `Result()` and `Val()`:
+
+```go
+res1, err := client.FTSearchWithArgs(
+    ctx, "txt", "foo bar", &redis.FTSearchOptions{},
+).RawResult()
+val1 := client.FTSearchWithArgs(
+    ctx, "txt", "foo bar", &redis.FTSearchOptions{},
+).RawVal()
+```
+{{< /note >}}
+
+
 Create some test data to add to the database:
 
 {{< clients-example go_home_json create_data >}}

content/embeds/supported-platforms-embed.md

@@ -16,6 +16,7 @@ Redis Enterprise Software is supported on several operating systems, cloud envi
 | RHEL 9<br />FIPS mode<sup>[5](#table-note-5)</sup> | <span title="Supported">&#x2705;</span> | – | – | – | – |
 | RHEL 8 &<br />compatible distros<sup>[1](#table-note-1)</sup> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> |
 | RHEL 7 &<br />compatible distros<sup>[1](#table-note-1)</sup> | – | – | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> |
+| Ubuntu 22.04<sup>[2](#table-note-2)</sup> | <span title="Supported">&#x2705;</span> | – | – | – | – |
 | Ubuntu 20.04<sup>[2](#table-note-2)</sup> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | – |
 | Ubuntu 18.04<sup>[2](#table-note-2)</sup> | – | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> |
 | Ubuntu 16.04<sup>[2](#table-note-2)</sup> | – | – | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> |

content/operate/kubernetes/re-databases/replica-redb.md

@@ -11,19 +11,19 @@ weight: 42
 ---
 
 You can configure a replica of a database by creating an item in
-the `replicaSources` section of the [Redis Enterprise database specification](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md#redisenterprisedatabasespec). The value of
-`replicaSourceType` must be 'SECRET'; `replicaSourceName`
-must be the name of a secret that contains the replica source url.
+the [`replicaSources`](/operate/kubernetes/reference/redis_enterprise_database_api#specreplicasources) section of the RedisEnterpriseDatabase (REDB) custom resource.
 
-A secret must be created using a `stringData` section containing the replica source URI as follows:
+A secret must be created with the `stringData` section containing the replica source URI as follows:
+
+Create a secret with the replica source URI listed in the `stringData` field as follows:
 
 ```yaml
 apiVersion: v1
 kind: Secret
 metadata:
    name: my-replica-source
 stringData:
-   uri: replica-source-uri-goes-here
+   uri: <replica-source-uri-goes-here>
 ```
 
 The replica source URL can be retrieved by going to "UI > database > configuration > Press the button Get Replica of source URL"
@@ -80,7 +80,7 @@ You will need `kubectl`, `curl`, and `jq` installed for this procedure.
    ```js
    JQ='.[] | select(.name=="'
    JQ+="${SOURCE_DB}"
-   JQ+='") | ("redis://admin:" +  .authentication_admin_pass + "@"+.endpoints[0].dns_name+":"+(.endpoints[0].port|tostring))'
+   JQ+='") | ("redis://admin:" + .authentication_admin_pass + "@"+.name+":"+(.endpoints[0].port|tostring))'
    URI=`curl -sf -k -u "$CLUSTER_USER:$CLUSTER_PASSWORD" "https://localhost:9443/v1/bdbs?fields=uid,name,endpoints,authentication_admin_pass" | jq "$JQ" | sed 's/"//g'`
    ```
 

content/operate/kubernetes/security/manage-rec-credentials.md

@@ -44,107 +44,111 @@ The credentials can be used to access the Redis Enterprise admin console or the
 
 1. Access a [pod](https://kubernetes.io/docs/concepts/workloads/pods/) running a Redis Enterprise cluster.
 
-    ```bash
-    kubectl exec -it <rec-resource-name>-0 bash
-    ```
+```sh
+kubectl exec -it <rec-resource-name>-0 bash
+```
 
-1. Add a new password for the existing user.
+2. Add a new password for the existing user.
+
+```bash
+REC_USER="`cat /opt/redislabs/credentials/username`" \
+REC_PASSWORD="`cat /opt/redislabs/credentials/password`" \
+curl -k --request POST \
+  --url https://localhost:9443/v1/users/password \
+  -u "$REC_USER:$REC_PASSWORD" \
+  --header 'Content-Type: application/json' \
+  --data "{\"username\":\"$REC_USER\", \
+  \"old_password\":\"$REC_PASSWORD\", \
+  \"new_password\":\"<NEW PASSWORD>\"}"
+```
 
-    ```bash
-     REC_USER="`cat /opt/redislabs/credentials/username`" \
-     REC_PASSWORD="`cat /opt/redislabs/credentials/password`" \
-     curl -k --request POST \
-       --url https://localhost:9443/v1/users/password \
-       -u "$REC_USER:$REC_PASSWORD" \
-       --header 'Content-Type: application/json' \
-       --data "{\"username\":\"$REC_USER\", \
-     \"old_password\":\"$REC_PASSWORD\", \
-     \"new_password\":\"<NEW PASSWORD>\"}"
-    ```
+3. From outside the pod, update the REC credential secret.
 
-1. From outside the pod, update the REC credential secret.
+3a. Save the existing username to a text file.
 
-    1. Save the existing username to a text file .
-        ```bash
-        echo -n "<current_username>" > username 
-        ```
+```sh
+echo -n "<current_username>" > username 
+```
 
-    1. Save the new password to a text file.
-        ```bash
-        echo -n "<new_password>" > password
-        ```
+3b. Save the new password to a text file.
 
-    1. Update the REC credential secret.
-        ```bash
-        kubectl create secret generic <cluster_secret_name> \
-          --from-file=./username \
-          --from-file=./password --dry-run \
-          -o yaml
-        kubectl apply -f 
-        ```
+```sh
+echo -n "<new_password>" > password
+```
 
-1. Wait five minutes for all the components to read the new password from the updated secret. If you proceed to the next step too soon, the account could get locked.
+3c. Update the REC credential secret.
 
-1. Access a pod running a Redis Enterprise cluster again.
+```sh
+kubectl create secret generic <cluster_secret_name> \
+  --from-file=./username \
+  --from-file=./password --dry-run \
+  -o yaml | \
+kubectl apply -f 
+```
 
-    ```bash
-    kubectl exec -it <rec-resource-name>-0 bash
-    ```
+4. Wait five minutes for all the components to read the new password from the updated secret. If you proceed to the next step too soon, the account could get locked.
 
- 1. Remove the previous password to ensure only the new one applies.
+5. Access a pod running a Redis Enterprise cluster again.
 
-    ```sh
-    REC_USER="`cat /opt/redislabs/credentials/username`"; \
-    REC_PASSWORD="`cat /opt/redislabs/credentials/password`"; \
-    curl -k --request DELETE \ 
-      --url https://localhost:9443/v1/users/password \
-      -u "$REC_USER:$REC_PASSWORD" \
-      --header 'Content-Type: application/json' \
-      --data "{\"username\":\"$REC_USER\", \
-      \"old_password\":\"<OLD PASSWORD\"}"
-    ```
+```sh
+kubectl exec -it <rec-resource-name>-0 bash
+```
+
+6. Remove the previous password to ensure only the new one applies.
 
-    {{<note>}} The username for the K8s secret is the email displayed on the Redis Enterprise admin console. {{</note>}}
+```sh
+REC_USER="`cat /opt/redislabs/credentials/username`"; \
+REC_PASSWORD="`cat /opt/redislabs/credentials/password`"; \
+curl -k --request DELETE \ 
+  --url https://localhost:9443/v1/users/password \
+  -u "$REC_USER:$REC_PASSWORD" \
+  --header 'Content-Type: application/json' \
+  --data "{\"username\":\"$REC_USER\", \
+  \"old_password\":\"<OLD PASSWORD\"}"
+```
+
+{{<note>}} The username for the K8s secret is the email displayed on the Redis Enterprise admin console. {{</note>}}
 
 ### Change both the REC username and password
 
 1. [Connect to the admin console]({{< relref "/operate/kubernetes/re-clusters/connect-to-admin-console.md" >}})
 
-1. [Add another admin user]({{< relref "/operate/rs/security/access-control/create-users" >}}) and choose a new password.
+2. [Add another admin user]({{< relref "/operate/rs/security/access-control/create-users" >}}) and choose a new password.
 
-1. Specify the new username in the `username` field of your REC custom resource spec.
+3. Specify the new username in the `username` field of your REC custom resource spec.
 
-1. Update the REC credential secret:
+4. Update the REC credential secret:
 
-    1. Save the existing username to a text file.
+4a. Save the new username to a text file.
 
-        ```bash
-        echo -n "<current_username>" > username
-        ```
+```sh
+echo -n "<new_username>" > username
+```
 
-    1. Save the new password to a text file.
+4b. Save the new password to a text file.
 
-        ```bash
-        echo -n "<new_password>" > password
-        ```
+```sh
+echo -n "<new_password>" > password
+```
 
-    1. Update the REC credential secret.
+4c. Update the REC credential secret.
 
-        ```bash
-        kubectl create secret generic <cluster_secret_name> \
-          --from-file=./username \
-          --from-file=./password --dry-run \
-          -o yaml
-        kubectl apply -f 
-        ```
+```sh
+kubectl create secret generic <cluster_secret_name> \
+  --save-config \
+  --dry-run=client \
+  --from-file=./username --from-file=./password \
+  -o yaml | \
+kubectl apply -f
+```
 
-1. Wait five minutes for all the components to read the new password from the updated secret. If you proceed to the next step too soon, the account could get locked.
+5. Wait five minutes for all the components to read the new password from the updated secret. If you proceed to the next step too soon, the account could get locked.
 
-1. Delete the previous admin user from the cluster.
+6. Delete the previous admin user from the cluster.
 
-  {{<note>}}
+{{<note>}}
 The operator may log errors in the time between updating the username in the REC spec and the secret update.
-  {{</note>}}
+{{</note>}}
 
 ### Update the credentials secret in Vault
 

content/operate/kubernetes/upgrade/openshift-cli.md

@@ -230,6 +230,6 @@ If the operator logs show an event related to an incompatible database version,
 curl -sfk -u <rec_username>:<rec_password> -X POST -H "Content-Type: application/json" -d '{"redis_version": <target redis version>}' https://localhost:9443/v1/bdbs/<BDB UID>/upgrade
 ```
 
-After updating the modules with the Redis Software API, update the REDB custom resource to reflect the change.
+After updating the database with the Redis Software API, update the REDB custom resource to reflect the change.
 
 

content/operate/kubernetes/upgrade/upgrade-olm.md

@@ -114,4 +114,4 @@ If the operator logs show an event related to an incompatible database version,
 curl -sfk -u <rec_username>:<rec_password> -X POST -H "Content-Type: application/json" -d '{"redis_version": <target redis version>}' https://localhost:9443/v1/bdbs/<BDB UID>/upgrade
 ```
 
-After updating the modules with the Redis Software API, update the REDB custom resource to reflect the change.
+After updating the database with the Redis Software API, update the REDB custom resource to reflect the change.

content/operate/kubernetes/upgrade/upgrade-redis-cluster.md

@@ -208,7 +208,7 @@ If the operator logs show an event related to an unsupported module, download th
 curl -sfk -u <rec_username>:<rec_password> -X POST -F 'module=@<full path to your module>' https://localhost:9443/v2/modules
 ```
 
-After updating the modules with the Redis Software API, update the REDB custom resource to reflect the change.
+After updating the database with the Redis Software API, update the REDB custom resource to reflect the change.
 
 ### Invalid database version
 

content/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart.md

@@ -9,7 +9,6 @@ description: Set up a development or test deployment of Redis Enterprise Softwar
   using Docker.
 linkTitle: Docker quickstart
 weight: 2
-aliases: /operate/rs/installing-upgrading/get-started-docker/
 url: '/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart/'
 ---
 {{< warning >}}

content/operate/rs/installing-upgrading/quickstarts/docker-quickstart.md

@@ -9,6 +9,7 @@ description: Set up a development or test deployment of Redis Enterprise Softwar
   using Docker.
 linkTitle: Docker quickstart
 weight: 2
+aliases: /operate/rs/installing-upgrading/get-started-docker/
 ---
 {{< warning >}}
 Docker containers are currently only supported for development and test environments, not for production. Use [Redis Enterprise on Kubernetes]({{< relref "/operate/kubernetes" >}}) for a supported containerized deployment.