Skip to content
This repository has been archived by the owner on Jan 3, 2025. It is now read-only.

Commit

Permalink
support using task-file when need task-name (#257) (#258)
Browse files Browse the repository at this point in the history
* cherry pick #257 to release-1.0

Signed-off-by: ti-srebot <[email protected]>

* Delete dmctl-introduction.md

* Delete pause-task.md

* Delete resume-task.md

* Delete stop-task.md

* Update manage-replication-tasks.md

* Update quotation marks to "quotes"

Co-authored-by: JoyinQ <[email protected]>
Co-authored-by: Lilian Lee <[email protected]>
  • Loading branch information
3 people authored Aug 19, 2020
1 parent 96cffdc commit d6adc27
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
24 changes: 14 additions & 10 deletions en/manage-replication-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -215,7 +219,7 @@ help pause-task
pause a specified running task

Usage:
dmctl pause-task [-w worker ...] <task-name> [flags]
dmctl pause-task [-w worker ...] <task-name | task-file> [flags]

Flags:
-h, --help help for pause-task
Expand All @@ -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
Expand Down Expand Up @@ -289,7 +293,7 @@ help resume-task
resume a specified paused task
Usage:
dmctl resume-task [-w worker ...] <task-name> [flags]
dmctl resume-task [-w worker ...] <task-name | task-file> [flags]
Flags:
-h, --help help for resume-task
Expand All @@ -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
Expand Down Expand Up @@ -355,7 +359,7 @@ help stop-task
stop a specified task
Usage:
dmctl stop-task [-w worker ...] <task-name> [flags]
dmctl stop-task [-w worker ...] <task-name | task-file> [flags]
Flags:
-h, --help help for stop-task
Expand All @@ -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
Expand Down Expand Up @@ -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 <task-name>`.
If `stage` is not `Paused`, use `pause-task <task-name>` to pause the task.
If `stage` is not `Paused`, use `pause-task <task-name | task-file>` 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 <task-name>`.
4. Resume the task using `<task-name | task-file>`.
#### Update items that do not support online update
1. Check the status of the corresponding data replication task using `query-status <task-name>`.
If the task exists, use `stop-task <task-name>` to stop the task.
If the task exists, use `stop-task <task-name | task-file>` 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 <task-name>`.
3. Restart the task using `start-task <config-file>`.
#### Command usage help
Expand Down
2 changes: 1 addition & 1 deletion en/task-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ To illustrate how to modify the task configuration, the following is an example
{{< copyable "" >}}

```bash
stop-task <task-name>
stop-task <task-name | task-file>
```

3. Start the task by executing the `start-task` command:
Expand Down

0 comments on commit d6adc27

Please sign in to comment.