You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**Local pipe creation** — `stacker pipe create` works without a cloud deployment (`deployment_hash` is now optional, `is_local` flag on PipeInstance/PipeExecution)
11
+
-**Local scanning** — `stacker pipe scan` discovers containers via `docker ps` in local mode
12
+
-**Local triggering** — `stacker pipe trigger` executes via `docker exec` / HTTP against local containers
13
+
-**`stacker pipe deploy <id> --deployment <hash>`** — promote a local pipe to a remote deployment (clones config to new remote instance)
14
+
-**`GET /api/v1/pipes/instances/local`** — list local pipe instances for the authenticated user
15
+
-**`POST /api/v1/pipes/instances/{id}/deploy`** — deploy (promote) local pipe to remote
16
+
-**`stacker init --target local`** — initialize project in local mode directly
17
+
- Database migration: `deployment_hash` nullable, `is_local BOOLEAN DEFAULT FALSE`, partial index on local instances
Copy file name to clipboardExpand all lines: docs/DAG_PIPES_DEVELOPER_MANUAL.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,12 @@ Build and run data pipelines that connect your deployed services. Route contact
6
6
7
7
| Part | For | What you'll learn |
8
8
|------|-----|------------------|
9
-
|**[Part 1: CLI Guide](./DAG_PIPES_PART1_CLI_GUIDE.md)**| Getting started | Create and run pipes using `stacker pipe` commands |
9
+
|**[Part 1: CLI Guide](./DAG_PIPES_PART1_CLI_GUIDE.md)**| Getting started | Create and run pipes using `stacker pipe` commands (includes local mode) |
10
10
|**[Part 2: Visual Editor](./DAG_PIPES_PART2_WEB_EDITOR.md)**| Visual builders | Drag-and-drop pipeline builder in your browser |
11
11
|**[Part 3: REST API Deep Dive](./DAG_PIPES_PART3_API_DEEP_DIVE.md)**| Automation & scripting | Full API reference, curl scripts, gRPC streaming |
12
12
13
+
> **💡 Local mode**: You can build and test pipes against local Docker containers without a cloud deployment. See the [Local Mode section in Part 1](./DAG_PIPES_PART1_CLI_GUIDE.md#local-mode-experimental) for setup and workflow.
14
+
13
15
## Examples in All Three Guides
14
16
15
17
Each guide walks through the same practical examples:
Copy file name to clipboardExpand all lines: docs/DAG_PIPES_PART2_WEB_EDITOR.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -179,6 +179,8 @@ Click **"Execute"** to run the pipeline with test data.
179
179
180
180
Demo mode is great for learning the interface. Sign in to actually run pipelines.
181
181
182
+
> **💡 Local mode (CLI)**: For local experimentation with _real_ execution, use `stacker target local` and the CLI pipe commands (see [Part 1: Local Mode](./DAG_PIPES_PART1_CLI_GUIDE.md#local-mode-experimental)). Local pipes can later be promoted to remote via `stacker pipe deploy`.
3.**Agent** (status-panel) - runs on the deployment, probes containers, executes pipe triggers
23
32
33
+
> **Local mode**: When `stacker target local` is active, scan uses `docker ps` and trigger uses `docker exec` — no agent required. Pipes are stored with `is_local=true` and no `deployment_hash`.
-**Template** - reusable pipe definition: source app type, target app type, endpoint paths, field mapping. Can be shared publicly.
141
-
-**Instance** - deployment-specific activation of a template: ties to a `deployment_hash`, tracks status, trigger counts, errors.
152
+
-**Instance** - activation of a template tied to a deployment or local context:
153
+
-**Remote instance** — bound to a `deployment_hash`, executed via the status agent on the cloud server.
154
+
-**Local instance** — no `deployment_hash`, `is_local=true`, executed via `docker exec` against local containers. Created when `stacker target local` is active.
142
155
143
156
### Field Mapping
144
157
@@ -257,10 +270,12 @@ All endpoints require authentication. Pipe instance access is verified through d
257
270
258
271
| Method | Path | Description |
259
272
|--------|------|-------------|
260
-
| POST |`/api/v1/pipes/instances`| Create instance |
273
+
| POST |`/api/v1/pipes/instances`| Create instance (`deployment_hash` optional for local) |
261
274
| GET |`/api/v1/pipes/instances/{deployment_hash}`| List instances for deployment |
275
+
| GET |`/api/v1/pipes/instances/local`| List local instances for current user |
262
276
| GET |`/api/v1/pipes/instances/detail/{id}`| Get instance |
263
277
| PUT |`/api/v1/pipes/instances/{id}/status`| Update status (draft/active/paused/error) |
278
+
| POST |`/api/v1/pipes/instances/{id}/deploy`| Promote local instance to remote deployment |
Copy file name to clipboardExpand all lines: docs/STACKER_YML_REFERENCE.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -501,6 +501,8 @@ deploy:
501
501
target: local
502
502
```
503
503
504
+
> **Pipe mode**: The `deploy.target` value also affects how `stacker pipe` commands behave. When target is `local`, pipes are created without a `deployment_hash` and execute against local Docker containers (`docker exec`). Use `stacker target` to switch modes at runtime without editing `stacker.yml`. See the [DAG Pipes CLI Guide — Local Mode](./DAG_PIPES_PART1_CLI_GUIDE.md#local-mode-experimental) for details.
0 commit comments