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.

Sign up for GitHub

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

docs: update README, remove dotnet tool and add force flag #22

Merged
merged 1 commit into from
Oct 17, 2024
Merged

docs: update README, remove dotnet tool and add force flag #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 5 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Armonik.Task.ReRunner
# Armonik.TaskReRunner

This project is part of the [ArmoniK](https://github.com/aneoconsulting/ArmoniK) project.
Armonik.Task.ReRunner is designed to simplify debugging by allowing users to rerun previously submitted and processed tasks. By providing services to select and re-execute individual tasks, it helps users identify and fix issues, streamlining the overall debugging process.
Expand All @@ -13,16 +13,6 @@ You can use your favorite IDE debugger on you worker with the ArmoniK.TaskReRunn

# Installation


- Install the .Net tool
_From [nuget.org](https://www.nuget.org/) in command line :_

```sh
dotnet tool install -g ArmoniK.TaskReRunner
```

Or :

- Clone the repository and move into it.

```sh
Expand All @@ -45,19 +35,6 @@ To run the program, you need:

Run the TaskDumper program with your **ArmoniK running**.

- With the .Net tool :

Install the .Net tool
_From [nuget.org](https://www.nuget.org/) in command line :_

```sh
dotnet tool install -g ArmoniK.TaskDumper
```

```sh
TaskDumper --endpoint <YOUR_ENDPOINT> --taskId <TASK_ID>
```

- With the cloned repository :

```sh
Expand Down Expand Up @@ -156,7 +133,6 @@ Replace `<PATH_TO_BINARIES>` with the path to the extracted binary files.

Replace `<ARMONIK_VERSION>` with the [current core version](https://github.com/aneoconsulting/ArmoniK/blob/main/versions.tfvars.json).


# Usage

## Rerun a Single Task
Expand All @@ -167,26 +143,22 @@ To rerun a single task, use the `dotnet run` command and provide the path of the
dotnet run --path <DATA.JSON> --project src/TaskReRunner/
```

or with the .Net tool :

```sh
TaskReRunner --path <DATA.JSON>
```

Replace `<DATA.JSON>` with the path to your JSON file.

Replace `<PATH_TO_FOLDER>` with the absolute path to your folder containing `PayloadId` and `DataDependencies` files.

## Flags

- `--path`: Path to the JSON file containing the data needed to rerun the task.
- `--force`: Allow the previous output deletion.

### Default Flag Values

- `--path`: "task.json".
- `--force`: false.

----

You can recover your results in `Data_Folder_Path/Expected_Output_Id` or it will be printed on your console as:
`Notified result0 Data: <DATA_IN_BYTE>`.
You can recover your results in `<CURRRENT_DIRECTORY>/ak_dumper_<TASK_ID>` or it will be printed on your console as:
`Notified result0 Data: <DATA_IN_BYTE>`.