Skip to content

Commit

Permalink
checkpoint
Browse files Browse the repository at this point in the history 
Signed-off-by: Jeff Ortel <[email protected]>
  • Loading branch information
@jortel
jortel committed Feb 25, 2025
1 parent 2e436f1 commit e1ba4c1
Showing 1 changed file with 39 additions and 39 deletions.
78 changes: 39 additions & 39 deletions task/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ The manager injects a few environment variables:
| ADDON_HOME | Path to an EmptyDir mounted as the working directory. Defined by the [HomeDir](https://github.com/konveyor/tackle2-hub/tree/main/settings#addon) setting. |
| SHARED_PATH | Path to an EmptyDir mounted in all containers within the pod for sharing files. Defined by the [Shared.Path](https://github.com/konveyor/tackle2-hub/tree/main/settings#main) setting. |
| CACHE_PATH | Path to a volume mounted in all containers in all pods for cached files. Defined by the [Cache.Path](https://github.com/konveyor/tackle2-hub/tree/main/settings#main) setting. |
| HUB_BASE_URL | The hub API base url. Defined by the [Hub.URL](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/settings/README.md#addon) setting. |
| HUB_BASE_URL | The hub API base url. Defined by the [Hub.URL](https://github.com/konveyor/tackle2-hub/tree/main/settings#addon) setting. |
| TASK | The task id (to be acted on). |
| TOKEN | An authentication token for the hub API. |

Expand Down Expand Up @@ -138,32 +138,32 @@ Tasks are used to execute Addons.

`*` indicates reported by addon.

| Name | Definition |
|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ID | Unique identifier. |
| CreateTime | The timestamp of when the task was created. |
| CreateUser | The user (name) that created the task. |
| UpdateUser | The user (name) that last updated the task. |
| Name | The task mame (non-unique). |
| Kind | The kind references a Task (kind) CR by name. |
| Addon | The addon to be executed. References an Addon CR by name. When not specified, the addon is selected based on kind. |
| Extension | The list of extensions to be injected into the addon pod as _sidecar_ containers. |
| State | The task state. See: [_States_](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/task/README.md#states). |
| Locator | The task locator. An arbitrary user-defined value used for lookup. |
| Priority | The task execution priority. See: [_Priority_](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/task/README.md#priority). |
| Policy | The task execution policy. Determines when task is postponed. See: [_Policies_](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/task/README.md#policies). |
| TTL | The task Time-To-Live in each state. See: [_TTL_](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/task/README.md#ttl-time-to-live). |
| Data | The data provided to the addon. The schema is dictated by each addon. This may be _ANY_ document. |
| Started | The UTC timestamp when the task execution started. |
| Terminated | The UTC timestamp when execution completed. |
| Errors | A list of reported errors. See: [_Errors_](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/task/README.md#errors). |
| Events | A list of reported task processing events. See: [_Events_](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/task/README.md#events). |
| Pod | The fully qualified name of the pod created. |
| Retries | The number of times failure to create a pod is retried. This does not include when blocked by resource quota. |
| Attached | Files attached to the task. |
| \*Activity | The activity (log) entries are reported by the addon. Intended to reflect what the addon is doing. |
| \*Total | Progress: The total number of items to be completed by the addon. |
| \*Completed | Progress: The number of items completed by the addon. | |
| Name | Definition |
|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| ID | Unique identifier. |
| CreateTime | The timestamp of when the task was created. |
| CreateUser | The user (name) that created the task. |
| UpdateUser | The user (name) that last updated the task. |
| Name | The task mame (non-unique). |
| Kind | The kind references a Task (kind) CR by name. |
| Addon | The addon to be executed. References an Addon CR by name. When not specified, the addon is selected based on kind. |
| Extension | The list of extensions to be injected into the addon pod as _sidecar_ containers. |
| State | The task state. See: [States](https://github.com/konveyor/tackle2-hub/tree/main/task#states). |
| Locator | The task locator. An arbitrary user-defined value used for lookup. |
| Priority | The task execution priority. See: [Priority](https://github.com/konveyor/tackle2-hub/tree/main/task#priority). |
| Policy | The task execution policy. Determines when task is postponed. See: [Policies](https://github.com/konveyor/tackle2-hub/tree/main/task#policies). |
| TTL | The task Time-To-Live in each state. See: [TTL](https://github.com/konveyor/tackle2-hub/tree/main/task#ttl-time-to-live). |
| Data | The data provided to the addon. The schema is dictated by each addon. This may be _ANY_ document. |
| Started | The UTC timestamp when the task execution started. |
| Terminated | The UTC timestamp when execution completed. |
| Errors | A list of reported errors. See: [Errors](https://github.com/konveyor/tackle2-hub/tree/main/task#errors). |
| Events | A list of reported task processing events. See: [Events](https://github.com/konveyor/tackle2-hub/tree/main/task#events). |
| Pod | The fully qualified name of the pod created. |
| Retries | The number of times failure to create a pod is retried. This does not include when blocked by resource quota. |
| Attached | Files attached to the task. |
| \*Activity | The activity (log) entries are reported by the addon. Intended to reflect what the addon is doing. |
| \*Total | Progress: The total number of items to be completed by the addon. |
| \*Completed | Progress: The number of items completed by the addon. | |

### Events ###

Expand Down Expand Up @@ -206,17 +206,17 @@ Note: A task may complete with a state=Succeeded with errors.

`*` indicates _terminal_ states.

| State | Definition |
|:-------------|:----------------------------------------------------------------------------------------------|
| Created | The task has been created but not submitted. |
| Ready | The task has been submitted to the manager and will be scheduled for execution. |
| State | Definition |
|:-------------|:------------------------------------------------------------------------------------------------|
| Created | The task has been created but not submitted. |
| Ready | The task has been submitted to the manager and will be scheduled for execution. |
| Postponed | The task has been postponed until another task has completed based on task scheduling _policy_. |
| QuotaBlocked | The task pod has been (temporarily) prevented from being created by k8s resource quota. |
| Pending | The task pod has been created and awaiting k8s scheduling. |
| Running | The task pod is running. |
| \*Succeeded | The task pod successfully completed. |
| \*Failed | The task pod either failed to be started by k8s or completed with errors. |
| \*Canceled | The task has been canceled. |
| QuotaBlocked | The task pod has been (temporarily) prevented from being created by k8s resource quota. |
| Pending | The task pod has been created and awaiting k8s scheduling. |
| Running | The task pod is running. |
| \*Succeeded | The task pod successfully completed. |
| \*Failed | The task pod either failed to be started by k8s or completed with errors. |
| \*Canceled | The task has been canceled. |


### Policies ###
Expand Down Expand Up @@ -247,7 +247,7 @@ The `Task` CR defines a name kind of task. Each kind may define:

An `Addon` CR defines a named addon (aka plugin). It defines functionality provide by an image to
be executed. The definition includes a container specification and selection criteria. An addon
may have extensions. See: [_Extensions_](https://github.com/konveyor/tackle2-hub/blob/ab4977d68c9e4a8e1d0189f296ef1bafc447b92d/task/README.md#extensions).
may have extensions. See: [_Extensions_](https://github.com/konveyor/tackle2-hub/tree/main/task#extensions).

### Selection ###

Expand Down Expand Up @@ -291,5 +291,5 @@ This is to prevent orphaned or stuck tasks from leaking resources such as bucket
| Succeeded | [Reaper.Succeeded](https://github.com/konveyor/tackle2-hub/tree/main/settings#task-manager) | Deleted |
| Failed | [Reaper.Failed](https://github.com/konveyor/tackle2-hub/tree/main/settings#task-manager) | Released |

See [Reaper](https://github.com/konveyor/tackle2-hub/blob/main/reaper/README.md#tasks)
See [Reaper](https://github.com/konveyor/tackle2-hub/blob/main/reaper/README.md#reaper)
settings for details.

0 comments on commit e1ba4c1

Please sign in to comment.