Merge branch 'main' into DOC-4673

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}"
 

.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/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/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.

content/commands/flushall/index.md

@@ -62,6 +62,10 @@ It is possible to use one of the following modifiers to dictate the flushing mod
 * `ASYNC`: flushes the databases asynchronously
 * `SYNC`: flushes the databases synchronously
 
+{{< clients-example cmds_servermgmt flushall >}}
+FLUSHALL SYNC
+{{< /clients-example >}}
+
 ## Notes
 
 * An asynchronous `FLUSHALL` command only deletes keys that were present at the time the command was invoked. Keys created during an asynchronous flush will be unaffected.

content/commands/hgetall/index.md

@@ -53,6 +53,20 @@ of the reply is twice the size of the hash.
 
 ## Examples
 
+{{< clients-example cmds_hash hgetall >}}
+redis> HSET myhash field1 "Hello"
+(integer) 1
+redis> HSET myhash field2 "World"
+(integer) 1
+redis> HGETALL myhash
+1) "field1"
+2) "Hello"
+3) "field2"
+4) "World"
+{{< /clients-example >}}
+
+Give these commands a try in the interactive console:
+
 {{% redis-cli %}}
 HSET myhash field1 "Hello"
 HSET myhash field2 "World"

content/commands/hvals/index.md

@@ -51,6 +51,18 @@ Returns all values in the hash stored at `key`.
 
 ## Examples
 
+{{< clients-example cmds_hash hvals >}}
+redis> HSET myhash field1 "Hello"
+(integer) 1
+redis> HSET myhash field2 "World"
+(integer) 1
+redis> HVALS myhash
+1) "Hello"
+2) "World"
+{{< /clients-example >}}
+
+Give these commands a try in the interactive console:
+
 {{% redis-cli %}}
 HSET myhash field1 "Hello"
 HSET myhash field2 "World"

content/commands/incrbyfloat/index.md

@@ -81,11 +81,11 @@ regardless of the actual internal precision of the computation.
 ## Examples
 
 {{% redis-cli %}}
-SET mykey "10.50"
-INCRBYFLOAT mykey "0.1"
-INCRBYFLOAT mykey "-5"
-SET mykey "5.0e3"
-INCRBYFLOAT mykey "2.0e2"
+SET mykey 10.50
+INCRBYFLOAT mykey 0.1
+INCRBYFLOAT mykey -5
+SET mykey 5.0e3
+INCRBYFLOAT mykey 2.0e2
 {{% /redis-cli %}}
 
 

content/commands/info/index.md

@@ -68,6 +68,12 @@ It can also take the following values:
 
 When no parameter is provided, the `default` option is assumed.
 
+{{< clients-example cmds_servermgmt info >}}
+INFO
+{{< /clients-example >}}
+
+Give these commands a try in the interactive console:
+
 {{% redis-cli %}}
 INFO
 {{% /redis-cli %}}