defang 3.11.2 → 3.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,6 +23,7 @@ The Defang Command-Line Interface [(CLI)](https://docs.defang.io/docs/getting-st
|
|
|
23
23
|
The Defang CLI recognizes the following environment variables:
|
|
24
24
|
|
|
25
25
|
- `COMPOSE_DISABLE_ENV_FILE` - Whether to disable loading environment variables from a `.env` file in the current directory; defaults to `false`
|
|
26
|
+
- `COMPOSE_ENV_FILES` - A comma-separated list of environment file(s) to use for interpolation instead of `.env`; overridden by the `--env-file` flag
|
|
26
27
|
- `COMPOSE_FILE` - The Compose file(s) to use; defaults to `compose.yaml`, `compose.yml`, `docker-compose.yaml`, or `docker-compose.yml` in the current directory
|
|
27
28
|
- `COMPOSE_PATH_SEPARATOR` - The path separator to use for `COMPOSE_FILE`; defaults to `:` on Unix/MacOS and `;` on Windows
|
|
28
29
|
- `COMPOSE_PROJECT_NAME` - The name of the project to use; overrides the `name` in the Compose file
|
|
@@ -43,13 +44,14 @@ The Defang CLI recognizes the following environment variables:
|
|
|
43
44
|
- `DEFANG_MODEL_ID` - The model ID of the LLM to use for the generate/debug AI integration (Pro users only)
|
|
44
45
|
- `DEFANG_NO_CACHE` - If set to `true`, disables pull-through caching of container images; defaults to `false`
|
|
45
46
|
- `DEFANG_PREFIX` - The prefix to use for all BYOC resources; defaults to `Defang`
|
|
46
|
-
- `DEFANG_PROVIDER` - The name of the cloud provider to use, `auto` (default), `aws`, `digitalocean`, `gcp`, or `defang`
|
|
47
|
+
- `DEFANG_PROVIDER` - The name of the cloud provider to use, `auto` (default), `aws`, `azure`, `digitalocean`, `gcp`, or `defang`
|
|
47
48
|
- `DEFANG_PULUMI_BACKEND` - The Pulumi backend URL or `"pulumi-cloud"`; defaults to a self-hosted backend
|
|
48
49
|
- `DEFANG_PULUMI_DEBUG` - If set to `true`, enables debug logging for Pulumi operations; defaults to `false`
|
|
49
50
|
- `DEFANG_PULUMI_DIFF` - If set to `true`, shows the Pulumi diff during deployments; defaults to `false`
|
|
50
51
|
- `DEFANG_PULUMI_DIR` - Run Pulumi from this folder, instead of spawning a cloud task; requires `--debug` (BYOC only)
|
|
51
52
|
- `DEFANG_PULUMI_VERSION` - Override the version of the Pulumi image to use (`aws` provider only)
|
|
52
53
|
- `DEFANG_RECIPE` - The deployment mode / recipe to use; defaults to `AFFORDABLE`
|
|
54
|
+
- `DEFANG_STACK` - The name of the stack to use
|
|
53
55
|
- `DEFANG_SUFFIX` - The suffix to use for all BYOC resources; defaults to the stack name, or `beta` if unset.
|
|
54
56
|
- `DEFANG_WORKSPACE` - The workspace (name or ID) to use; preferred way to select which workspace the CLI uses
|
|
55
57
|
- `NO_COLOR` - If set to any value, disables color output; by default, color output is enabled depending on the terminal
|
|
@@ -61,3 +63,18 @@ The Defang CLI recognizes the following environment variables:
|
|
|
61
63
|
Environment variables will be loaded from a `.defang` file in the current directory, if it exists. This file follows
|
|
62
64
|
the same format as a `.env` file: `KEY=VALUE` pairs on each line, lines starting with `#` are treated as comments and ignored.
|
|
63
65
|
|
|
66
|
+
### Compose interpolation
|
|
67
|
+
|
|
68
|
+
After selecting a stack, the CLI makes the resolved `DEFANG_PROVIDER` and `DEFANG_STACK` values available for Compose
|
|
69
|
+
interpolation. They are not injected into services automatically; reference them explicitly where needed:
|
|
70
|
+
|
|
71
|
+
```yaml
|
|
72
|
+
services:
|
|
73
|
+
app:
|
|
74
|
+
environment:
|
|
75
|
+
PUBLISH_PROVIDER: "${DEFANG_PROVIDER}"
|
|
76
|
+
PUBLISH_STACK: "${DEFANG_STACK}"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
The resolved values take precedence over values with the same names in Compose env files. Fields that Compose must decode
|
|
80
|
+
before stack selection should provide a default, such as `${DEFANG_PROVIDER:-auto}`.
|
package/package.json
CHANGED