Skip to content

Commit 188b459

Browse files
committed
update reaper readme.
Signed-off-by: Jeff Ortel <[email protected]>
1 parent ab4977d commit 188b459

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

reaper/README.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ Buckets represent file trees and may be referenced by:
1919
- Task
2020
- TaskGroup
2121

22-
TTL after orphaned (default: 1 minute).
22+
The TTL after orphaned is defined by the
23+
[Bucket.TTL](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/settings/README.md#main) setting.
2324

2425
### Files ###
2526

@@ -29,15 +30,17 @@ Files represent files and may be referenced by:
2930
- Target
3031
- Rule
3132

32-
TTL after orphaned (default: 1 minute).
33+
The TTL after orphaned is defined by the
34+
[File.TTL](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/settings/README.md#main) setting.
3335

3436
### Tasks ###
3537

3638
Tasks may be created then submitted in a _two-phase_ process. The reason is to support
3739
a workflow that involves uploading files into the task's bucket. To do this, the user
3840
must create the task, upload the files, then submit the task. To prevent leaking tasks
3941
that are created and never submitted, the reaper will delete tasks that have not been
40-
submitted after a defined period (default: 72 hours).
42+
submitted after a period defined by the
43+
[Reaper.Created](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/settings/README.md#task-manager) setting.
4144

4245
Submitted tasks are never reaped. As a result, there is a need for objects
4346
referenced by tasks to be reaped. Tasks reference:
@@ -50,9 +53,13 @@ reaped. Releasing simply means to remove the reference to allow them to be
5053
naturally reaped (garbage-collected).
5154

5255
**Succeeded** tasks:
53-
- Released after a defined period (default: 72 hours).
54-
- Pod deleted after a defined period (default: 1 minute)
56+
- Released after a period defined by the
57+
[Reaper.Succeeded](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/settings/README.md#task-manager) setting.
58+
- Pod deleted after a period defined by the
59+
[Pod.Renention.Succeeded](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/settings/README.md#task-manager) setting.
5560

5661
**Failed** tasks:
57-
- Released after a defined period (default: 30 days).
58-
- Pod deleted after a defined period (default 72 hours).
62+
- Released after a period defined by the
63+
[Reaper.Failed](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/settings/README.md#task-manager) setting.
64+
- Pod deleted after a period defined by the
65+
[Pod.Retention.Failed](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/settings/README.md#task-manager) setting.

0 commit comments

Comments
 (0)