Skip to content

Commit 8bcd879

Browse files
committed
Add docs for envd extra args and vars
1 parent 4446586 commit 8bcd879

File tree

2 files changed

+66
-0
lines changed

2 files changed

+66
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,39 @@ disk_support_config = {
9696
}
9797
```
9898

99+
## `materialize_instances` variable
100+
101+
The `materialize_instances` variable is a list of objects that define the configuration for each Materialize instance.
102+
103+
### `environmentd_extra_env`
104+
105+
Optional list of extra environment variables to pass to the `environmentd` container. This allows you to pass any additional configuration supported by Materialize.
106+
107+
Each entry should be an object with `name` and `value` fields:
108+
109+
```hcl
110+
environmentd_extra_env = [
111+
{
112+
name = "MZ_LOG_FILTER"
113+
value = "materialized::coord=debug"
114+
}
115+
]
116+
```
117+
118+
### `environmentd_extra_args`
119+
120+
Optional list of additional command-line arguments to pass to the `environmentd` container. This can be used to override default system parameters or enable specific features.
121+
122+
```hcl
123+
environmentd_extra_args = [
124+
"--system-parameter-default=max_clusters=1000",
125+
"--system-parameter-default=max_connections=1000",
126+
"--system-parameter-default=max_tables=1000",
127+
]
128+
```
129+
130+
These flags configure default limits for clusters, connections, and tables. You can provide any supported arguments [here](https://materialize.com/docs/sql/alter-system-set/#other-configuration-parameters).
131+
99132
## Requirements
100133

101134
| Name | Version |

docs/header.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,36 @@ disk_support_config = {
9494
}
9595
}
9696
```
97+
98+
## `materialize_instances` variable
99+
100+
The `materialize_instances` variable is a list of objects that define the configuration for each Materialize instance.
101+
102+
### `environmentd_extra_env`
103+
104+
Optional list of extra environment variables to pass to the `environmentd` container. This allows you to pass any additional configuration supported by Materialize.
105+
106+
Each entry should be an object with `name` and `value` fields:
107+
108+
```hcl
109+
environmentd_extra_env = [
110+
{
111+
name = "MZ_LOG_FILTER"
112+
value = "materialized::coord=debug"
113+
}
114+
]
115+
```
116+
117+
### `environmentd_extra_args`
118+
119+
Optional list of additional command-line arguments to pass to the `environmentd` container. This can be used to override default system parameters or enable specific features.
120+
121+
```hcl
122+
environmentd_extra_args = [
123+
"--system-parameter-default=max_clusters=1000",
124+
"--system-parameter-default=max_connections=1000",
125+
"--system-parameter-default=max_tables=1000",
126+
]
127+
```
128+
129+
These flags configure default limits for clusters, connections, and tables. You can provide any supported arguments [here](https://materialize.com/docs/sql/alter-system-set/#other-configuration-parameters).

0 commit comments

Comments
 (0)