Merge branch 'prod' into update-error-code-13371

vitessio · Aug 2, 2023 · 9e3c4fd · 9e3c4fd
2 parents 0689535 + ef5d2d3
commit 9e3c4fd
Show file tree

Hide file tree

Showing 90 changed files with 1,657 additions and 623 deletions.
diff --git a/content/en/docs/15.0/get-started/local-brew.md b/content/en/docs/15.0/get-started/local-brew.md
@@ -1,7 +1,7 @@
 ---
 title: Local Install via Homebrew
 description: Instructions for using Vitess on your macOS machine for testing purposes
-weight: 2
+weight: 3
 featured: true
 aliases: ['/docs/tutorials/local-brew/']
 ---

diff --git a/content/en/docs/15.0/get-started/local-docker.md b/content/en/docs/15.0/get-started/local-docker.md
@@ -1,11 +1,15 @@
 ---
 title: Local Install via Docker
 description: Instructions for using Vitess on your machine for testing purposes
-weight: 1
-featured: true
+weight: 5
+featured: false
 aliases: ['/docs/tutorials/local-docker/']
 ---
 
+{{< warning >}}
+This guide will only work on x86_64/amd64 based machines.
+{{</ warning >}}
+
 This guide illustrates how to run a local testing Vitess setup via Docker. The Vitess environment is identical to the [local setup](../local/), but without having to install software on one's host other than Docker.
 
 ## Check out the vitessio/vitess repository

diff --git a/content/en/docs/15.0/get-started/local.md b/content/en/docs/15.0/get-started/local.md
@@ -85,11 +85,11 @@ Download the [latest binary release](https://github.com/vitessio/vitess/releases
 **Notes:**
 
 * Release 15.0 has a bug because of which the local example fails when try to run vtadmin web. [Issue#11679](https://github.com/vitessio/vitess/issues/11679)
-* Please use release [15.0.3](https://github.com/vitessio/vitess/releases/tag/v15.0.3) instead.
+* Please use release [15.0.3](https://github.com/vitessio/vitess/releases/tag/v15.0.3) or later.
 
 ```sh
-version=15.0.3
-file=vitess-${version}-652b0da.tar.gz
+version=15.0.4
+file=vitess-${version}-72d943e.tar.gz
 wget https://github.com/vitessio/vitess/releases/download/v${version}/${file}
 tar -xzf ${file}
 cd ${file/.tar.gz/}

diff --git a/content/en/docs/15.0/get-started/operator.md b/content/en/docs/15.0/get-started/operator.md
@@ -1,6 +1,6 @@
 ---
 title: Vitess Operator for Kubernetes
-weight: 3
+weight: 1
 featured: true
 aliases: ['/docs/tutorials/kubernetes/','/user-guide/sharding-kubernetes.html', '/docs/get-started/scaleway/','/docs/get-started/kubernetes/']
 ---

diff --git a/content/en/docs/15.0/get-started/vttestserver-docker-image.md b/content/en/docs/15.0/get-started/vttestserver-docker-image.md
@@ -1,6 +1,6 @@
 ---
 title: Vttestserver Docker Image
-weight: 4
+weight: 10
 featured: true
 aliases: ['/docs/tutorials/vttestserver/']
 ---

diff --git a/content/en/docs/15.0/reference/features/messaging.md b/content/en/docs/15.0/reference/features/messaging.md
@@ -122,12 +122,22 @@ Messages can also be created to be sent in the future:
 
 ## Receiving messages
 
-Processes can subscribe to receive messages by sending a `MessageStream`
+Processes can subscribe to receive messages by sending a [`MessageStream`](https://pkg.go.dev/vitess.io/vitess/go/vt/vtgate#Executor.MessageStream)
 gRPC request to a `VTGate` or using the `stream * from <table>` SQL statement
 (if using the interactive mysql command-line client you must also pass the
-`-q`/`--quick` option). If there are multiple subscribers, the messages will be
-delivered in a round-robin fashion. Note that *this is not a broadcast*; each
-message will be sent to at most one subscriber.
+`-q`/`--quick` option):
+
+```mysql
+$ mysql --quick <vtgate params>
+mysql> SET WORKLOAD=OLAP;
+mysql> STREAM * FROM <table>;
+```
+
+</br>
+
+If there are multiple subscribers, the messages will be delivered in a round-robin
+fashion. Note that *this is not a broadcast*; each message will be sent to at most
+one subscriber.
 
 The format for messages is the same as a standard Vitess `Result` received from
 a `VTGate`. This means that standard database tools that understand query results

diff --git a/content/en/docs/16.0/get-started/local-brew.md b/content/en/docs/16.0/get-started/local-brew.md
@@ -1,7 +1,7 @@
 ---
 title: Local Install via Homebrew
 description: Instructions for using Vitess on your macOS machine for testing purposes
-weight: 2
+weight: 3
 featured: true
 aliases: ['/docs/tutorials/local-brew/']
 ---

diff --git a/content/en/docs/16.0/get-started/local-docker.md b/content/en/docs/16.0/get-started/local-docker.md
@@ -1,11 +1,15 @@
 ---
 title: Local Install via Docker
 description: Instructions for using Vitess on your machine for testing purposes
-weight: 1
-featured: true
+weight: 5
+featured: false
 aliases: ['/docs/tutorials/local-docker/']
 ---
 
+{{< warning >}}
+This guide will only work on x86_64/amd64 based machines.
+{{</ warning >}}
+
 This guide illustrates how to run a local testing Vitess setup via Docker. The Vitess environment is identical to the [local setup](../local/), but without having to install software on one's host other than Docker.
 
 ## Check out the vitessio/vitess repository

diff --git a/content/en/docs/16.0/get-started/local.md b/content/en/docs/16.0/get-started/local.md
@@ -85,12 +85,12 @@ Download the [latest binary release](https://github.com/vitessio/vitess/releases
 **Notes:**
 
 * Release 16.0.0 has an issue where the VTAdmin `web` directory is missing from the release artifacts.
-* Please use release [16.0.2](https://github.com/vitessio/vitess/releases/tag/v16.0.2) instead.
+* Please use release [16.0.2](https://github.com/vitessio/vitess/releases/tag/v16.0.2) or later.
 * Ubuntu is the only fully supported OS, for another OS please [build Vitess by yourself](/docs/contributing) or use the Docker images.
 
 ```sh
-version=16.0.2
-file=vitess-${version}-6076fed.tar.gz
+version=16.0.3
+file=vitess-${version}-a93cb55.tar.gz
 wget https://github.com/vitessio/vitess/releases/download/v${version}/${file}
 tar -xzf ${file}
 cd ${file/.tar.gz/}

diff --git a/content/en/docs/16.0/get-started/operator.md b/content/en/docs/16.0/get-started/operator.md
@@ -1,6 +1,6 @@
 ---
 title: Vitess Operator for Kubernetes
-weight: 3
+weight: 1
 featured: true
 aliases: ['/docs/tutorials/kubernetes/','/user-guide/sharding-kubernetes.html', '/docs/get-started/scaleway/','/docs/get-started/kubernetes/']
 ---

diff --git a/content/en/docs/16.0/get-started/vttestserver-docker-image.md b/content/en/docs/16.0/get-started/vttestserver-docker-image.md
@@ -1,6 +1,6 @@
 ---
 title: Vttestserver Docker Image
-weight: 4
+weight: 10
 featured: true
 aliases: ['/docs/tutorials/vttestserver/']
 ---

diff --git a/content/en/docs/16.0/reference/features/messaging.md b/content/en/docs/16.0/reference/features/messaging.md
@@ -122,12 +122,22 @@ Messages can also be created to be sent in the future:
 
 ## Receiving messages
 
-Processes can subscribe to receive messages by sending a `MessageStream`
+Processes can subscribe to receive messages by sending a [`MessageStream`](https://pkg.go.dev/vitess.io/vitess/go/vt/vtgate#Executor.MessageStream)
 gRPC request to a `VTGate` or using the `stream * from <table>` SQL statement
 (if using the interactive mysql command-line client you must also pass the
-`-q`/`--quick` option). If there are multiple subscribers, the messages will be
-delivered in a round-robin fashion. Note that *this is not a broadcast*; each
-message will be sent to at most one subscriber.
+`-q`/`--quick` option):
+
+```mysql
+$ mysql --quick <vtgate params>
+mysql> SET WORKLOAD=OLAP;
+mysql> STREAM * FROM <table>;
+```
+
+</br>
+
+If there are multiple subscribers, the messages will be delivered in a round-robin
+fashion. Note that *this is not a broadcast*; each message will be sent to at most
+one subscriber.
 
 The format for messages is the same as a standard Vitess `Result` received from
 a `VTGate`. This means that standard database tools that understand query results

diff --git a/content/en/docs/17.0/get-started/local-brew.md b/content/en/docs/17.0/get-started/local-brew.md
@@ -1,7 +1,7 @@
 ---
 title: Local Install via Homebrew
 description: Instructions for using Vitess on your macOS machine for testing purposes
-weight: 2
+weight: 3
 featured: true
 aliases: ['/docs/tutorials/local-brew/']
 ---
@@ -37,12 +37,12 @@ Already downloaded: /Users/askdba/Library/Caches/Homebrew/downloads/45991b27589a
 ```
 At this point Vitess binaries installed under default Homebrew install location at /usr/local/share/vitess.
 
-### Install Node 16.13.0+ (required to run VTAdmin)
+### Install Node 18.16.0+ (required to run VTAdmin)
 
 ```bash
 $ brew install nvm
-$ nvm install --lts 16.13.0
-$ nvm use 16.13.0
+$ nvm install --lts 18.16.0
+$ nvm use 18.16.0
 ```
 
 See the [vtadmin README](https://github.com/vitessio/vitess/blob/main/web/vtadmin/README.md) for more details.
@@ -60,41 +60,42 @@ Created cell: zone1
 etcd start done...
 Starting vtctld...
 vtctld is running!
+Successfully created keyspace commerce. Result:
+{
+  "name": "commerce",
+  "keyspace": {
+    "served_froms": [],
+    "keyspace_type": 0,
+    "base_keyspace": "",
+    "snapshot_time": null,
+    "durability_policy": "semi_sync",
+    "throttler_config": null,
+    "sidecar_db_name": "_vt"
+  }
+}
 Starting MySQL for tablet zone1-0000000100...
 Starting vttablet for zone1-0000000100...
 HTTP/1.1 200 OK
-Date: Thu, 01 Sep 2022 12:49:50 GMT
+Date: Mon, 26 Jun 2023 19:21:51 GMT
 Content-Type: text/html; charset=utf-8
 
 Starting MySQL for tablet zone1-0000000101...
 Starting vttablet for zone1-0000000101...
 HTTP/1.1 200 OK
-Date: Thu, 01 Sep 2022 12:49:55 GMT
+Date: Mon, 26 Jun 2023 19:21:54 GMT
 Content-Type: text/html; charset=utf-8
 
 Starting MySQL for tablet zone1-0000000102...
 Starting vttablet for zone1-0000000102...
 HTTP/1.1 200 OK
-Date: Thu, 01 Sep 2022 12:50:00 GMT
+Date: Mon, 26 Jun 2023 19:21:56 GMT
 Content-Type: text/html; charset=utf-8
 
-{
-  "keyspace": {
-    "served_froms": [],
-    "keyspace_type": 0,
-    "base_keyspace": "",
-    "snapshot_time": null,
-    "durability_policy": "semi_sync",
-    "throttler_config": null,
-    "sidecar_db_name": "_vt"
-  }
-}
 vtorc is running!
   - UI: http://localhost:16000
-  - Logs: /Users/manangupta/vitess/vtdataroot/tmp/vtorc.out
-  - PID: 74088
+  - Logs: /Users/florentpoinsard/Code/vitess/vtdataroot/tmp/vtorc.out
+  - PID: 49556
 
-zone1-0000000100 commerce 0 primary localhost:15100 localhost:17100 [] 2022-09-23T05:48:52Z
 
 New VSchema object:
 {
@@ -107,75 +108,43 @@ New VSchema object:
       "auto_increment": null,
       "columns": [],
       "pinned": "",
-      "column_list_authoritative": false
+      "column_list_authoritative": false,
+      "source": ""
     },
     "customer": {
       "type": "",
       "column_vindexes": [],
       "auto_increment": null,
       "columns": [],
       "pinned": "",
-      "column_list_authoritative": false
+      "column_list_authoritative": false,
+      "source": ""
     },
     "product": {
       "type": "",
       "column_vindexes": [],
       "auto_increment": null,
       "columns": [],
       "pinned": "",
-      "column_list_authoritative": false
+      "column_list_authoritative": false,
+      "source": ""
     }
   },
   "require_explicit_routing": false
 }
 If this is not what you expected, check the input data (as JSON parsing will skip unexpected fields).
 Waiting for vtgate to be up...
 vtgate is up!
-Access vtgate at http://Manans-MacBook-Pro.local:15001/debug/status
+Access vtgate at http://Florents-MacBook-Pro-2.local:15001/debug/status
 vtadmin-api is running!
-  - API: http://localhost:14200
-  - Logs: /Users/manangupta/vitess/vtdataroot/tmp/vtadmin-api.out
-  - PID: 74039
-
-> vtadmin@0.1.0 build
-> vite build
-
-vite v4.2.1 building for production...
-transforming (1218) src/icons/alertFail.svgUse of eval in "node_modules/@protobufjs/inquire/index.js" is strongly discouraged as it poses security risks and may cause issues with minification.
-✓ 1231 modules transformed.
-build/assets/chevronUp-3d6782a5.svg              0.18 kB
-build/assets/chevronDown-02f94e73.svg            0.19 kB
-build/assets/download-8ef290b4.svg               0.21 kB
-build/assets/delete-a9184ef9.svg                 0.23 kB
-build/assets/info-2617ee9d.svg                   0.34 kB
-build/assets/circleAdd-cfd7e5db.svg              0.35 kB
-build/assets/alertFail-8056b6e4.svg              0.35 kB
-build/assets/checkSuccess-f8fd1dbb.svg           0.36 kB
-build/assets/search-3261bac7.svg                 0.41 kB
-build/assets/question-a67b2492.svg               0.46 kB
-build/assets/runQuery-edfab4ed.svg               0.49 kB
-build/assets/open-405dd348.svg                   0.49 kB
-build/index.html                                 0.90 kB
-build/assets/bug-5b6edb54.svg                    0.99 kB
-build/assets/topology-0032b65e.svg               1.62 kB
-build/assets/NotoMono-Regular-41fd7ccc.ttf     107.85 kB
-build/assets/NotoSans-Regular-c8cff31f.ttf     313.14 kB
-build/assets/NotoSans-SemiBold-43207822.ttf    313.72 kB
-build/assets/NotoSans-Bold-c6a598dd.ttf        313.79 kB
-build/assets/index-ef40fbc9.css                 87.78 kB │ gzip:  15.02 kB
-build/assets/index-4ddb52ed.js               2,811.88 kB │ gzip: 492.59 kB
-
-(!) Some chunks are larger than 500 kBs after minification. Consider:
-- Using dynamic import() to code-split the application
-- Use build.rollupOptions.output.manualChunks to improve chunking: https://rollupjs.org/configuration-options/#output-manualchunks
-- Adjust chunk size limit for this warning via build.chunkSizeWarningLimit.
-✓ built in 10.85s
+  - API: http://Florents-MacBook-Pro-2.local:14200
+  - Logs: /Users/florentpoinsard/Code/vitess/vtdataroot/tmp/vtadmin-api.out
+  - PID: 49695
 
 vtadmin-web is running!
-  - Browser: http://localhost:14201
-  - Logs: /Users/manangupta/vitess/vtdataroot/tmp/vtadmin-web.out
-  - PID: 74070
-
+  - Browser: http://Florents-MacBook-Pro-2.local:14201
+  - Logs: /Users/florentpoinsard/Code/vitess/vtdataroot/tmp/vtadmin-web.out
+  - PID: 49698
 ```
 Verify your initial cluster:
 ```sql

diff --git a/content/en/docs/17.0/get-started/local-docker.md b/content/en/docs/17.0/get-started/local-docker.md
@@ -1,11 +1,15 @@
 ---
 title: Local Install via Docker
 description: Instructions for using Vitess on your machine for testing purposes
-weight: 1
-featured: true
+weight: 5
+featured: false
 aliases: ['/docs/tutorials/local-docker/']
 ---
 
+{{< warning >}}
+This guide will only work on x86_64/amd64 based machines.
+{{</ warning >}}
+
 This guide illustrates how to run a local testing Vitess setup via Docker. The Vitess environment is identical to the [local setup](../local/), but without having to install software on one's host other than Docker.
 
 ## Check out the vitessio/vitess repository

diff --git a/content/en/docs/17.0/get-started/local.md b/content/en/docs/17.0/get-started/local.md
@@ -65,8 +65,8 @@ Download the [latest binary release](https://github.com/vitessio/vitess/releases
 * Ubuntu is the only fully supported OS, for another OS please [build Vitess by yourself](/docs/contributing) or use the Docker images.
 
 ```sh
-version=17.0.0
-file=vitess-${version}-70a9466.tar.gz
+version=17.0.1
+file=vitess-${version}-a4e751f.tar.gz
 wget https://github.com/vitessio/vitess/releases/download/v${version}/${file}
 tar -xzf ${file}
 cd ${file/.tar.gz/}

diff --git a/content/en/docs/17.0/get-started/operator.md b/content/en/docs/17.0/get-started/operator.md
@@ -1,6 +1,6 @@
 ---
 title: Vitess Operator for Kubernetes
-weight: 3
+weight: 1
 featured: true
 aliases: ['/docs/tutorials/kubernetes/','/user-guide/sharding-kubernetes.html', '/docs/get-started/scaleway/','/docs/get-started/kubernetes/']
 ---

diff --git a/content/en/docs/17.0/get-started/vttestserver-docker-image.md b/content/en/docs/17.0/get-started/vttestserver-docker-image.md
@@ -1,6 +1,6 @@
 ---
 title: Vttestserver Docker Image
-weight: 4
+weight: 10
 featured: true
 aliases: ['/docs/tutorials/vttestserver/']
 ---