Merge branch 'main' into DOC-4192

Author: rrelledge

.github/workflows/k8s_apis_sync.yaml

@@ -80,6 +80,41 @@ jobs:
           sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_remote_cluster_api.md
           awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_remote_cluster_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_remote_cluster_api.md
 
+      - name: 'Generate YAML snippets'
+        run: |-
+          function formatYamlSnippet() {
+          cat > "$2" << EOL
+          \`\`\`yaml
+          $(cat $1)
+          \`\`\`
+          EOL
+          }
+
+          formatYamlSnippet admission-service.yaml content/embeds/admission-service.md
+          formatYamlSnippet admission/webhook.yaml content/embeds/admission_webhook.md
+          formatYamlSnippet examples/v1/rec.yaml content/embeds/rec.md
+          formatYamlSnippet examples/v1alpha1/reaadb.yaml content/embeds/reaadb.md
+          formatYamlSnippet examples/v1alpha1/redb.yaml content/embeds/redb.md
+          formatYamlSnippet examples/v1alpha1/rerc.yaml content/embeds/rerc.md
+          formatYamlSnippet log_collector/log_collector_role_all_mode.yaml content/embeds/log_collector_role_all_mode.md
+          formatYamlSnippet log_collector/log_collector_role_restricted_mode.yaml content/embeds/log_collector_role_restricted_mode.md
+          formatYamlSnippet multi-namespace-redb/operator_cluster_role_binding.yaml content/embeds/multi-ns_operator_cluster_role_binding.md
+          formatYamlSnippet multi-namespace-redb/operator_cluster_role.yaml content/embeds/multi-ns_operator_cluster_role.md
+          formatYamlSnippet multi-namespace-redb/role_binding.yaml content/embeds/multi-ns_role_binding.md
+          formatYamlSnippet multi-namespace-redb/role.yaml content/embeds/multi-ns_role.md
+          formatYamlSnippet openshift/admission-service.yaml content/embeds/openshift_admission-service.md
+          formatYamlSnippet openshift/rec_rhel.yaml content/embeds/openshift_rec.md
+          formatYamlSnippet openshift/role_binding.yaml content/embeds/openshift_role_binding.md
+          formatYamlSnippet openshift/role.yaml content/embeds/openshift_role.md
+          formatYamlSnippet openshift/scc.yaml content/embeds/openshift_scc.md
+          formatYamlSnippet openshift/service_account.yaml content/embeds/openshift_service_account.md
+          formatYamlSnippet rack_awareness/rack_aware_cluster_role_binding.yaml content/embeds/rack_aware_cluster_role_binding.md
+          formatYamlSnippet rack_awareness/rack_aware_cluster_role.yaml content/embeds/rack_aware_cluster_role.md
+          formatYamlSnippet rack_awareness/rack_aware_rec.yaml content/embeds/rack_aware_rec.md
+          formatYamlSnippet role_binding.yaml content/embeds/role_binding.md
+          formatYamlSnippet role.yaml content/embeds/role.md
+          formatYamlSnippet service_account.yaml content/embeds/service_account.md
+
       - name: 'Send pull request'
         env:
           GH_TOKEN: ${{ steps.generate-token.outputs.token }}
@@ -101,6 +136,8 @@ jobs:
           git apply content/operate/kubernetes/reference/kubernetes-api-reference-frontmatter.patch
 
           git add content/operate/kubernetes/reference/
+          git add content/embeds/
+
           git commit -m "k8s api docs ${RELEASE}"
           git push origin "${BRANCH}"
 

.github/workflows/rc_api_sync.yaml

@@ -0,0 +1,70 @@
+name: rc_api_sync
+
+on:
+  schedule:
+    - cron: '0 0 * * *' # run every day at midnight UTC time
+  workflow_dispatch: # or run on manual trigger
+
+jobs:
+  rc_api_sync:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      actions: write
+    steps:
+      - name: 'Checkout'
+        uses: 'actions/checkout@v3'
+
+      - name: 'Fetch openapi json file'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          branch="rc_api_sync"
+          spec_change=false
+
+          # check if remote branch already exists
+          git fetch --all
+          set +e
+          git ls-remote --exit-code --heads origin "refs/heads/${branch}"
+          if [ "$?" -eq 0 ]; then
+            set -e
+            # if it does, create local branch off existing remote branch
+            git checkout -b "${branch}" "origin/${branch}"
+            git branch --set-upstream-to="origin/${branch}" "${branch}"
+            git pull
+          else
+            set -e
+            # otherwise, create local branch from main
+            git checkout -b "${branch}"
+          fi
+
+          curl -Ls https://api.redislabs.com/v1/cloud-api-docs \
+            | jq '(.. | .example? | try select(test("^{"))) |= fromjson' > content/operate/rc/api/api-reference/openapi.json
+
+          spec_is_different=$(git diff content/operate/rc/api/api-reference/openapi.json)
+
+          if [[ ! -z $spec_is_different ]]; then
+            spec_change=true
+
+            git add "content/operate/rc/api/api-reference/openapi.json"
+            git config user.email "177626021+redisdocsapp[bot]@users.noreply.github.com"
+            git config user.name "redisdocsapp[bot]"
+            git commit -m "Update content/operate/rc/api/api-reference/openapi.json"
+          fi
+
+          if [ "$spec_change" = true ] ; then
+            git push origin "${branch}"
+
+            # If a pr is not already open, create one
+            set +e
+            gh search prs -R redis/docs --state open --match title "update rc openapi spec" | grep -q "update rc openapi spec"
+            if [ "$?" -eq 1 ]; then
+              set -e
+              gh pr create \
+                --body "update rc openapi spec" \
+                --title "update rc openapi spec" \
+                --head "$branch" \
+                --base "main"
+            fi
+          fi

.gitignore

@@ -6,6 +6,7 @@
 /data/repos.json
 /data/tool_types.json
 /data/versions.json
+/data/components_local/
 /examples
 build/components/__pycache__/
 venv/**
@@ -14,3 +15,4 @@ package-lock.json
 .hugo_build.lock
 .vscode/
 .DS_Store
+.idea

Makefile

@@ -4,6 +4,7 @@ HUGO_BUILD=--gc
 
 all: clean deps components hugo
 serve: clean deps components serve_hugo
+localserve: clean deps components_local serve_hugo
 
 deps:
 	@npm install
@@ -13,6 +14,9 @@ deps:
 components:
 	@python3 build/make.py
 
+components_local:
+	@python3 build/make.py --stack ./data/components_local/index.json
+
 hugo:
 	@hugo $(HUGO_DEBUG) $(HUGO_BUILD)
 

content/apis/_index.md

@@ -45,7 +45,7 @@ Redis Cloud is a fully managed Database as a Service offering and the fastest wa
 
 - [Redis Cloud REST API introduction]({{< relref "/operate/rc/api/" >}})
 - [Redis Cloud REST API examples]({{< relref "/operate/rc/api/examples/" >}})
-- [Redis Cloud REST API reference](https://api.redislabs.com/v1/swagger-ui.html)
+- [Redis Cloud REST API reference]({{< relref "/operate/rc/api/api-reference" >}})
 
 
 ### Redis Enterprise Software API

content/commands/auth/index.md

@@ -51,7 +51,9 @@ The AUTH command authenticates the current connection in two cases:
 Redis versions prior of Redis 6 were only able to understand the one argument
 version of the command:
 
-    AUTH <password>
+{{< clients-example cmds_cnxmgmt auth1 >}}
+AUTH "temp-pass"
+{{< /clients-example >}}
 
 This form just authenticates against the password set with `requirepass`.
 In this configuration Redis will deny any command executed by the just
@@ -62,7 +64,9 @@ Otherwise, an error is returned and the clients needs to try a new password.
 
 When Redis ACLs are used, the command should be given in an extended way:
 
-    AUTH <username> <password>
+{{< clients-example cmds_cnxmgmt auth2 >}}
+AUTH "test-user" "strong_password"
+{{< /clients-example >}}
 
 In order to authenticate the current connection with one of the connections
 defined in the ACL list (see [`ACL SETUSER`]({{< relref "/commands/acl-setuser" >}})) and the official [ACL guide]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) for more information.

content/commands/bf.reserve/index.md

@@ -46,12 +46,13 @@ Though the filter can scale up by creating sub-filters, it is recommended to res
 sub-filters requires additional memory (each sub-filter uses an extra bits and hash function) and consume  further CPU time than an equivalent filter that had
 the right capacity at creation time.
 
-The number of hash functions is `-log(error)/ln(2)^2`.
-The number of bits per item is `-log(error)/ln(2)` ≈ 1.44.
+The optimal number of hash functions is `ceil(-ln(error_rate) / ln(2))`.
 
-* **1%**    error rate requires 7  hash functions and 10.08 bits per item.
-* **0.1%**  error rate requires 10 hash functions and 14.4  bits per item.
-* **0.01%** error rate requires 14 hash functions and 20.16 bits per item.
+The required number of bits per item, given the desired `error_rate` and the optimal number of hash functions, is `-ln(error_rate) / ln(2)^2`. Hence, the required number of bits in the filter is `capacity * -ln(error_rate) / ln(2)^2`.
+
+* **1%**    error rate requires  7 hash functions and  9.585 bits per item.
+* **0.1%**  error rate requires 10 hash functions and 14.378 bits per item.
+* **0.01%** error rate requires 14 hash functions and 19.170 bits per item.
 
 ## Required arguments
 
@@ -86,7 +87,7 @@ Non-scaling filters requires slightly less memory than their scaling counterpart
 When `capacity` is reached, an additional sub-filter is created.
 The size of the new sub-filter is the size of the last sub-filter multiplied by `expansion`, specified as a positive integer.
 
-If the number of elements to be stored in the filter is unknown, you use an `expansion` of `2` or more to reduce the number of sub-filters.
+If the number of items to be stored in the filter is unknown, you use an `expansion` of `2` or more to reduce the number of sub-filters.
 Otherwise, you use an `expansion` of `1` to reduce memory consumption. The default value is `2`.
 </details>
 

content/commands/bitpos/index.md

@@ -104,16 +104,25 @@ Non-existent keys are treated as empty strings.
 
 ## Examples
 
-{{% redis-cli %}}
-SET mykey "\xff\xf0\x00"
-BITPOS mykey 0
-SET mykey "\x00\xff\xf0"
-BITPOS mykey 1 0
-BITPOS mykey 1 2
-BITPOS mykey 1 2 -1 BYTE
-BITPOS mykey 1 7 15 BIT
-set mykey "\x00\x00\x00"
-BITPOS mykey 1
-BITPOS mykey 1 7 -3 BIT
-{{% /redis-cli %}}
-
+```redis
+redis> SET mykey "\xff\xf0\x00"
+OK
+redis> BITPOS mykey 0
+(integer) 12
+redis> SET mykey "\x00\xff\xf0"
+OK
+redis> BITPOS mykey 1 0
+(integer) 8
+redis> BITPOS mykey 1 2
+(integer) 16
+redis> BITPOS mykey 1 2 -1 BYTE
+(integer) 16
+redis> BITPOS mykey 1 7 15 BIT
+(integer) 8
+redis> set mykey "\x00\x00\x00"
+OK
+redis> BITPOS mykey 1
+(integer) -1
+redis> BITPOS mykey 1 7 -3 BIT
+(integer) -1
+```

content/commands/client-list/index.md

@@ -114,6 +114,8 @@ Here is the meaning of the fields:
 * `user`: the authenticated username of the client
 * `redir`: client id of current client tracking redirection
 * `resp`: client RESP protocol version. Added in Redis 7.0
+* `rbp`: peak size of the client's read buffer since the client connected. Added in Redis 7.0
+* `rbs`: current size of the client's read buffer in bytes. Added in Redis 7.0
 
 The client flags can be a combination of:
 

content/commands/cluster-forget/index.md

@@ -26,6 +26,9 @@ complexity: O(1)
 description: Removes a node from the nodes table.
 group: cluster
 hidden: false
+history:
+- - 7.2.0
+  - Forgotten nodes are automatically propagated across the cluster via gossip.
 linkTitle: CLUSTER FORGET
 since: 3.0.0
 summary: Removes a node from the nodes table.
@@ -49,6 +52,10 @@ table of the node receiving the command, it also implements a ban-list, not
 allowing the same node to be added again as a side effect of processing the
 *gossip section* of the heartbeat packets received from other nodes.
 
+Starting with Redis 7.2.0, the ban-list is included in cluster gossip ping/pong messages. 
+This means that `CLUSTER FORGET` doesn't need to be sent to all nodes in a cluster.
+You can run the command on one or more nodes, after which it will be propagated to the rest of the nodes in most cases.
+
 ## Details on why the ban-list is needed
 
 In the following example we'll show why the command must not just remove
@@ -86,3 +93,8 @@ The command does not succeed and returns an error in the following cases:
 1. The specified node ID is not found in the nodes table.
 2. The node receiving the command is a replica, and the specified node ID identifies its current master.
 3. The node ID identifies the same node we are sending the command to.
+
+## Behavior change history
+
+*   `>= 7.2.0`: Automatically propagate node deletion to other nodes in a cluster, allowing nodes to be deleted with a single call
+  in most cases.