Skip to content

Commit 4607aa2

Browse files
GABRIELLE DOMPREHGABRIELLE DOMPREH
authored andcommitted
refactor(serverless-storage-check): consolidate references into parent skill structure
- Merge pattern-catalog.md + remediation-guide.md into a single skills/databricks-serverless-migration/references/serverless-storage-check.md, matching how sibling reference docs are structured in the parent skill - Remove databricks-serverless-storage-check/references/ (now consolidated above) - Remove databricks-serverless-storage-check/agents/ and assets/ (captured at the parent skill level) - Update SKILL.md links from local references/ to ../references/serverless-storage-check.md - Regenerate manifest.json Co-authored-by: Isaac
1 parent a44f32f commit 4607aa2

6 files changed

Lines changed: 395 additions & 481 deletions

File tree

manifest.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -403,8 +403,6 @@
403403
"databricks-serverless-storage-check/eval/tests/test_integration.py",
404404
"databricks-serverless-storage-check/eval/tests/test_unit.py",
405405
"databricks-serverless-storage-check/eval/thinking_instructions.md",
406-
"databricks-serverless-storage-check/references/pattern-catalog.md",
407-
"databricks-serverless-storage-check/references/remediation-guide.md",
408406
"databricks-serverless-storage-check/scripts/preflight.py",
409407
"databricks-serverless-storage-check/scripts/test_preflight.py",
410408
"references/code-patterns.md",
@@ -416,6 +414,7 @@
416414
"references/mlflow-uc-patterns.md",
417415
"references/multi-source-enumeration.md",
418416
"references/networking-and-security.md",
417+
"references/serverless-storage-check.md",
419418
"references/streaming-migration.md"
420419
],
421420
"repo_dir": "skills",
@@ -437,8 +436,6 @@
437436
"eval/tests/test_integration.py",
438437
"eval/tests/test_unit.py",
439438
"eval/thinking_instructions.md",
440-
"references/pattern-catalog.md",
441-
"references/remediation-guide.md",
442439
"scripts/preflight.py",
443440
"scripts/test_preflight.py"
444441
],

skills/databricks-serverless-migration/databricks-serverless-storage-check/SKILL.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The boundary between safe and unsafe local-disk use on serverless:
8585

8686
> **Local disk (`/local_disk0`, `/tmp`, `trustedTemp`) is per-task only.** Anything one task writes that another task reads MUST live on `/Volumes` or `/Workspace`.
8787
88-
This is verbatim from the BSI thread guidance: when the parent task writes to local disk and the child task tries to read it, the child may be on a different node and the file won't exist (or will hit `Permission denied`). See [`references/remediation-guide.md`](references/remediation-guide.md) for concrete before/after patterns.
88+
This is verbatim from the BSI thread guidance: when the parent task writes to local disk and the child task tries to read it, the child may be on a different node and the file won't exist (or will hit `Permission denied`). See [`../references/serverless-storage-check.md`](../references/serverless-storage-check.md) for concrete before/after patterns.
8989

9090
## Pattern catalog (summary)
9191

@@ -99,7 +99,7 @@ This is verbatim from the BSI thread guidance: when the parent task writes to lo
9999
| `FANOUT006` | Blocker | Hardcoded path matching the BSI signature `/local_disk0/spark-*/trustedTemp/...` |
100100
| `ENV001` | Info | Run output contains `ENVIRONMENT_SETUP_ERROR.PYTHON_NOTEBOOK_ENVIRONMENT` — route to escalation |
101101

102-
Full rules, sample matches, and per-pattern fixes are in [`references/pattern-catalog.md`](references/pattern-catalog.md).
102+
Full rules, sample matches, and per-pattern fixes are in [`../references/serverless-storage-check.md`](../references/serverless-storage-check.md).
103103

104104
## Remediation summary
105105

@@ -119,7 +119,7 @@ When the scanner flags a finding, prefer fixes in this order:
119119

120120
4. **Keep `/local_disk0/tmp`** for **intra-task scratch only**. Never for cross-task.
121121

122-
Full before/after code is in [`references/remediation-guide.md`](references/remediation-guide.md).
122+
Full before/after code is in [`../references/serverless-storage-check.md`](../references/serverless-storage-check.md).
123123

124124
## What this skill does NOT cover
125125

@@ -140,8 +140,7 @@ If the scanner emits `ENV001`:
140140

141141
## Reference docs
142142

143-
- [Pattern catalog](references/pattern-catalog.md) — all detection rules with examples
144-
- [Remediation guide](references/remediation-guide.md) — before/after code for Volumes, Workspace, and taskValues handoffs
143+
- [Pattern catalog & remediation guide](../references/serverless-storage-check.md) — all detection rules with examples and before/after fixes for Volumes, Workspace, and taskValues handoffs
145144

146145
## External documentation
147146

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
interface:
22
display_name: "Databricks Serverless Storage Check"
3-
short_description: "Detect cross-task local-disk handoffs in serverless jobs"
3+
short_description: "Detect cross-task file-sharing antipatterns in Databricks serverless jobs (writes to /local_disk0, /tmp, or trustedTemp that are read by sibling or child tasks on potentially different compute node..."
44
icon_small: "./assets/databricks.svg"
55
icon_large: "./assets/databricks.png"
66
brand_color: "#FF3621"
7-
default_prompt: "Use $databricks-serverless-storage-check to scan a serverless job, notebook, or DAB for cross-task file handoffs through /local_disk0, /tmp, or trustedTemp."
7+
default_prompt: "Use $databricks-serverless-storage-check for detect cross-task file-sharing antipatterns in databricks serverless jobs (writes to /local_disk0, /tmp, or trustedtemp that are read by sibling or child tasks on potentially different compute node."

skills/databricks-serverless-migration/databricks-serverless-storage-check/references/pattern-catalog.md

Lines changed: 0 additions & 198 deletions
This file was deleted.

0 commit comments

Comments
 (0)