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: README.md
+18-1Lines changed: 18 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,12 +87,24 @@ tasks:
87
87
platforms: ['linux', 'darwin'] # overrides the default
88
88
```
89
89
90
+
### Configuration: Environment Variables
91
+
92
+
Environment variables can be defined in the optional `env` section of the configuration file. These variables can be referenced in other sections of the configuration file using the `env()` function or by prefixing the variable name with `$` (e.g. `$MY_VAR`).
93
+
94
+
```yaml
95
+
env:
96
+
- MY_ENV_VAR_ONE=test1234
97
+
- MY_ENV_VAR_TWO=1234test
98
+
```
99
+
90
100
### Configuration: Includes
91
101
92
-
The `includes` section of the configuration file is used to specify a list of filenamesor file urls that should be merged with the configuration. This is useful for splitting up a large configuration file into smaller, more manageable files or reusing commonly-used tasks, init scripts, or preconditions. Startup, shutdown, servers, and scheduled tasks are not merged from the included files.
102
+
The `includes` section of the configuration file is used to specify a list of filenames, file urls, or s3 urls that should be merged with the configuration. This is useful for splitting up a large configuration file into smaller, more manageable files or reusing commonly-used tasks, init scripts, or preconditions. Startup, shutdown, servers, and scheduled tasks are not merged from the included files.
93
103
94
104
Included urls can be prefixed with `gh:` to indicate that the file should be fetched from GitHub. For example, `gh:permafrost-dev/stackup/main/templates/stackup.dist.yaml` will fetch the `stackup.dist.yaml` file from the `permafrost-dev/stackup` repository on GitHub.
95
105
106
+
To use a file from an S3 bucket, prefix the url with `s3:`. For example, `s3:hostname/my-bucket-name/my-config.yaml` will fetch the `my-config.yaml` file from the `my-bucket-name` bucket on `hostname`. Amazon S3 and Minio are supported.
107
+
96
108
Included files can be specified with either a relative or absolute pathname. Relative pathnames are relative to the directory containing the configuration file. Absolute pathnames are relative to the current working directory.
97
109
98
110
```yaml
@@ -101,6 +113,11 @@ includes:
101
113
verify: false # optional, defaults to true
102
114
103
115
- file: python.yaml # includes a local file
116
+
117
+
- url: s3:127.0.0.1:9000/stackup-includes/python.yaml # includes a file from a minio bucket
118
+
access-key: $S3_KEY # access key loaded from `.env` or `env` section
119
+
secret-key: $S3_SECRET # secret key env loaded from `.env` or `env` section
120
+
secure: false # optional, defaults to true
104
121
```
105
122
106
123
If the optional field `verify` is set to `false`, the application will not attempt to verify the checksum of the file before fetching it. This may be useful for files that are frequently updated, but is not recommended.
0 commit comments