Skip to content

docs: add support for environmentd_extra_args #32544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: self-managed-docs/v25.1
Choose a base branch
from
Open

docs: add support for environmentd_extra_args #32544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/user/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,12 @@ weight = 30
# allow <a name="link-target">, the old syntax no longer works
unsafe = true


[markup]
[markup.highlight]
noClasses = false
style = "monokai"

[[deployment.targets]]
name = "production"
url = "s3://materialize-website?region=us-east-1"
Expand Down
17 changes: 11 additions & 6 deletions doc/user/content/installation/install-on-aws/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,9 +283,9 @@ components:
EOF
```

Starting in v0.3.0, the Materialize on AWS Terraform module also deploys, by
default, Network Load Balancers (NLBs) for each Materialize instance (i.e.,
the
- **Starting in v0.3.0**, the Materialize on AWS Terraform module also
deploys, by default, Network Load Balancers (NLBs) for each Materialize
instance (i.e., the
[`create_nlb`](https://github.com/MaterializeInc/terraform-aws-materialize?tab=readme-ov-file#input_materialize_instances)
flag defaults to `true`). The NLBs, by default, are configured to be
internal (i.e., the
Expand All @@ -294,9 +294,14 @@ components:
https://github.com/MaterializeInc/terraform-aws-materialize?tab=readme-ov-file#input_materialize_instances)
for the Materialize instance configuration options.

Starting in v0.4.0, a self-signed `ClusterIssuer` is deployed by default. The
`ClusterIssuer` is deployed on subsequent after the `cert-manager` is
running.
- **Starting in v0.4.0**, a self-signed `ClusterIssuer` is deployed by
Copy link
Contributor Author

@kay-kim kay-kim May 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depending on how prominent we want this config option, can actually remove. If we envision users only setting this rarely, can remove to de-clutter the page since the same page has a release section with the same info on it.

We can also create an appendix page of common settings we think people might want to set, if we know of them.

default. The `ClusterIssuer` is deployed on subsequent after the
`cert-manager` is running.

- **Starting in v0.4.6**, you can specify addition configuration options via
`environmentd_extra_args`.

{{% include-md file="shared-content/materialized_extra_args.md" %}}

{{< tip >}}
{{% self-managed/aws-terraform-upgrade-notes %}}
Expand Down
15 changes: 10 additions & 5 deletions doc/user/content/installation/install-on-azure/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,12 +336,12 @@ deploys a sample infrastructure on Azure with the following components:
EOF
```

Starting in v0.3.0, the Materialize on Azure Terraform module also deploys,
by default, a self-signed `ClusterIssuer`. The `ClusterIssuer` is deployed
after the `cert-manager` is deployed and running.
- **Starting in v0.3.0**, the Materialize on Azure Terraform module also
deploys, by default, a self-signed `ClusterIssuer`. The `ClusterIssuer` is
deployed after the `cert-manager` is deployed and running.

Starting in v0.3.1, the Materialize on Azure Terraform module also deploys,
by default, [Load
- **Starting in v0.3.1**, the Materialize on Azure Terraform module also
deploys, by default, [Load
balancers](https://github.com/MaterializeInc/terraform-azurerm-materialize?tab=readme-ov-file#input_materialize_instances)
for Materialize instances (i.e., the
[`create_load_balancer`](https://github.com/MaterializeInc/terraform-azurerm-materialize?tab=readme-ov-file#input_materialize_instances)
Expand All @@ -350,6 +350,11 @@ deploys a sample infrastructure on Azure with the following components:
[`internal_load_balancer`](https://github.com/MaterializeInc/terraform-azurerm-materialize?tab=readme-ov-file#input_materialize_instances)
flag defaults to `true`).

- **Starting in v0.4.3**, you can specify addition configuration options via
`environmentd_extra_args`.

{{% include-md file="shared-content/materialized_extra_args.md" %}}

{{< tip >}}
{{% self-managed/azure-terraform-upgrade-notes %}}

Expand Down
24 changes: 11 additions & 13 deletions doc/user/content/installation/install-on-gcp/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,21 +405,19 @@ components:
EOF
```

Starting in v0.3.0, the Materialize on GCP Terraform module also deploys, by
default,

- [Load
balancers](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#input_materialize_instances)
for Materialize instances (i.e., the
[`create_load_balancer`](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#input_materialize_instances)
flag defaults to `true`). The load balancers, by default, are configured to
be internal (i.e., the
[`internal_load_balancer`](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#input_materialize_instances)
flag defaults to `true`).

- A self-signed `ClusterIssuer`. The `ClusterIssuer` is deployed after the
- **Starting in v0.3.0**, the Materialize on GCP Terraform module also
deploys, by default:

- [Load balancers](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#input_materialize_instances) for Materialize instances (i.e., the [`create_load_balancer`](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#input_materialize_instances) flag defaults to `true`). The load balancers, by default, are configured to be internal (i.e., the [`internal_load_balancer`](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#input_materialize_instances) flag defaults to `true`).

- A self-signed `ClusterIssuer`. The `ClusterIssuer` is deployed after the
`cert-manager` is deployed and running.


- **Starting in v0.4.3**, you can specify addition configuration options via
`environmentd_extra_args`.

{{% include-md file="shared-content/materialized_extra_args.md" %}}
{{< tip >}}
{{% self-managed/gcp-terraform-upgrade-notes %}}

Expand Down
19 changes: 18 additions & 1 deletion doc/user/data/self_managed/aws_terraform_versions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,30 @@ columns:
- column: "Notable changes"

rows:

- "Terraform version": |
[v0.4.6](https://github.com/MaterializeInc/terraform-aws-materialize/releases/)
"Notable changes": |

- Adds support for passing in additional Materialize instance configuration
options via [`environmentd_extra_args`](https://github.com/MaterializeInc/terraform-aws-materialize?tab=readme-ov-file#input_materialize_instances)

{{% include-md file="shared-content/materialized_extra_args.md" %}}

- Uses `terraform-helm-materialize` v0.1.15.

- "Terraform version": |
[v0.4.5](https://github.com/MaterializeInc/terraform-aws-materialize/releases/tag/v0.4.5)
"Notable changes": |
- Defaults to using Materialize Operator v25.1.12 (via
`terraform-helm-materialize` v0.1.14).

- "Terraform version": |
[v0.4.4](https://github.com/MaterializeInc/terraform-aws-materialize/releases/tag/v0.4.4)
"Notable changes": |
- Defaults to using Materialize Operator v25.1.11 (via
`terraform-helm-materialize` v0.1.13).


- "Terraform version": |
[v0.4.3](https://github.com/MaterializeInc/terraform-aws-materialize/releases/tag/v0.4.3)
"Notable changes": |
Expand Down
12 changes: 12 additions & 0 deletions doc/user/data/self_managed/azure_terraform_versions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ columns:

rows:

- "Terraform version": |
[v0.4.3](https://github.com/MaterializeInc/terraform-azurerm-materialize/releases/)
"Notable changes": |

- Adds support for passing in additional Materialize instance configuration
options via
[`environmentd_extra_args`](https://github.com/MaterializeInc/terraform-azurerm-materialize?tab=readme-ov-file#input_materialize_instances)

{{% include-md file="shared-content/materialized_extra_args.md" %}}

- Uses `terraform-helm-materialize` v0.1.15.

- "Terraform version": |
[v0.4.1](https://github.com/MaterializeInc/terraform-azurerm-materialize/releases/tag/v0.4.1)
"Notable changes": |
Expand Down
12 changes: 12 additions & 0 deletions doc/user/data/self_managed/gcp_terraform_versions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ columns:

rows:

- "Terraform version": |
[v0.4.3](https://github.com/MaterializeInc/terraform-google-materialize/releases/)
"Notable changes": |

- Adds support for passing in additional Materialize instance configuration
options via
[`environmentd_extra_args`](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#input_materialize_instances)

{{% include-md file="shared-content/materialized_extra_args.md" %}}

- Uses `terraform-helm-materialize` v0.1.15.

- "Terraform version": |
[v0.4.1](https://github.com/MaterializeInc/terraform-google-materialize/releases/tag/v0.4.1)

Expand Down
12 changes: 12 additions & 0 deletions doc/user/data/self_managed/self_managed_operator_compatibility.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ columns:
- column: "Notes"

rows:
- "Materialize Operator": "v25.1.12"
"orchestratord version": "v0.144.0"
"environmentd version": "v0.130.13"
"Release date": "2025-05-15"
"Notes": ""

- "Materialize Operator": "v25.1.11"
"orchestratord version": "v0.143.0"
"environmentd version": "v0.130.12"
"Release date": "2025-05-15"
"Notes": ""

- "Materialize Operator": "v25.1.10"
"orchestratord version": "v0.142.1"
"environmentd version": "v0.130.11"
Expand Down
22 changes: 22 additions & 0 deletions doc/user/data/self_managed/terraform_helm_compatibility.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,28 @@ columns:
- column: "Release date"

rows:

- "terraform-helm-materialize": "v0.1.15"
"Notes": |
- Adds support for passing in additional `environmentd` configuration options.
- Uses as default Materialize Operator version: `v25.1.12`
- Uses as default environmentd version: `v0.130.13`
"Release date": "2025-05-15"

- "terraform-helm-materialize": "v0.1.14"
"Notes": |

- Uses as default Materialize Operator version: `v25.1.12`
- Uses as default environmentd version: `v0.130.13`
"Release date": "2025-05-15"

- "terraform-helm-materialize": "v0.1.13"
"Notes": |

- Uses as default Materialize Operator version: `v25.1.11`
- Uses as default environmentd version: `v0.130.12`
"Release date": "2025-05-15"

- "terraform-helm-materialize": "v0.1.12"
"Notes": |

Expand Down
15 changes: 15 additions & 0 deletions doc/user/shared-content/materialized_extra_args.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
To use, set the instance's `environmentd_extra_env` to an array of
strings; for example:

```hc {hl_lines="4-8"}
materialize_instances = [
{
...
environmentd_extra_args = [
"--system-parameter-default=<param>=<value>",
"--cors-allowed-origin=<value>",
"--bootstrap-builtin-catalog-server-cluster-replica-size=50cc", ...
]
}
]
```