diff --git a/en/manage-replication-tasks.md b/en/manage-replication-tasks.md index 381dd8fbf..5795939b6 100644 --- a/en/manage-replication-tasks.md +++ b/en/manage-replication-tasks.md @@ -14,6 +14,10 @@ The dmctl component supports the interactive mode for manual operations, and als This section describes the basic use of dmctl commands in the interactive mode. +> **Note:** +> +> The interactive mode does not support Bash features. For example, you need to directly pass string flags instead of passing them in quotes. + ### dmctl help ```bash @@ -215,7 +219,7 @@ help pause-task pause a specified running task Usage: - dmctl pause-task [-w worker ...] [flags] + dmctl pause-task [-w worker ...] [flags] Flags: -h, --help help for pause-task @@ -241,7 +245,7 @@ pause-task [-w "127.0.0.1:8262"] task-name #### Flags description - `-w`: (Optional) Specifies the group of DM-workers where the subtasks of the replication task (that you want to pause) run. If it is set, only subtasks on the specified DM-workers are paused. -- `task-name`: (Required) Specifies the task name. +- `task-name | task-file`: (Required) Specifies the task name or task file path. #### Returned results @@ -289,7 +293,7 @@ help resume-task resume a specified paused task Usage: - dmctl resume-task [-w worker ...] [flags] + dmctl resume-task [-w worker ...] [flags] Flags: -h, --help help for resume-task @@ -307,7 +311,7 @@ resume-task [-w "127.0.0.1:8262"] task-name #### Flags description - `-w`: (Optional) Specifies the group of DM-workers where the subtasks of the replication task (that you want to restart) run. If it is set, only subtasks on the specified DM-workers are restarted. -- `task-name`: (Required) Specifies the task name. +- `task-name | task-file`: (Required) Specifies the task name or task file path. #### Returned results @@ -355,7 +359,7 @@ help stop-task stop a specified task Usage: - dmctl stop-task [-w worker ...] [flags] + dmctl stop-task [-w worker ...] [flags] Flags: -h, --help help for stop-task @@ -373,7 +377,7 @@ stop-task [-w "127.0.0.1:8262"] task-name #### Flags description - `-w`: (Optional) Specifies the group of DM-workers where the subtasks of the replication task (that you want to stop) run. If it is set, only subtasks on the specified DM-workers are stopped. -- `task-name`: (Required) Specifies the task name. +- `task-name | task-file`: (Required) Specifies the task name or task file path. #### Returned results @@ -425,23 +429,23 @@ You can use the `update-task` command to update the data replication task. The f 1. Check the status of the corresponding data replication task using `query-status `. - If `stage` is not `Paused`, use `pause-task ` to pause the task. + If `stage` is not `Paused`, use `pause-task ` to pause the task. 2. Edit the `task.yaml` file to update the custom configuration that you need to modify and the incorrect configuration. 3. Update the task configuration using `update-task task.yaml`. -4. Resume the task using `resume-task `. +4. Resume the task using ``. #### Update items that do not support online update 1. Check the status of the corresponding data replication task using `query-status `. - If the task exists, use `stop-task ` to stop the task. + If the task exists, use `stop-task ` to stop the task. 2. Edit the `task.yaml` file to update the custom configuration that you need to modify and the incorrect configuration. -3. Restart the task using `start-task `. +3. Restart the task using `start-task `. #### Command usage help diff --git a/en/task-configuration-file.md b/en/task-configuration-file.md index d6273b0a4..ee5d21ba1 100644 --- a/en/task-configuration-file.md +++ b/en/task-configuration-file.md @@ -99,7 +99,7 @@ To illustrate how to modify the task configuration, the following is an example {{< copyable "" >}} ```bash - stop-task + stop-task ``` 3. Start the task by executing the `start-task` command: