Merge branch 'main' into release-rs-fuya-fuya

Author: rrelledge

.github/workflows/k8s_apis_sync.yaml

@@ -0,0 +1,103 @@
+name: k8s_apis_sync
+
+on:
+  workflow_dispatch:
+    inputs:
+      release:
+        type: string
+        required: true
+        description: ''
+      bucket_folder:
+        type: string
+        required: true
+        description: ''
+
+jobs:
+  k8s_apis_sync:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      actions: write
+    steps:
+      - name: Generate a token
+        id: generate-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.DOCS_APP_ID }}
+          private-key: ${{ secrets.DOCS_APP_PRIVATE_KEY }}
+
+      - name: 'Checkout'
+        uses: actions/checkout@v3
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+
+      - name: 'Install crdoc'
+        run: |-
+          curl -LO https://github.com/fybrik/crdoc/releases/download/v0.6.3/crdoc_Linux_x86_64.tar.gz
+          tar -xvzf crdoc_Linux_x86_64.tar.gz
+          sudo mv crdoc /bin/crdoc
+
+      - name: 'Fetch release'
+        run: |-
+          RELEASE="${{ github.event.inputs.release }}"
+          BUCKET_FOLDER="${{ github.event.inputs.bucket_folder }}"
+          aws s3 cp "s3://redislabs-k8s/${BUCKET_FOLDER}/redis-enterprise-operator-${RELEASE}.tar.gz" --no-sign-request . --region us-east-1
+
+          tar xf "redis-enterprise-operator-${RELEASE}.tar.gz"
+
+      - name: 'Generate READMEs'
+        run: |-
+          mkdir artifacts
+          mkdir templates
+          cp content/operate/kubernetes/reference/kubernetes-api-reference-template.tmpl templates/template.tmpl
+
+          crdoc --resources crds/reaadb_crd.yaml --output artifacts/redis_enterprise_active_active_database_api.md --template templates/template.tmpl
+          sed -E -i 's/^### RedisEnterpriseActiveActiveDatabase\./### /g' artifacts/redis_enterprise_active_active_database_api.md
+          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseactiveactivedatabase/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_active_active_database_api.md
+          sed -E -i 's/<td><b><a href="#redisenterpriseactiveactivedatabase/<td><b><a href="#/' artifacts/redis_enterprise_active_active_database_api.md
+
+          crdoc --resources crds/rec_crd.yaml --output artifacts/redis_enterprise_cluster_api.md --template templates/template.tmpl
+          sed -E -i 's/^### RedisEnterpriseCluster\./### /g' artifacts/redis_enterprise_cluster_api.md
+          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterprisecluster/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_cluster_api.md
+          sed -E -i 's/<td><b><a href="#redisenterprisecluster/<td><b><a href="#/' artifacts/redis_enterprise_cluster_api.md
+
+          crdoc --resources crds/redb_crd.yaml --output artifacts/redis_enterprise_database_api.md --template templates/template.tmpl
+          sed -E -i 's/^### RedisEnterpriseDatabase\./### /g' artifacts/redis_enterprise_database_api.md
+          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterprisedatabase/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_database_api.md
+          sed -E -i 's/<td><b><a href="#redisenterprisedatabase/<td><b><a href="#/' artifacts/redis_enterprise_database_api.md
+
+          crdoc --resources crds/rerc_crd.yaml --output artifacts/redis_enterprise_remote_cluster.md --template templates/template.tmpl
+          sed -E -i 's/^### RedisEnterpriseRemoteCluster\./### /g' artifacts/redis_enterprise_remote_cluster.md
+          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseremotecluster/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_remote_cluster.md
+          sed -E -i 's/<td><b><a href="#redisenterpriseremotecluster/<td><b><a href="#/' artifacts/redis_enterprise_remote_cluster.md
+
+      - name: 'Send pull request'
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
+        run: |-
+          RELEASE="${{ github.event.inputs.release }}"
+          BRANCH="k8s_apis_docs_${RELEASE}"
+
+          # Setup git email and username
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+
+          git checkout -b "${BRANCH}"
+
+          cp artifacts/redis_enterprise_active_active_database_api.md content/operate/kubernetes/reference/
+          cp artifacts/redis_enterprise_cluster_api.md content/operate/kubernetes/reference/
+          cp artifacts/redis_enterprise_database_api.md content/operate/kubernetes/reference/
+          cp artifacts/redis_enterprise_remote_cluster.md content/operate/kubernetes/reference/
+
+          git apply content/operate/kubernetes/reference/kubernetes-api-reference-frontmatter.patch
+
+          git add content/operate/kubernetes/reference/
+          git commit -m "k8s api docs ${RELEASE}"
+          git push origin "${BRANCH}"
+
+          gh pr create \
+            --body "k8s api docs ${RELEASE}" \
+            --title "k8s api docs ${RELEASE}" \
+            --head "$BRANCH" \
+            --base "main"

build/components/example.py

@@ -19,6 +19,7 @@
     'java': '//',
     'go': '//',
     'c#': '//',
+    'redisvl': '#'
 }
 
 class Example(object):

config.toml

@@ -45,7 +45,7 @@ tagManagerId = "GTM-TKZ6J9R"
 gitHubRepo = "https://github.com/redis/docs"
 
 # Display and sort order for client examples
-clientsExamples = ["Python", "Node.js", "Java", "Go", "C#"]
+clientsExamples = ["Python", "Node.js", "Java", "Go", "C#", "RedisVL"]
 searchService = "/convai/api/search-service"
 ratingsService = "/docusight/api/rate"
 
@@ -56,6 +56,14 @@ rdi_debezium_server_version = "2.3.0.Final"
 rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
 rdi_cli_latest = "latest"
 
+[params.clientsConfig]
+"Python"={lang="python", quickstartSlug="python/redis-py"}
+"Node.js"={lang="javascript", quickstartSlug="nodejs"}
+"Java"={lang="java", quickstartSlug="java/jedis"}
+"Go"={lang="go", quickstartSlug="go"}
+"C#"={lang="C#", quickstartSlug="dotnet"}
+"RedisVL"={lang="python", quickstartSlug="python/redis-vl"}
+
 # Markup
 [markup]
   [markup.goldmark]

content/commands/tdigest.byrank/index.md

@@ -15,7 +15,7 @@ categories:
 - oss
 - kubernetes
 - clients
-complexity: O(1)
+complexity: O(N) where N is the number of ranks specified.
 description: Returns, for each input rank, an estimation of the value (floating-point)
   with that rank
 group: tdigest

content/commands/tdigest.byrevrank/index.md

@@ -15,7 +15,7 @@ categories:
 - oss
 - kubernetes
 - clients
-complexity: O(1)
+complexity: O(N) where N is the number of reverse ranks specified.
 description: Returns, for each input reverse rank, an estimation of the value (floating-point)
   with that reverse rank
 group: tdigest

content/commands/tdigest.cdf/index.md

@@ -15,7 +15,7 @@ categories:
 - oss
 - kubernetes
 - clients
-complexity: O(1)
+complexity: O(N) where N is the number of values specified.
 description: Returns, for each input value, an estimation of the fraction (floating-point)
   of (observations smaller than the given value + half the observations equal to the
   given value)
@@ -34,7 +34,7 @@ title: TDIGEST.CDF
 ---
 Returns, for each input value, an estimation of the fraction (floating-point) of (observations smaller than the given value + half the observations equal to the given value).
 
-Multiple fractions can be retrieved in a signle call.
+Multiple fractions can be retrieved in a single call.
 
 ## Required arguments
 

content/commands/tdigest.quantile/index.md

@@ -15,7 +15,7 @@ categories:
 - oss
 - kubernetes
 - clients
-complexity: O(1)
+complexity: O(N) where N is the number of quantiles specified.
 description: Returns, for each input fraction, an estimation of the value (floating
   point) that is smaller than the given fraction of observations
 group: tdigest
@@ -32,7 +32,7 @@ title: TDIGEST.QUANTILE
 ---
 Returns, for each input fraction, an estimation of the value (floating point) that is smaller than the given fraction of observations.
 
-Multiple quantiles can be retrieved in a signle call.
+Multiple quantiles can be retrieved in a single call.
 
 ## Required arguments
 

content/commands/tdigest.rank/index.md

@@ -15,7 +15,7 @@ categories:
 - oss
 - kubernetes
 - clients
-complexity: O(1)
+complexity: O(N) where N is the number of values specified.
 description: Returns, for each input value (floating-point), the estimated rank of
   the value (the number of observations in the sketch that are smaller than the value
   + half the number of observations that are equal to the value)
@@ -34,7 +34,7 @@ title: TDIGEST.RANK
 ---
 Returns, for each input value (floating-point), the estimated rank of the value (the number of observations in the sketch that are smaller than the value + half the number of observations that are equal to the value).
 
-Multiple ranks can be retrieved in a signle call.
+Multiple ranks can be retrieved in a single call.
 
 ## Required arguments
 <details open><summary><code>key</code></summary>

content/commands/tdigest.revrank/index.md

@@ -15,7 +15,7 @@ categories:
 - oss
 - kubernetes
 - clients
-complexity: O(1)
+complexity: O(N) where N is the number of values specified.
 description: Returns, for each input value (floating-point), the estimated reverse
   rank of the value (the number of observations in the sketch that are larger than
   the value + half the number of observations that are equal to the value)
@@ -34,7 +34,7 @@ title: TDIGEST.REVRANK
 ---
 Returns, for each input value (floating-point), the estimated reverse rank of the value (the number of observations in the sketch that are larger than the value + half the number of observations that are equal to the value).
 
-Multiple reverse ranks can be retrieved in a signle call.
+Multiple reverse ranks can be retrieved in a single call.
 
 ## Required arguments
 <details open><summary><code>key</code></summary>

content/commands/ts.create/index.md

@@ -149,6 +149,9 @@ is policy for handling insertion ([`TS.ADD`]({{< baseurl >}}/commands/ts.add/) a
   - `SUM`: If a previous sample exists, add the new sample to it so that the updated value is equal to (previous + new). If no previous sample exists, set the updated value equal to the new value.
 
   When not specified: set to the global [DUPLICATE_POLICY]({{< baseurl >}}/develop/data-types/timeseries/configuration#duplicate_policy) configuration of the database (which, by default, is `BLOCK`).
+
+`BLOCK` is often used to avoid accidental changes. `FIRST` can be used as an optimization when duplicate reports are possible. `LAST` can be used when updates are being reported. `SUM` is used for counters (e.g., the number of cars entering a parking lot per minute when there are multiple reporting counting devices). `MIN` and `MAX` can be used, for example, to store the minimal/maximal stock price per minute (instead of storing all the samples and defining a compaction rule).
+
 </details>
 
 <details open><summary><code>IGNORE ignoreMaxTimediff ignoreMaxValDiff</code></summary>