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
Copy file name to clipboardExpand all lines: registry/coder-labs/modules/archive/README.md
+3-23Lines changed: 3 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,9 @@ module "archive" {
32
32
-`create_on_stop` to create an archive automatically when the workspace stops.
33
33
-`extract_on_start` to wait for an archive to appear and extract it on start.
34
34
35
+
> [!WARNING]
36
+
> The `create_on_stop` feature uses the `coder_script``run_on_stop` which may not work as expected on certain templates without additional provider configuration. The agent may be terminated before the script completes. See [coder/coder#6174](https://github.com/coder/coder/issues/6174) for provider-specific workarounds and [coder/coder#6175](https://github.com/coder/coder/issues/6175) for tracking a fix.
37
+
35
38
## Usage
36
39
37
40
Basic example:
@@ -105,29 +108,6 @@ module "archive" {
105
108
}
106
109
```
107
110
108
-
## Inputs
109
-
110
-
-`agent_id` (string, required): The ID of a Coder agent.
111
-
-`paths` (list(string), default: `["."]`): Files/directories to include when creating an archive.
112
-
-`exclude_patterns` (list(string), default: `[]`): Patterns to exclude (passed to tar via `--exclude`).
113
-
-`compression` (string, default: `"gzip"`): One of `gzip`, `zstd`, or `none`.
114
-
-`archive_name` (string, default: `"coder-archive"`): Base archive name (extension is inferred from `compression`).
115
-
-`output_dir` (string, default: `"/tmp"`): Directory where the archive file will be written/read by default.
116
-
-`directory` (string, default: `"~"`): Working directory used for tar with `-C`.
117
-
-`create_on_stop` (bool, default: `false`): If true, registers a `run_on_stop` script that invokes the create wrapper on workspace stop.
118
-
-`extract_on_start` (bool, default: `false`): If true, the installer waits up to `extract_wait_timeout_seconds` for the archive path to appear and extracts it on start.
119
-
-`extract_wait_timeout_seconds` (number, default: `5`): Timeout for `extract_on_start`.
120
-
121
-
> [!WARNING]
122
-
> The `create_on_stop` feature uses the `coder_script``run_on_stop` which may not work as expected on certain templates without additional provider configuration. The agent may be terminated before the script completes. See [coder/coder#6174](https://github.com/coder/coder/issues/6174) for provider-specific workarounds and [coder/coder#6175](https://github.com/coder/coder/issues/6175) for tracking a fix.
123
-
124
-
## Outputs
125
-
126
-
-`archive_path` (string): Full archive path computed as `output_dir/archive_name + extension`, where the extension comes from `compression`:
0 commit comments