VTAdmin: Add advanced workflow switchtraffic options
#17658
+175
−32
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,8 +12,12 @@ | |
| } from '../../../hooks/api'; | ||
| import Toggle from '../../toggle/Toggle'; | ||
| import { success } from '../../Snackbar'; | ||
| import { vtadmin, vtctldata, vttime } from '../../../proto/vtadmin'; | ||
|
Check warning on line 15 in web/vtadmin/src/components/routes/workflows/WorkflowActions.tsx
|
||
| import { getReverseWorkflow } from '../../../util/workflows'; | ||
| import { Label } from '../../inputs/Label'; | ||
| import { TextInput } from '../../TextInput'; | ||
| import { MultiSelect } from '../../inputs/MultiSelect'; | ||
| import { TABLET_TYPES } from '../../../util/tablets'; | ||
|
|
||
| interface WorkflowActionsProps { | ||
| streamsByState: { | ||
|
|
@@ -44,11 +48,31 @@ | |
| keepRoutingRoules: boolean; | ||
| } | ||
|
|
||
| interface SwitchTrafficOptions { | ||
| enableReverseReplication: boolean; | ||
| force: boolean; | ||
| initializeTargetSequences: boolean; | ||
|
There was a problem hiding this comment. This is not a boolean anymore after: #16860 |
||
| maxReplicationLagAllowed: number; | ||
| timeout: number; | ||
| tabletTypes: number[]; | ||
| } | ||
|
|
||
| const DefaultSwitchTrafficOptions: SwitchTrafficOptions = { | ||
| enableReverseReplication: true, | ||
| force: false, | ||
| initializeTargetSequences: false, | ||
| maxReplicationLagAllowed: 30, | ||
| timeout: 30, | ||
| tabletTypes: [1, 2, 3], | ||
|
There was a problem hiding this comment. It would be great if we can use There was a problem hiding this comment. +1 to that! Sorry, I meant to come back and comment on this but then forgot. We should use the existing consts: |
||
| }; | ||
|
|
||
| const DefaultCancelWorkflowOptions: CancelWorkflowOptions = { | ||
| keepData: false, | ||
| keepRoutingRoules: false, | ||
| }; | ||
|
|
||
| const TABLET_OPTIONS = [1, 2, 3]; | ||
|
There was a problem hiding this comment. Same comment about using |
||
|
|
||
| const WorkflowActions: React.FC<WorkflowActionsProps> = ({ | ||
| streamsByState, | ||
| workflows, | ||
|
|
@@ -60,13 +84,15 @@ | |
| }) => { | ||
| const [currentDialog, setCurrentDialog] = useState<string>(''); | ||
|
|
||
| const [completeMoveTablesOptions, setCompleteMoveTablesOptions] = useState<CompleteMoveTablesOptions>( | ||
| DefaultCompleteMoveTablesOptions | ||
| ); | ||
|
|
||
| const [cancelWorkflowOptions, setCancelWorkflowOptions] = | ||
| useState<CancelWorkflowOptions>(DefaultCancelWorkflowOptions); | ||
|
|
||
| const [switchTrafficOptions, setSwitchTrafficOptions] = useState<SwitchTrafficOptions>(DefaultSwitchTrafficOptions); | ||
|
|
||
| const closeDialog = () => setCurrentDialog(''); | ||
|
|
||
| const startWorkflowMutation = useStartWorkflow({ keyspace, clusterID, name }); | ||
|
|
@@ -79,6 +105,16 @@ | |
| keyspace: keyspace, | ||
| workflow: name, | ||
| direction: 0, | ||
| enable_reverse_replication: switchTrafficOptions.enableReverseReplication, | ||
| force: switchTrafficOptions.force, | ||
| max_replication_lag_allowed: { | ||
| seconds: switchTrafficOptions.maxReplicationLagAllowed, | ||
| }, | ||
| timeout: { | ||
| seconds: switchTrafficOptions.timeout, | ||
| }, | ||
| initialize_target_sequences: switchTrafficOptions.initializeTargetSequences, | ||
| tablet_types: switchTrafficOptions.tabletTypes, | ||
| }, | ||
| }); | ||
|
|
||
|
|
@@ -88,6 +124,16 @@ | |
| keyspace: keyspace, | ||
| workflow: name, | ||
| direction: 1, | ||
| enable_reverse_replication: switchTrafficOptions.enableReverseReplication, | ||
| force: switchTrafficOptions.force, | ||
| max_replication_lag_allowed: { | ||
| seconds: switchTrafficOptions.maxReplicationLagAllowed, | ||
| }, | ||
| timeout: { | ||
| seconds: switchTrafficOptions.timeout, | ||
| }, | ||
| initialize_target_sequences: switchTrafficOptions.initializeTargetSequences, | ||
| tablet_types: switchTrafficOptions.tabletTypes, | ||
| }, | ||
| }); | ||
|
|
||
|
|
@@ -126,7 +172,7 @@ | |
| } | ||
| ); | ||
|
|
||
| const supportsComplete = workflowType.toLowerCase() === 'movetables' || workflowType.toLowerCase() === 'reshard'; | ||
|
|
||
| const isRunning = | ||
| !(streamsByState['Error'] && streamsByState['Error'].length) && | ||
|
|
@@ -148,12 +194,123 @@ | |
|
|
||
| const isReverseWorkflow = name.endsWith('_reverse'); | ||
|
|
||
| const switchTrafficDialogBody = (initializeTargetSequences: boolean = true) => { | ||
| return ( | ||
| <div className="flex flex-col gap-2"> | ||
| <Label | ||
| className="block w-full" | ||
| label="Timeout" | ||
| helpText={ | ||
| 'Specifies the maximum time to wait, in seconds, for VReplication to catch up on primary tablets. The traffic switch will be cancelled on timeout.' | ||
| } | ||
| > | ||
| <TextInput | ||
| onChange={(e) => | ||
| setSwitchTrafficOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| timeout: Number(e.target.value), | ||
| })) | ||
| } | ||
| value={switchTrafficOptions.timeout || ''} | ||
| type="number" | ||
| /> | ||
| </Label> | ||
| <Label | ||
| className="block w-full" | ||
| label="Max Replication Lag Allowed" | ||
| helpText={'Allow traffic to be switched only if VReplication lag is below this.'} | ||
| > | ||
| <TextInput | ||
| onChange={(e) => | ||
| setSwitchTrafficOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| maxReplicationLagAllowed: Number(e.target.value), | ||
| })) | ||
| } | ||
| value={switchTrafficOptions.maxReplicationLagAllowed || ''} | ||
| type="number" | ||
| /> | ||
| </Label> | ||
| <MultiSelect | ||
| className="block w-full" | ||
| inputClassName="block w-full" | ||
| items={TABLET_OPTIONS} | ||
| itemToString={(tt) => TABLET_TYPES[tt]} | ||
| selectedItems={switchTrafficOptions.tabletTypes} | ||
| label="Tablet Types" | ||
| helpText={'Tablet types to switch traffic for.'} | ||
| onChange={(types) => { | ||
| setSwitchTrafficOptions({ ...switchTrafficOptions, tabletTypes: types }); | ||
| }} | ||
| placeholder="Select tablet types" | ||
| /> | ||
| <div className="flex justify-between items-center w-full"> | ||
| <Label | ||
| label="Enable Reverse Replication" | ||
| helpText={ | ||
| 'Setup replication going back to the original source keyspace to support rolling back the traffic cutover.' | ||
| } | ||
| /> | ||
| <Toggle | ||
| className="mr-2" | ||
| enabled={switchTrafficOptions.enableReverseReplication} | ||
| onChange={() => | ||
| setSwitchTrafficOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| enableReverseReplication: !prevOptions.enableReverseReplication, | ||
| })) | ||
| } | ||
| /> | ||
| </div> | ||
| {initializeTargetSequences && ( | ||
| <div className="flex justify-between items-center w-full"> | ||
| <Label | ||
| label="Initialize Target Sequences" | ||
| helpText={ | ||
| 'When moving tables from an unsharded keyspace to a sharded keyspace, initialize any sequences that are being used on the target when switching writes. If the sequence table is not found, and the sequence table reference was fully qualified, then we will attempt to create the sequence table in that keyspace.' | ||
| } | ||
| /> | ||
| <Toggle | ||
| className="mr-2" | ||
| enabled={switchTrafficOptions.initializeTargetSequences} | ||
| onChange={() => | ||
| setSwitchTrafficOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| initializeTargetSequences: !prevOptions.initializeTargetSequences, | ||
| })) | ||
| } | ||
| /> | ||
| </div> | ||
| )} | ||
| <div className="flex justify-between items-center w-full"> | ||
| <Label | ||
| label="Force" | ||
| helpText={` | ||
| Force the traffic switch even if some potentially non-critical actions cannot be | ||
| performed; for example the tablet refresh fails on some tablets in the keyspace. | ||
| WARNING: this should be used with extreme caution and only in emergency situations!`} | ||
| /> | ||
| <Toggle | ||
| className="mr-2" | ||
| enabled={switchTrafficOptions.force} | ||
| onChange={() => | ||
| setSwitchTrafficOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| force: !prevOptions.force, | ||
| })) | ||
| } | ||
| /> | ||
| </div> | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
| return ( | ||
| <div className="w-min inline-block"> | ||
| <Dropdown dropdownButton={Icons.info}> | ||
| {!isReverseWorkflow && ( | ||
| <> | ||
| {supportsComplete && isSwitched && ( | ||
| <MenuItem onClick={() => setCurrentDialog('Complete MoveTables')}>Complete</MenuItem> | ||
| )} | ||
| {isRunning && ( | ||
|
|
@@ -219,10 +376,12 @@ | |
| } | ||
| /> | ||
| <WorkflowAction | ||
| className="sm:max-w-xl" | ||
| title="Switch Traffic" | ||
| confirmText="Switch" | ||
| loadingText="Switching" | ||
| mutation={switchTrafficMutation} | ||
| description={`Switch traffic for the ${name} workflow.`} | ||
| successText="Switched Traffic" | ||
| errorText={`Error occured while switching traffic for workflow ${name}`} | ||
| errorDescription={switchTrafficMutation.error ? switchTrafficMutation.error.message : ''} | ||
|
|
@@ -236,17 +395,15 @@ | |
| )} | ||
| </div> | ||
| } | ||
| body={switchTrafficDialogBody(workflowType.toLowerCase() !== 'reshard')} | ||
| /> | ||
| <WorkflowAction | ||
| className="sm:max-w-xl" | ||
| title="Reverse Traffic" | ||
| confirmText="Reverse" | ||
| loadingText="Reversing" | ||
| mutation={reverseTrafficMutation} | ||
| description={`Reverse traffic for the ${name} workflow.`} | ||
| successText="Reversed Traffic" | ||
| errorText={`Error occured while reversing traffic for workflow ${name}`} | ||
| errorDescription={reverseTrafficMutation.error ? reverseTrafficMutation.error.message : ''} | ||
|
|
@@ -260,11 +417,7 @@ | |
| )} | ||
| </div> | ||
| } | ||
| body={switchTrafficDialogBody(false)} | ||
| /> | ||
| <WorkflowAction | ||
| className="sm:max-w-xl" | ||
|
|
@@ -299,7 +452,7 @@ | |
| <Toggle | ||
| enabled={cancelWorkflowOptions.keepData} | ||
| onChange={() => | ||
| setCancelWorkflowOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| keepData: !prevOptions.keepData, | ||
| })) | ||
|
|
@@ -316,7 +469,7 @@ | |
| <Toggle | ||
| enabled={cancelWorkflowOptions.keepRoutingRoules} | ||
| onChange={() => | ||
| setCancelWorkflowOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| keepRoutingRoules: !prevOptions.keepRoutingRoules, | ||
| })) | ||
|
|
@@ -328,7 +481,7 @@ | |
| /> | ||
| <WorkflowAction | ||
| className="sm:max-w-xl" | ||
| title="Complete Workflow" | ||
|
There was a problem hiding this comment. Good catch. We missed this when adding Reshard support. 🙂 |
||
| description={`Complete the ${name} workflow.`} | ||
| confirmText="Complete" | ||
| loadingText="Completing" | ||
|
|
@@ -351,7 +504,7 @@ | |
| <Toggle | ||
| enabled={completeMoveTablesOptions.keepData} | ||
| onChange={() => | ||
| setCompleteMoveTablesOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| keepData: !prevOptions.keepData, | ||
| })) | ||
|
|
@@ -369,7 +522,7 @@ | |
| <Toggle | ||
| enabled={completeMoveTablesOptions.keepRoutingRoules} | ||
| onChange={() => | ||
| setCompleteMoveTablesOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| keepRoutingRoules: !prevOptions.keepRoutingRoules, | ||
| })) | ||
|
|
@@ -388,7 +541,7 @@ | |
| <Toggle | ||
| enabled={completeMoveTablesOptions.renameTables} | ||
| onChange={() => | ||
| setCompleteMoveTablesOptions((prevOptions) => ({ | ||
| ...prevOptions, | ||
| renameTables: !prevOptions.renameTables, | ||
| })) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these linter warnings not valid?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They are and we should address them! 😄