From 9ff42581f4e76b98a5981e58539eacf60caa4798 Mon Sep 17 00:00:00 2001 From: kay-kim Date: Mon, 19 May 2025 17:12:42 -0400 Subject: [PATCH] docs: add support for environmentd_extra_args --- doc/user/config.toml | 6 +++++ .../installation/install-on-aws/_index.md | 17 ++++++++----- .../installation/install-on-azure/_index.md | 15 ++++++++---- .../installation/install-on-gcp/_index.md | 24 +++++++++---------- .../self_managed/aws_terraform_versions.yml | 19 ++++++++++++++- .../self_managed/azure_terraform_versions.yml | 12 ++++++++++ .../self_managed/gcp_terraform_versions.yml | 12 ++++++++++ .../self_managed_operator_compatibility.yml | 12 ++++++++++ .../terraform_helm_compatibility.yml | 22 +++++++++++++++++ .../shared-content/materialized_extra_args.md | 15 ++++++++++++ 10 files changed, 129 insertions(+), 25 deletions(-) create mode 100644 doc/user/shared-content/materialized_extra_args.md diff --git a/doc/user/config.toml b/doc/user/config.toml index dc0d413aee7ad..5d6fadad03822 100644 --- a/doc/user/config.toml +++ b/doc/user/config.toml @@ -183,6 +183,12 @@ weight = 30 # allow , 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" diff --git a/doc/user/content/installation/install-on-aws/_index.md b/doc/user/content/installation/install-on-aws/_index.md index 3336a1b185d0f..9cc564468d669 100644 --- a/doc/user/content/installation/install-on-aws/_index.md +++ b/doc/user/content/installation/install-on-aws/_index.md @@ -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 @@ -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 + 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 %}} diff --git a/doc/user/content/installation/install-on-azure/_index.md b/doc/user/content/installation/install-on-azure/_index.md index 2f7e2d65c55c8..aed527539e2db 100644 --- a/doc/user/content/installation/install-on-azure/_index.md +++ b/doc/user/content/installation/install-on-azure/_index.md @@ -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) @@ -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 %}} diff --git a/doc/user/content/installation/install-on-gcp/_index.md b/doc/user/content/installation/install-on-gcp/_index.md index f77c21cda8f39..88d1daed13ef5 100644 --- a/doc/user/content/installation/install-on-gcp/_index.md +++ b/doc/user/content/installation/install-on-gcp/_index.md @@ -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 %}} diff --git a/doc/user/data/self_managed/aws_terraform_versions.yml b/doc/user/data/self_managed/aws_terraform_versions.yml index 0626e0dcab896..38c40342f3823 100644 --- a/doc/user/data/self_managed/aws_terraform_versions.yml +++ b/doc/user/data/self_managed/aws_terraform_versions.yml @@ -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": | diff --git a/doc/user/data/self_managed/azure_terraform_versions.yml b/doc/user/data/self_managed/azure_terraform_versions.yml index 9ec44ee3726c3..62bbf89308a86 100644 --- a/doc/user/data/self_managed/azure_terraform_versions.yml +++ b/doc/user/data/self_managed/azure_terraform_versions.yml @@ -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": | diff --git a/doc/user/data/self_managed/gcp_terraform_versions.yml b/doc/user/data/self_managed/gcp_terraform_versions.yml index ac017b238ba0a..73822cd09c519 100644 --- a/doc/user/data/self_managed/gcp_terraform_versions.yml +++ b/doc/user/data/self_managed/gcp_terraform_versions.yml @@ -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) diff --git a/doc/user/data/self_managed/self_managed_operator_compatibility.yml b/doc/user/data/self_managed/self_managed_operator_compatibility.yml index cf1bd8c019225..87c23f6c0eff5 100644 --- a/doc/user/data/self_managed/self_managed_operator_compatibility.yml +++ b/doc/user/data/self_managed/self_managed_operator_compatibility.yml @@ -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" diff --git a/doc/user/data/self_managed/terraform_helm_compatibility.yml b/doc/user/data/self_managed/terraform_helm_compatibility.yml index 4ef0263e484ee..b1ac9fae8a1c6 100644 --- a/doc/user/data/self_managed/terraform_helm_compatibility.yml +++ b/doc/user/data/self_managed/terraform_helm_compatibility.yml @@ -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": | diff --git a/doc/user/shared-content/materialized_extra_args.md b/doc/user/shared-content/materialized_extra_args.md new file mode 100644 index 0000000000000..151c955c8ed51 --- /dev/null +++ b/doc/user/shared-content/materialized_extra_args.md @@ -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==", + "--cors-allowed-origin=", + "--bootstrap-builtin-catalog-server-cluster-replica-size=50cc", ... + ] + } +] +```