Update docs for changes made in vitessio/vitess#14297 (#1623)

vitessio · Nov 7, 2023 · acb5e4e · acb5e4e
1 parent 768e33e
commit acb5e4e
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 26 deletions.
diff --git a/content/en/docs/19.0/reference/programs/vtcombo/_index.md b/content/en/docs/19.0/reference/programs/vtcombo/_index.md
@@ -414,15 +414,12 @@ vtcombo [flags]
       --vreplication_copy_phase_duration duration                        Duration for each copy phase loop (before running the next catchup: default 1h) (default 1h0m0s)
       --vreplication_copy_phase_max_innodb_history_list_length int       The maximum InnoDB transaction history that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 1000000)
       --vreplication_copy_phase_max_mysql_replication_lag int            The maximum MySQL replication lag (in seconds) that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 43200)
-      --vreplication_healthcheck_retry_delay duration                    healthcheck retry delay (default 5s)
-      --vreplication_healthcheck_timeout duration                        healthcheck retry delay (default 1m0s)
-      --vreplication_healthcheck_topology_refresh duration               refresh interval for re-reading the topology (default 30s)
       --vreplication_heartbeat_update_interval int                       Frequency (in seconds, default 1, max 60) at which the time_updated column of a vreplication stream when idling (default 1)
       --vreplication_max_time_to_retry_on_error duration                 stop automatically retrying when we've had consecutive failures with the same error for this long after the first occurrence
       --vreplication_replica_lag_tolerance duration                      Replica lag threshold duration: once lag is below this we switch from copy phase to the replication (streaming) phase (default 1m0s)
       --vreplication_retry_delay duration                                delay before retrying a failed workflow event in the replication phase (default 5s)
       --vreplication_store_compressed_gtid                               Store compressed gtids in the pos column of the sidecar database's vreplication table
-      --vreplication_tablet_type string                                  comma separated list of tablet types used as a source (default "in_order:REPLICA,PRIMARY")
+      --vreplication_tablet_type string                                  Deprecated: comma separated list of tablet types used as a source (ignored) (default "in_order:REPLICA,PRIMARY")
       --vschema-persistence-dir string                                   If set, per-keyspace vschema will be persisted in this directory and reloaded into the in-memory topology server across restarts. Bookkeeping is performed using a simple watcher goroutine. This is useful when running vtcombo as an application development container (e.g. vttestserver) where you want to keep the same vschema even if developer's machine reboots. This works in tandem with vttestserver's --persistent_mode flag. Needless to say, this is neither a perfect nor a production solution for vschema persistence. Consider using the --external_topo_server flag if you require a more complete solution. This flag is ignored if --external_topo_server is set.
       --vschema_ddl_authorized_users string                              List of users authorized to execute vschema ddl operations, or '%' to allow all users.
       --vstream-binlog-rotation-threshold int                            Byte size at which a VStreamer will attempt to rotate the source's open binary log before starting a GTID snapshot based stream (e.g. a ResultStreamer or RowStreamer) (default 67108864)

diff --git a/content/en/docs/19.0/reference/programs/vtctl/keyspaces.md b/content/en/docs/19.0/reference/programs/vtctl/keyspaces.md
@@ -209,7 +209,7 @@ Start a Resharding process. Example: Reshard --cells='zone1,alias1' --tablet_typ
 | source_time_zone            | String   | MoveTables only. Specifying this causes any DATETIME fields to be converted from given time zone into UTC                                                                                                                                                                                                                                                         |
 | stop_after_copy             | Boolean  | Streams will be stopped once the copy phase is completed                                                                                                                                                                                                                                                                                                          |
 | tables                      | String   | MoveTables only. A table spec or a list of tables. Either table_specs or --all needs to be specified.                                                                                                                                                                                                                                                             |
-| tablet_types                | String   | Source tablet types to replicate from (e.g. PRIMARY, REPLICA, RDONLY). Defaults to --vreplication_tablet_type parameter value for the tablet, which has the default value of in_order:REPLICA,PRIMARY. Note: SwitchTraffic overrides this default and uses in_order:RDONLY,REPLICA,PRIMARY to switch all traffic by default. (default "in_order:REPLICA,PRIMARY") |
+| tablet_types                | String   | Source tablet types to replicate from (e.g. PRIMARY, REPLICA, RDONLY). Note: SwitchTraffic overrides this default and uses in_order:RDONLY,REPLICA,PRIMARY to switch all traffic by default. (default "in_order:REPLICA,PRIMARY") |
 | target_shards               | String   | Reshard only. Target shards                                                                                                                                                                                                                                                                                                                                       |
 | timeout                     | Duration | Specifies the maximum time to wait, in seconds, for vreplication to catch up on primary migrations. The migration will be cancelled on a timeout. --timeout is only supported for SwitchTraffic and ReverseTraffic. (default 30s)                                                                                                                                 |
 
@@ -265,7 +265,7 @@ Example:
 | source_time_zone            | String   | MoveTables only. Specifying this causes any DATETIME fields to be converted from given time zone into UTC                                                                                                                                                                                                                                                         |
 | stop_after_copy             | Boolean  | Streams will be stopped once the copy phase is completed                                                                                                                                                                                                                                                                                                          |
 | tables                      | String   | MoveTables only. A table spec or a list of tables. Either table_specs or --all needs to be specified.                                                                                                                                                                                                                                                             |
-| tablet_types                | String   | Source tablet types to replicate from (e.g. PRIMARY, REPLICA, RDONLY). Defaults to --vreplication_tablet_type parameter value for the tablet, which has the default value of in_order:REPLICA,PRIMARY. Note: SwitchTraffic overrides this default and uses in_order:RDONLY,REPLICA,PRIMARY to switch all traffic by default. (default "in_order:REPLICA,PRIMARY") |
+| tablet_types                | String   | Source tablet types to replicate from (e.g. PRIMARY, REPLICA, RDONLY). Note: SwitchTraffic overrides this default and uses in_order:RDONLY,REPLICA,PRIMARY to switch all traffic by default. (default "in_order:REPLICA,PRIMARY") |
 | target_shards               | String   | Reshard only. Target shards                                                                                                                                                                                                                                                                                                                                       |
 | timeout                     | Duration | Specifies the maximum time to wait, in seconds, for vreplication to catch up on primary migrations. The migration will be cancelled on a timeout. --timeout is only supported for SwitchTraffic and ReverseTraffic. (default 30s)                                                                                                                                 |
 

diff --git a/content/en/docs/19.0/reference/programs/vttablet/_index.md b/content/en/docs/19.0/reference/programs/vttablet/_index.md
@@ -424,15 +424,12 @@ vttablet \
       --vreplication_copy_phase_max_innodb_history_list_length int       The maximum InnoDB transaction history that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 1000000)
       --vreplication_copy_phase_max_mysql_replication_lag int            The maximum MySQL replication lag (in seconds) that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 43200)
       --vreplication_experimental_flags int                              (Bitmask) of experimental features in vreplication to enable (default 3)
-      --vreplication_healthcheck_retry_delay duration                    healthcheck retry delay (default 5s)
-      --vreplication_healthcheck_timeout duration                        healthcheck retry delay (default 1m0s)
-      --vreplication_healthcheck_topology_refresh duration               refresh interval for re-reading the topology (default 30s)
       --vreplication_heartbeat_update_interval int                       Frequency (in seconds, default 1, max 60) at which the time_updated column of a vreplication stream when idling (default 1)
       --vreplication_max_time_to_retry_on_error duration                 stop automatically retrying when we've had consecutive failures with the same error for this long after the first occurrence
       --vreplication_replica_lag_tolerance duration                      Replica lag threshold duration: once lag is below this we switch from copy phase to the replication (streaming) phase (default 1m0s)
       --vreplication_retry_delay duration                                delay before retrying a failed workflow event in the replication phase (default 5s)
       --vreplication_store_compressed_gtid                               Store compressed gtids in the pos column of the sidecar database's vreplication table
-      --vreplication_tablet_type string                                  comma separated list of tablet types used as a source (default "in_order:REPLICA,PRIMARY")
+      --vreplication_tablet_type string                                  Deprecated: comma separated list of tablet types used as a source (ignored) (default "in_order:REPLICA,PRIMARY")
       --vstream-binlog-rotation-threshold int                            Byte size at which a VStreamer will attempt to rotate the source's open binary log before starting a GTID snapshot based stream (e.g. a ResultStreamer or RowStreamer) (default 67108864)
       --vstream_dynamic_packet_size                                      Enable dynamic packet sizing for VReplication. This will adjust the packet size during replication to improve performance. (default true)
       --vstream_packet_size int                                          Suggested packet size for VReplication streamer. This is used only as a recommendation. The actual packet size may be more or less than this amount. (default 250000)

diff --git a/content/en/docs/19.0/reference/vreplication/flags.md b/content/en/docs/19.0/reference/vreplication/flags.md
@@ -177,14 +177,6 @@ stalled streams after _vreplication_retry_delay_ seconds
 
 Stop automatically retrying when we've had consecutive failures with the same error for this long after the first occurrence (default 0, meaning no time limit).
 
-#### vreplication_tablet_type
-
-**Type** string\
-**Default** in_order:REPLICA,PRIMARY\
-**Applicable on** target
-
-This parameter specifies the default tablet_types that will be used by the tablet picker to find sources for a VReplication stream. It can be overridden, per workflow, by passing a different list to the workflow commands like `MoveTables` and `Reshard`.
-
 #### vreplication_experimental_flags
 
 **Type** bitmask\

diff --git a/content/en/docs/19.0/reference/vreplication/materialize.md b/content/en/docs/19.0/reference/vreplication/materialize.md
@@ -62,7 +62,7 @@ cells should be used to pick a tablet for selecting data from the source keyspac
 
 #### --tablet-types 
 **optional**\
-**default** `--vreplication_tablet_type` parameter value for the tablet. `--vreplication_tablet_type` has the default value of "in_order:REPLICA,PRIMARY".\
+**default** "in_order:REPLICA,PRIMARY"\
 **string**
 
 <div class="cmd">

diff --git a/content/en/docs/19.0/reference/vreplication/movetables.md b/content/en/docs/19.0/reference/vreplication/movetables.md
@@ -324,7 +324,7 @@ will stop once the copy is done and you can then mark the workflow as `Complete`
 
 #### --tablet-types 
 **optional**\
-**default** `--vreplication_tablet_type` parameter value for the tablet. `--vreplication_tablet_type` has the default value of "in_order:REPLICA,PRIMARY".\
+**default** "in_order:REPLICA,PRIMARY"\
 **string**
 
 <div class="cmd">

diff --git a/content/en/docs/19.0/reference/vreplication/reshard.md b/content/en/docs/19.0/reference/vreplication/reshard.md
@@ -275,7 +275,7 @@ Comma separated shard names to reshard from.
 
 #### --tablet-types 
 **optional**\
-**default** `--vreplication_tablet_type` parameter value for the tablet. `--vreplication_tablet_type` has the default value of "in_order:REPLICA,PRIMARY".\
+**default** "in_order:REPLICA,PRIMARY"\
 **string**
 
 <div class="cmd">

diff --git a/content/en/docs/19.0/reference/vreplication/tablet_selection.md b/content/en/docs/19.0/reference/vreplication/tablet_selection.md
@@ -31,9 +31,8 @@ When using the [VTGate VStream API](../vstream/), you can override this local ce
 ### Tablet Types
 
 #### VReplication
-For VReplication, the server side default which determines the candidate types made available for potential selection as the source for a stream is set
-using the [`vttablet` `--vreplication_tablet_type` flag](../flags/#vreplication_tablet_type) (default value is `in_order:REPLICA,PRIMARY`). The target tablet
-will provide this value to the `TabletPicker` to determine the viable source tablet candidates. You can override this default on the client side using your
+
+For VReplication the tablet types determines the candidate types made available for potential selection as the source for a stream (default value is `in_order:REPLICA,PRIMARY`). The target tablet will provide this value to the `TabletPicker` to determine the viable source tablet candidates. You specify the value on the client side using your
 workflow command's `--tablet-types` flag.
 
 You can also specify that the tablet types should be used in the order of preference as listed in the `--tablet-types` flag using the `--tablet-types-in-preference-order` flag. For example `--tablet-types "REPLICA,PRIMARY" --tablet-types-in-preference-order` would cause a replica source tablet to be used whenever possible
@@ -45,5 +44,6 @@ When using the [VTGate VStream API](../vstream/) you should instead migrate to u
 {{< /info >}}
 
 #### VStream
+
 For a VStream there is no default tablet type. You must specify an individual tablet type using the
 [`VStreamRequest.TabletType`](https://pkg.go.dev/vitess.io/vitess/go/vt/proto/vtgate#VStreamRequest) field.
diff --git a/content/zh/docs/19.0/reference/vreplication.md b/content/zh/docs/19.0/reference/vreplication.md
@@ -183,8 +183,6 @@ The parameters are as follows:
 * `max_tps`: 99999, reserved.
 * `max_replication_lag`: 99999, reserved.
 * `tablet_types`: specifies a comma separated list of tablet types to replicate from.
-  If empty, the default tablet type specified by the `-vreplication_tablet_type`
-  command line flag is used.
 * `time_updated`: 0, reserved.
 * `transaction_timestamp`: 0, reserved.
 * `state`: 'Running' or 'Stopped'.