Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

replace blacklist with denied / block #914

Merged
merged 1 commit into from
Dec 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/design-docs/vreplication/cutover.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ rules:{from_table:"customer@replica" to_tables:"customer.customer"}

#### On switching primary traffic

The routing rules for the primary are updated to map the table on source to the target. In addition the tables are added to the “blacklist” on the source keyspace which vttablet uses to reject writes for tables that have moved. The blacklist/routing rules are temporary and can be removed since the moved tables will only appear in the target VSchema
The routing rules for the primary are updated to map the table on source to the target. In addition the tables are added to the “denylist” on the source keyspace which vttablet uses to reject writes for tables that have moved. The denylist/routing rules are temporary and can be removed since the moved tables will only appear in the target VSchema

_global/routingrules_

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/overview/whatisvitess.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Vitess served all YouTube database traffic for over five years. Many enterprises

* Protection
- Query rewriting and sanitization – Add limits and avoid non-deterministic updates.
- Query blacklisting – Customize rules to prevent potentially problematic queries from hitting your database.
- Query blocking – Customize rules to prevent potentially problematic queries from hitting your database.
- Query killer – Terminate queries that take too long to return data.
- Table ACLs – Specify access control lists (ACLs) for tables based on the connected user.

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/reference/features/topology-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Global topology service contains:
* if using filtered replication, the source shards this shard is replicating
from.
* the list of cells that have tablets in this shard.
* shard-global tablet controls, like blacklisted tables no tablet should serve
* shard-global tablet controls, like denied tables no tablet should serve
in this shard.

A Shard can be locked. We use this during operations that affect either the
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/reference/programs/vtctl/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Note that wherever `vtctl` commands produced master or MASTER for tablet type, t
| [ShardReplicationPositions](../vtctl/shards#shardreplicationpositions) | `ShardReplicationPositions <keyspace/shard>` |
| [ListShardTablets](../vtctl/shards#listshardtablets) | `ListShardTablets <keyspace/shard>` |
| [SetShardIsPrimaryServing](../vtctl/shards#setshardisprimaryserving) | `SetShardIsPrimaryServing <keyspace/shard> <is_serving>` |
| [SetShardTabletControl](../vtctl/shards#setshardtabletcontrol) | `SetShardTabletControl [--cells=c1,c2,...] [--blacklisted_tables=t1,t2,...] [--remove] [--disable_query_service] <keyspace/shard> <tablet type>` |
| [SetShardTabletControl](../vtctl/shards#setshardtabletcontrol) | `SetShardTabletControl [--cells=c1,c2,...] [--denied_tables=t1,t2,...] [--remove] [--disable_query_service] <keyspace/shard> <tablet type>` |
| [UpdateSrvKeyspacePartition](../vtctl/shards#updatesrvkeyspacepartition)| `UpdateSrvKeyspacePartition [--cells=c1,c2,...] [--remove] <keyspace/shard> <tablet type>` |
| [SourceShardDelete](../vtctl/shards#sourcesharddelete) | `SourceShardDelete <keyspace/shard> <uid>` |
| [SourceShardAdd](../vtctl/shards#sourceshardadd) | `SourceShardAdd [--key_range=<keyrange>] [--tables=<table1,table2,...>] <keyspace/shard> <uid> <source keyspace/shard>` |
Expand Down
16 changes: 8 additions & 8 deletions content/en/docs/reference/programs/vtctl/shards.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,20 +113,20 @@ SetShardIsPrimaryServing <keyspace/shard> <is_serving>

### SetShardTabletControl

Sets the TabletControl record for a shard and type. Only use this for an emergency fix or after a finished vertical split. The *MigrateServedFrom* and *MigrateServedType* commands set this field appropriately already. Always specify the blacklisted_tables flag for MoveTables, but never for Reshard operations.<br><br>To set the DisableQueryServiceFlag, keep 'blacklisted_tables' empty, and set 'disable_query_service' to true or false. Useful to fix Reshard operations gone wrong.<br><br>To change the blacklisted tables list, specify the 'blacklisted_tables' parameter with the new list. Useful to fix tables that are being blocked after a vertical split.<br><br>To just remove the ShardTabletControl entirely, use the 'remove' flag, useful after a vertical split is finished to remove serving restrictions.
Sets the TabletControl record for a shard and type. Only use this for an emergency fix or after a finished vertical split. The *MigrateServedFrom* and *MigrateServedType* commands set this field appropriately already. Always specify the denied_tables flag for MoveTables, but never for Reshard operations.<br><br>To set the DisableQueryServiceFlag, keep 'denied_tables' empty, and set 'disable_query_service' to true or false. Useful to fix Reshard operations gone wrong.<br><br>To change the denied tables list, specify the 'denied_tables' parameter with the new list. Useful to fix tables that are being blocked after a vertical split.<br><br>To just remove the ShardTabletControl entirely, use the 'remove' flag, useful after a vertical split is finished to remove serving restrictions.

#### Example

<pre class="command-example">SetShardTabletControl [--cells=c1,c2,...] [--blacklisted_tables=t1,t2,...] [--remove] [--disable_query_service] &lt;keyspace/shard&gt; &lt;tablet type&gt;</pre>
<pre class="command-example">SetShardTabletControl [--cells=c1,c2,...] [--denied_tables=t1,t2,...] [--remove] [--disable_query_service] &lt;keyspace/shard&gt; &lt;tablet type&gt;</pre>

#### Flags

| Name | Type | Definition |
| :-------- | :--------- | :--------- |
| blacklisted_tables | string | Specifies a comma-separated list of tables to blacklist (used for vertical split). Each is either an exact match, or a regular expression of the form '/regexp/'. |
| cells | string | Specifies a comma-separated list of cells to update |
| disable_query_service | Boolean | Disables query service on the provided nodes. This flag requires 'blacklisted_tables' and 'remove' to be unset, otherwise it's ignored. |
| remove | Boolean | Removes cells for MoveTables. |
| Name | Type | Definition |
| :-------- | :--------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| denied_tables | string | Specifies a comma-separated list of tables to deny queries on (used for vertical split). Each is either an exact match, or a regular expression of the form '/regexp/'. |
| cells | string | Specifies a comma-separated list of cells to update |
| disable_query_service | Boolean | Disables query service on the provided nodes. This flag requires 'denied_tables' and 'remove' to be unset, otherwise it's ignored. |
| remove | Boolean | Removes cells for MoveTables. |


#### Arguments
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/reference/vreplication/cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ MoveTables/Reshard [-keep_data] Cancel <targetKs.workflow>

### Description

`Cancel` can be used if a workflow was created in error or was misconfigured and you prefer to create a new workflow instead of fixing this one. Cancel can only be called if no traffic has been switched. It removes vreplication-related artifacts like rows from vreplication and copy_state tables in the side-car `_vt` database and routing rules and blacklisted tables from the topo and, by default, the target tables/shards from the target keyspace.
`Cancel` can be used if a workflow was created in error or was misconfigured and you prefer to create a new workflow instead of fixing this one. Cancel can only be called if no traffic has been switched. It removes vreplication-related artifacts like rows from vreplication and copy_state tables in the side-car `_vt` database and routing rules and denied tables from the topo and, by default, the target tables/shards from the target keyspace.

### Parameters

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/reference/vreplication/complete.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ MoveTables/Reshard [-keep_data] [-rename_tables] [-dry_run]
### Description
**Alert: This is a destructive command**

`Complete` is used after all traffic has been switched. It removes vreplication-related artifacts like rows from vreplication and copy_state tables in the side-car `_vt` database and routing rules and and blacklisted tables (for MoveTables) from the topo. By default, the source tables (or source shards) are also dropped.
`Complete` is used after all traffic has been switched. It removes vreplication-related artifacts like rows from vreplication and copy_state tables in the side-car `_vt` database and routing rules and denied tables (for MoveTables) from the topo. By default, the source tables (or source shards) are also dropped.

### Parameters

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/troubleshoot/elevated-query-latency.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 1

Diagnosis 1: Inspect the graphs to see if QPS has gone up. If yes, drill down on the more detailed QPS graphs to see which table, or user caused the increase. If a table is identified, look at /debug/queryz for queries on that table.

Action: Inform engineer about the toxic queries. If it’s a specific user, you can stop their job or throttle them to keep the load manageable. As a last resort, blacklist query to allow the rest of the system to stay healthy.
Action: Inform engineer about the toxic queries. If it’s a specific user, you can stop their job or throttle them to keep the load manageable. As a last resort, block query to allow the rest of the system to stay healthy.

Diagnosis 2: QPS did not go up, only latency did. Inspect the per-table latency graphs. If it’s a specific table, then it’s most likely a long-running low QPS query that’s skewing the numbers. Identify the culprit query and take necessary steps to get it optimized. Such queries usually do not cause outage. So, there may not be a need to take extreme measures.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ This URL has an MRU list of consolidations. This is a way of identifying if mult

#### /debug/query\_rules

This URL displays the currently active query blacklist rules.
This URL displays the currently active query block rules.

### Alerting

Expand Down