Update website docs for v17.0.0-rc1 release (#1491)

* Update website docs for v17.0.0-rc1 release Signed-off-by: Matt Lord <[email protected]> * Update release hash Signed-off-by: Matt Lord <[email protected]> * Make minor updates Signed-off-by: Matt Lord <[email protected]> * Correct version for download Signed-off-by: Matt Lord <[email protected]> --------- Signed-off-by: Matt Lord <[email protected]>
vitessio · Jun 6, 2023 · 86d2498 · 86d2498
1 parent 157b467
commit 86d2498
Show file tree

Hide file tree

Showing 375 changed files with 42,325 additions and 10 deletions.
diff --git a/config.toml b/config.toml
@@ -13,8 +13,8 @@ pygmentsStyle = "fruity"
 # Versions (folder-based)
 
 [params.versions]
-current = "16.0"
-next = "17.0"
+current = "17.0"
+next = "18.0"
 
 # end Versions
 

diff --git a/content/en/docs/17.0/_index.md b/content/en/docs/17.0/_index.md
@@ -1,7 +1,7 @@
 ---
-title: v17.0 (Development)
+title: v17.0 (RC)
 description: >
-  Under construction, development release.
+  Release Candidate.
   Everything you need to know about scaling MySQL with Vitess.
 notoc: true
 cascade:

diff --git a/content/en/docs/17.0/get-started/local.md b/content/en/docs/17.0/get-started/local.md
@@ -58,15 +58,15 @@ sudo setenforce 0
 
 ## Install Vitess
 
-Download the [latest binary release](https://github.com/vitessio/vitess/releases) for Vitess on Linux. For example with Vitess 15:
+Download the [latest binary release](https://github.com/vitessio/vitess/releases) for Vitess on Linux. For example with Vitess 17:
 
 **Notes:**
 
 * 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=17.0.0-rc1
+file=vitess-${version}-d0caade.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/18.0/_index.md b/content/en/docs/18.0/_index.md
@@ -0,0 +1,11 @@
+---
+title: v18.0 (Development)
+description: >
+  Under construction, development release.
+  Everything you need to know about scaling MySQL with Vitess.
+notoc: true
+cascade:
+  version: v18.0
+weight: 82
+---
+
diff --git a/content/en/docs/18.0/concepts/_index.md b/content/en/docs/18.0/concepts/_index.md
@@ -0,0 +1,6 @@
+---
+title: Concepts
+description: Learn core Vitess concepts and terminology
+aliases: ['/docs/overview/concepts/']
+weight: 3
+---
diff --git a/content/en/docs/18.0/concepts/cell.md b/content/en/docs/18.0/concepts/cell.md
@@ -0,0 +1,10 @@
+---
+title: Cell
+description: Data center, availability zone or group of computing resources
+---
+
+A *cell* is a group of servers and network infrastructure collocated in an area, and isolated from failures in other cells. It is typically either a full data center or a subset of a data center, sometimes called a *zone* or *availability zone*. Vitess gracefully handles cell-level failures, such as when a cell is cut off the network.
+
+Each cell in a Vitess implementation has a [local topology service](../topology-service), which is hosted in that cell. The topology service contains most of the information about the Vitess tablets in its cell. This enables a cell to be taken down and rebuilt as a unit.
+
+Vitess limits cross-cell traffic for both data and metadata. While it may be useful to also have the ability to route read traffic to individual cells, Vitess currently serves reads only from the local cell. Writes will go cross-cell when necessary, to wherever the primary for that shard resides.
diff --git a/content/en/docs/18.0/concepts/execution-plans.md b/content/en/docs/18.0/concepts/execution-plans.md
@@ -0,0 +1,23 @@
+---
+title: Execution Plans
+---
+
+Vitess parses queries at both the VTGate and VTTablet layer in order to evaluate the best method to execute a query. This evaluation is known as query planning, and results in a _query execution plan_.
+
+The Execution Plan is dependent on both the query and the associated [VSchema](../vschema). One of the underlying goals of Vitess' planning strategy is to push down as much work as possible to the underlying MySQL instances. When this is not possible, Vitess will use a plan that collects input from multiple sources and merges the results to produce the correct query result.
+
+### Evaluation Model
+
+An execution plan consists of operators, each of which implements a specific piece of work. The operators combine into a tree-like structure, which represents the overall execution plan. The plan represents each operator as a node in the tree. Each operator takes as input zero or more rows, and produces as output zero or more rows. This means that the output from one operator becomes the input for the next operator. Operators that join two branches in the tree combine input from two incoming streams and produce a single output.
+
+Evaluation of the execution plan begins at the leaf nodes of the tree. Leaf nodes pull in data from VTTablet, the Topology Service, and in some cases are also able to evaluate expression values locally. Each leaf node will not have input from other operators, and pipe in any nodes they produce into their parent nodes. The parents nodes will then pipe in nodes to their parent nodes, all the way up to a root node. The root node produces the final results of the query and delivers the results to the user.
+
+### Observing Execution Plans
+
+Cached execution plans can be observed at the VTGate level by browsing the `/queryz` end point.
+
+Starting with Vitess 6, individual statement plans can also be observed with `EXPLAIN FORMAT=vitess <query>`.
+
+**Related Vitess Documentation**
+
+* [VTGate](../vtgate)
diff --git a/content/en/docs/18.0/concepts/img/VStream.svg b/content/en/docs/18.0/concepts/img/VStream.svg
diff --git a/content/en/docs/18.0/concepts/keyspace-id.md b/content/en/docs/18.0/concepts/keyspace-id.md
@@ -0,0 +1,10 @@
+---
+title: Keyspace ID
+---
+
+The *keyspace ID* is the value that is used to decide on which shard a given row lives. [Range-based Sharding](../../reference/features/sharding/#key-ranges-and-partitions) refers to creating shards that each cover a particular range of keyspace IDs.
+
+Using this technique means you can split a given shard by replacing it with two or more new shards that combine to cover the original range of keyspace IDs, without having to move any records in other shards.
+
+The keyspace ID itself is computed using a function of some column in your data, such as the user ID. Vitess allows you to choose from a variety of functions ([vindexes](../../reference/features/vindexes/)) to perform this mapping. This allows you to choose the right one to achieve optimal distribution of the data across shards.
+
diff --git a/content/en/docs/18.0/concepts/keyspace.md b/content/en/docs/18.0/concepts/keyspace.md
@@ -0,0 +1,8 @@
+---
+title: Keyspace
+---
+
+A *keyspace* is a logical database. If you're using [sharding](http://en.wikipedia.org/wiki/Shard_(database_architecture)), a keyspace maps to multiple MySQL databases; if you're not using sharding, a keyspace maps directly to a MySQL database name. In either case, a keyspace appears as a single database from the standpoint of the application.
+
+Reading data from a keyspace is just like reading from a MySQL database. However, depending on the consistency requirements of the read operation, Vitess might fetch the data from a primary database or from a replica. By routing each query to the appropriate database, Vitess allows your code to be structured as if it were reading from a single MySQL database.
+
diff --git a/content/en/docs/18.0/concepts/move-tables.md b/content/en/docs/18.0/concepts/move-tables.md
@@ -0,0 +1,26 @@
+---
+title: MoveTables
+---
+
+MoveTables is a new workflow based on VReplication. It enables you to relocate tables between keyspaces, and therefore physical MySQL instances, without downtime.
+
+## Identifying Candidate Tables
+
+It is recommended to keep tables that need to join on each other in the same keyspace, so typical candidates for a MoveTables operation are a set of tables which logically group together or are otherwise isolated.
+
+If you have multiple groups of tables as candidates, which makes the most sense to move may depend on the specifics of your environment. For example, a larger table will take more time to move, but in doing so you might be able to utilize additional or newer hardware which has more headroom before you need to perform additional operations such as sharding.
+
+Similarly, tables that are updated at a more frequent rate could increase the move time.
+
+### Impact to Production Traffic
+
+Internally, a MoveTables operation is comprised of both a table copy and a subscription to all changes made to the table. Vitess uses batching to improve the performance of both table copying and applying subscription changes, but you should expect that tables with lighter modification rates to move faster.
+
+During the active move process, data is copied from replicas instead of the primary server. This helps ensure minimal production traffic impact.
+
+During the `SwitchTraffic` phase of the MoveTables operation, for primary tablets, Vitess may be briefly unavailable. This unavailability is usually a few seconds, but will be higher in the event that your system has a high replication delay from primary to replica(s).
+
+
+**Related Vitess Documentation**
+
+* [MoveTables User Guide](../../user-guides/migration/move-tables)