From 790f48e8847d8155a91bd96eab9da8de74d2e2fc Mon Sep 17 00:00:00 2001 From: Matt Lord Date: Tue, 7 Mar 2023 17:38:29 -0500 Subject: [PATCH] Document Experimental Custom Sidecar Support This documents the work done in: https://github.com/vitessio/vitess/pull/12240 Signed-off-by: Matt Lord --- content/en/docs/17.0/get-started/local-brew.md | 5 ++++- content/en/docs/17.0/get-started/local-mac.md | 7 +++++-- content/en/docs/17.0/get-started/local.md | 7 +++++-- content/en/docs/17.0/reference/programs/vtctl/_index.md | 2 +- content/en/docs/17.0/reference/programs/vtctl/keyspaces.md | 3 ++- .../programs/vtctldclient/vtctldclient_CreateKeyspace.md | 1 + 6 files changed, 18 insertions(+), 7 deletions(-) diff --git a/content/en/docs/17.0/get-started/local-brew.md b/content/en/docs/17.0/get-started/local-brew.md index 8df5fee60a..ffe61db60b 100644 --- a/content/en/docs/17.0/get-started/local-brew.md +++ b/content/en/docs/17.0/get-started/local-brew.md @@ -57,6 +57,7 @@ add zone1 CellInfo Created cell: zone1 etcd start done... Starting vtctld... +vtctld is running! Starting MySQL for tablet zone1-0000000100... Starting vttablet for zone1-0000000100... HTTP/1.1 200 OK @@ -81,7 +82,9 @@ Content-Type: text/html; charset=utf-8 "keyspace_type": 0, "base_keyspace": "", "snapshot_time": null, - "durability_policy": "semi_sync" + "durability_policy": "semi_sync", + "throttler_config": null, + "sidecar_db_name": "_vt" } } vtorc is running! diff --git a/content/en/docs/17.0/get-started/local-mac.md b/content/en/docs/17.0/get-started/local-mac.md index 187c1218b9..ce6c6871c5 100644 --- a/content/en/docs/17.0/get-started/local-mac.md +++ b/content/en/docs/17.0/get-started/local-mac.md @@ -116,7 +116,7 @@ $ source env.sh You should see an output similar to the following: -```text +```bash ~/my-vitess-example> ./101_initial_cluster.sh $ ./101_initial_cluster.sh add /vitess/global @@ -125,6 +125,7 @@ add zone1 CellInfo Created cell: zone1 etcd start done... Starting vtctld... +vtctld is running! Starting MySQL for tablet zone1-0000000100... Starting vttablet for zone1-0000000100... HTTP/1.1 200 OK @@ -149,7 +150,9 @@ Content-Type: text/html; charset=utf-8 "keyspace_type": 0, "base_keyspace": "", "snapshot_time": null, - "durability_policy": "semi_sync" + "durability_policy": "semi_sync", + "throttler_config": null, + "sidecar_db_name": "_vt" } } vtorc is running! diff --git a/content/en/docs/17.0/get-started/local.md b/content/en/docs/17.0/get-started/local.md index 2002b7d260..ae1920626b 100644 --- a/content/en/docs/17.0/get-started/local.md +++ b/content/en/docs/17.0/get-started/local.md @@ -98,7 +98,7 @@ cd ~/my-vitess-example/examples/local You should see an output similar to the following: -```text +```bash ~/my-vitess-example> ./101_initial_cluster.sh $ ./101_initial_cluster.sh add /vitess/global @@ -107,6 +107,7 @@ add zone1 CellInfo Created cell: zone1 etcd start done... Starting vtctld... +vtctld is running! Starting MySQL for tablet zone1-0000000100... Starting vttablet for zone1-0000000100... HTTP/1.1 200 OK @@ -131,7 +132,9 @@ Content-Type: text/html; charset=utf-8 "keyspace_type": 0, "base_keyspace": "", "snapshot_time": null, - "durability_policy": "semi_sync" + "durability_policy": "semi_sync", + "throttler_config": null, + "sidecar_db_name": "_vt" } } vtorc is running! diff --git a/content/en/docs/17.0/reference/programs/vtctl/_index.md b/content/en/docs/17.0/reference/programs/vtctl/_index.md index c637bf3a34..8d569de655 100644 --- a/content/en/docs/17.0/reference/programs/vtctl/_index.md +++ b/content/en/docs/17.0/reference/programs/vtctl/_index.md @@ -67,7 +67,7 @@ Note that wherever `vtctl` commands produced master or MASTER for tablet type, t | Name | Example Usage | | :-------- | :--------------- | -| [CreateKeyspace](../vtctl/keyspaces#createkeyspace) | `CreateKeyspace -- [--sharding_column_name=name] [--sharding_column_type=type] [--served_from=tablettype1:ks1,tablettype2:ks2,...] [--force] [--keyspace_type=type] [--base_keyspace=base_keyspace] [--snapshot_time=time] [--durability-policy=policy_name] ` | +| [CreateKeyspace](../vtctl/keyspaces#createkeyspace) | `CreateKeyspace -- [--sharding_column_name=name] [--sharding_column_type=type] [--served_from=tablettype1:ks1,tablettype2:ks2,...] [--force] [--keyspace_type=type] [--base_keyspace=base_keyspace] [--snapshot_time=time] [--durability-policy=policy_name] [--sidecar-db-name=db_name] ` | | [DeleteKeyspace](../vtctl/keyspaces#deletekeyspace) | `DeleteKeyspace -- [--recursive] ` | | [RemoveKeyspaceCell](../vtctl/keyspaces#removekeyspacecell) | `RemoveKeyspaceCell -- [--force] [--recursive] ` | | [GetKeyspace](../vtctl/keyspaces#getkeyspace) | `GetKeyspace ` | diff --git a/content/en/docs/17.0/reference/programs/vtctl/keyspaces.md b/content/en/docs/17.0/reference/programs/vtctl/keyspaces.md index 101573f565..713960666a 100644 --- a/content/en/docs/17.0/reference/programs/vtctl/keyspaces.md +++ b/content/en/docs/17.0/reference/programs/vtctl/keyspaces.md @@ -14,7 +14,7 @@ Creates the specified keyspace. #### Example -
CreateKeyspace -- [--sharding_column_name=name] [--sharding_column_type=type] [--served_from=tablettype1:ks1,tablettype2:ks2,...] [--force] [--keyspace_type=type] [--base_keyspace=base_keyspace] [--snapshot_time=time] [--durability-policy=policy_name] <keyspace name>
+
CreateKeyspace -- [--sharding_column_name=name] [--sharding_column_type=type] [--served_from=tablettype1:ks1,tablettype2:ks2,...] [--force] [--keyspace_type=type] [--base_keyspace=base_keyspace] [--snapshot_time=time] [--durability-policy=policy_name] [--sidecar-db-name=db_name] <keyspace name>
#### Flags @@ -27,6 +27,7 @@ Creates the specified keyspace. | keyspace_type | String | Specifies the type of the keyspace. It can be NORMAL or SNAPSHOT. For a SNAPSHOT keyspace you must specify the name of a base_keyspace, and a snapshot_time in UTC, in RFC3339 time format, e.g. 2006-01-02T15:04:05+00:00 | | sharding_column_name | String | Specifies the column to use for sharding operations | | sharding_column_type | String | Specifies the type of the column to use for sharding operations | +| sidecar-db-name | String | (Experimental) Specifies the name of the Vitess sidecar database that tablets in this keyspace will use for internal metadata | | served_from | String | Specifies a comma-separated list of dbtype:keyspace pairs used to serve traffic | | snapshot_time | String | Specifies the snapshot time for this keyspace | diff --git a/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md b/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md index 11d5807d7d..bd5fbb9104 100644 --- a/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md +++ b/content/en/docs/17.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md @@ -26,6 +26,7 @@ vtctldclient CreateKeyspace [--force|-f] [--type KEYSPACE_TYPE] [--ba -f, --force Proceeds even if the keyspace already exists. Does not overwrite the existing keyspace record. -h, --help help for CreateKeyspace --served-from cli.StringMapValue Specifies a set of db_type:keyspace pairs used to serve traffic for the keyspace. + --sidecar-db-name string (Experimental) Name of the Vitess sidecar database that tablets in this keyspace will use for internal metadata. (default "_vt") --snapshot-timestamp string The snapshot time for a snapshot keyspace, as a timestamp in RFC3339 format. --type cli.KeyspaceTypeFlag The type of the keyspace. (default NORMAL) ```