[SIMPL-27992](https://jira.simplprogramme.eu/browse/SIMPL-27992) Update documentation Workflow Deletion Process.

Changelog: changed
This commit is contained in:
Adrian LODIN
2026-05-28 16:59:00 +03:00
parent 81bb3299a4
commit 96a8a8e4eb

View File

@@ -105,21 +105,31 @@ defs = Definitions(
``` ```
### 2.3.2 Workflow deletion ### 2.3.2 Workflow deletion
Here is a practical example of how to delete a workflow. Before deleting an existing workflow, first check its status (if is needed or referenced) in the **Dagster UI**:
- Navigate to the "Runs". Identify a given worklog using the "Filter" button or navigation "Newer", "Older" buttons.
- Check details and status: open workflow details by clicking on the target, or just check the status value.
- Check logs: open workflow logs by clicking on the uuid.
**1. Pre-delete check** Here are two practical examples how to delete a workflow:
Before deleting an existing workflow, first check its status (if is needed or referenced):
- **Dagster UI**: Navigate to the "Runs". Identify a given worklog using the "Filter" button or navigation "Newer", "Older" buttons.
- **Details, logs check:** Check workflow status, open it by clicking on it's target or open logs by clicking on it's uuid.
**2. Delete Ops (`ops/ops.py`)** **Temporary delete workflow**
If the workflow is defined as an op, delete it's corresponding method from the `ops.py` file.
**3. Delete Jobs (`jobs/jobs.py`)** **1. Clean Registering Definitions (`repository.py`)**
If the workflow is defined as a job, delete it's corresponding method from the `jobs.py` file. Comment or delete workflow definition from the `repository.py`.
**4. Delete Registering Definitions (`repository.py`)** **Permanently delete workflow**
Delete workflow import, and it's definition from the `repository.py`
**1. Clean Jobs (`jobs/jobs.py`)**
Delete workflow definition from the `jobs.py` file.
**2. Clean Ops (`ops/ops.py`)**
If workflow links also ops, delete their definition from the `ops.py` file.
**3. Clean Tests (`tests/`)**
If jobs or obs have dedicated unittest, check out the `tests/` folder and delete them.
**3. Clean Scheduler **
If there is any scheduler for this workflow check and adjust it accordingly.
### 2.4 Best Practices & Constraints ### 2.4 Best Practices & Constraints