diff --git a/doc/user/content/installation/_index.md b/doc/user/content/installation/_index.md index 38f0575488cb3..19cea9320de0d 100644 --- a/doc/user/content/installation/_index.md +++ b/doc/user/content/installation/_index.md @@ -15,3 +15,4 @@ menu: - [Materialize Operator Configuration](/installation/configuration/) - [Troubleshooting](/installation/troubleshooting/) +- [FAQ](/installation/faq/) diff --git a/doc/user/content/installation/faq.md b/doc/user/content/installation/faq.md new file mode 100644 index 0000000000000..f3bd84a580665 --- /dev/null +++ b/doc/user/content/installation/faq.md @@ -0,0 +1,34 @@ +--- +title: "FAQ: Self-managed installation" +description: "Frequently asked questions about self-managed installations." +aliases: + - /self-hosted/faq/ +menu: + main: + parent: "installation" + weight: 92 +--- + +## How long do license keys last? + +Community edition license keys are valid for one year. Enterprise license +keys will vary based on the terms of your contract. + +## How do I get a community license key? + +To request a license key for Materialize Community Edition, visit https://materialize.com/get-started/. + +## How do I get an enterprise license key? + +To purchase a Materialize Self-Managed Enterprise License, contact us +[here](https://materialize.com/self-managed). + +## How do I add a license key to an existing installation? + +The license key should be configured in the Kubernetes Secret resource +created during the installation process. To configure a license key in an +existing installation, run: + +```bash +kubectl -n materialize-environment patch secret materialize-backend -p '{"stringData":{"license_key":""}}' --type=merge +``` diff --git a/doc/user/content/installation/install-on-aws/_index.md b/doc/user/content/installation/install-on-aws/_index.md index bfa8d23083dd1..b6c45539ff482 100644 --- a/doc/user/content/installation/install-on-aws/_index.md +++ b/doc/user/content/installation/install-on-aws/_index.md @@ -59,6 +59,8 @@ for details. If you do not have Helm 3.2.0+, install. For details, see the [Helm documentation](https://helm.sh/docs/intro/install/). +{{< include-md file="shared-content/license-key-required.md" >}} + ## Set up AWS Kubernetes environment and install Materialize {{< warning >}} @@ -278,6 +280,7 @@ components: cpu_request = "1" memory_request = "2Gi" memory_limit = "2Gi" + license_key = "" } ] EOF diff --git a/doc/user/content/installation/install-on-aws/upgrade-on-aws.md b/doc/user/content/installation/install-on-aws/upgrade-on-aws.md index ba5306c165e78..8a9cd0f4d77a3 100644 --- a/doc/user/content/installation/install-on-aws/upgrade-on-aws.md +++ b/doc/user/content/installation/install-on-aws/upgrade-on-aws.md @@ -73,6 +73,8 @@ for details. If you do not have Helm 3.2.0+, install. For details, see the [Helm documentation](https://helm.sh/docs/intro/install/). +{{< include-md file="shared-content/license-key-required.md" >}} + ## Procedure 1. Open a Terminal window. diff --git a/doc/user/content/installation/install-on-azure/_index.md b/doc/user/content/installation/install-on-azure/_index.md index e85df19d60ded..d5ddb4d070111 100644 --- a/doc/user/content/installation/install-on-azure/_index.md +++ b/doc/user/content/installation/install-on-azure/_index.md @@ -65,6 +65,8 @@ the [Helm documentation](https://helm.sh/docs/intro/install/). Terraform outputs. Alternatively, you can manually specify the name and region. If you want to use `jq` and do not have `jq` installed, install. +{{< include-md file="shared-content/license-key-required.md" >}} + ## A. Authenticate with Azure 1. Open a Terminal window. @@ -331,6 +333,7 @@ deploys a sample infrastructure on Azure with the following components: cpu_request = "1" memory_request = "2Gi" memory_limit = "2Gi" + license_key = "" } ] EOF diff --git a/doc/user/content/installation/install-on-azure/upgrade-on-azure.md b/doc/user/content/installation/install-on-azure/upgrade-on-azure.md index 4e1c99d5614dc..59d591c5e9f41 100644 --- a/doc/user/content/installation/install-on-azure/upgrade-on-azure.md +++ b/doc/user/content/installation/install-on-azure/upgrade-on-azure.md @@ -84,6 +84,8 @@ the [Helm documentation](https://helm.sh/docs/intro/install/). Terraform outputs. Alternatively, you can manually specify the name and region. If you want to use `jq` and do not have `jq` installed, install. +{{< include-md file="shared-content/license-key-required.md" >}} + ## A. Authenticate with Azure 1. Open a Terminal window. diff --git a/doc/user/content/installation/install-on-gcp/_index.md b/doc/user/content/installation/install-on-gcp/_index.md index 90e4dd75c1736..e64a3a2a32339 100644 --- a/doc/user/content/installation/install-on-gcp/_index.md +++ b/doc/user/content/installation/install-on-gcp/_index.md @@ -91,6 +91,8 @@ If you do not have Helm version 3.2.0+ installed, install. For details, see the Terraform outputs. Alternatively, you can manually specify the name and region. If you want to use `jq` and do not have `jq` installed, install. +{{< include-md file="shared-content/license-key-required.md" >}} + ## A. Configure GCP project and service account 1. Open a Terminal window. @@ -400,6 +402,7 @@ components: cpu_request = "1" memory_request = "2Gi" memory_limit = "2Gi" + license_key = "" } ] EOF diff --git a/doc/user/content/installation/install-on-gcp/upgrade-on-gcp.md b/doc/user/content/installation/install-on-gcp/upgrade-on-gcp.md index f4054f40f925f..3151f966f5ad2 100644 --- a/doc/user/content/installation/install-on-gcp/upgrade-on-gcp.md +++ b/doc/user/content/installation/install-on-gcp/upgrade-on-gcp.md @@ -102,6 +102,8 @@ If you do not have Helm version 3.2.0+ installed, install. For details, see the Terraform outputs. Alternatively, you can manually specify the name and region. If you want to use `jq` and do not have `jq` installed, install. +{{< include-md file="shared-content/license-key-required.md" >}} + ## Procedure ### A. Setup GCP service account and authenticate diff --git a/doc/user/content/installation/install-on-local-kind/_index.md b/doc/user/content/installation/install-on-local-kind/_index.md index 273c14259e944..56e453bc5a3f9 100644 --- a/doc/user/content/installation/install-on-local-kind/_index.md +++ b/doc/user/content/installation/install-on-local-kind/_index.md @@ -59,6 +59,8 @@ documentationq](https://kubernetes.io/docs/tasks/tools/). For help with `kubectl` commands, see [kubectl Quick reference](https://kubernetes.io/docs/reference/kubectl/quick-reference/). +{{< include-md file="shared-content/license-key-required.md" >}} + ## Installation 1. Start Docker if it is not already running. @@ -104,6 +106,8 @@ reference](https://kubernetes.io/docs/reference/kubectl/quick-reference/). {{% self-managed/versions/curl-sample-files-local-install %}} +1. Edit `sample-materialize.yaml` to add your license key to the `license_key` field in the backend secret. + 1. Install the Materialize Helm chart. 1. Add the Materialize Helm chart repository. diff --git a/doc/user/content/installation/install-on-local-kind/upgrade-on-local-kind.md b/doc/user/content/installation/install-on-local-kind/upgrade-on-local-kind.md index 6e3037f016ac6..3370502c04df2 100644 --- a/doc/user/content/installation/install-on-local-kind/upgrade-on-local-kind.md +++ b/doc/user/content/installation/install-on-local-kind/upgrade-on-local-kind.md @@ -38,6 +38,8 @@ documentationq](https://kubernetes.io/docs/tasks/tools/). For help with `kubectl` commands, see [kubectl Quick reference](https://kubernetes.io/docs/reference/kubectl/quick-reference/). +{{< include-md file="shared-content/license-key-required.md" >}} + ## Upgrade {{< important >}} diff --git a/doc/user/content/installation/install-on-local-minikube/_index.md b/doc/user/content/installation/install-on-local-minikube/_index.md index 1193f0681e1d2..b2e49eaf7abe4 100644 --- a/doc/user/content/installation/install-on-local-minikube/_index.md +++ b/doc/user/content/installation/install-on-local-minikube/_index.md @@ -63,6 +63,8 @@ This tutorial uses `kubectl`. To install, refer to the [`kubectl` documentationq For help with `kubectl` commands, see [kubectl Quick reference](https://kubernetes.io/docs/reference/kubectl/quick-reference/). +{{< include-md file="shared-content/license-key-required.md" >}} + ## Installation 1. Start Docker if it is not already running. @@ -107,6 +109,8 @@ reference](https://kubernetes.io/docs/reference/kubectl/quick-reference/). {{% self-managed/versions/curl-sample-files-local-install %}} +1. Edit `sample-materialize.yaml` to add your license key to the `license_key` field in the backend secret. + 1. Install the Materialize Helm chart. 1. Add the Materialize Helm chart repository. diff --git a/doc/user/content/installation/install-on-local-minikube/upgrade-on-local-minikube.md b/doc/user/content/installation/install-on-local-minikube/upgrade-on-local-minikube.md index fc5c49179b356..f91f8298d9223 100644 --- a/doc/user/content/installation/install-on-local-minikube/upgrade-on-local-minikube.md +++ b/doc/user/content/installation/install-on-local-minikube/upgrade-on-local-minikube.md @@ -36,6 +36,8 @@ This tutorial uses `kubectl`. To install, refer to the [`kubectl` documentationq For help with `kubectl` commands, see [kubectl Quick reference](https://kubernetes.io/docs/reference/kubectl/quick-reference/). +{{< include-md file="shared-content/license-key-required.md" >}} + ## Upgrade diff --git a/doc/user/content/license.md b/doc/user/content/license.md index 506fefe05b0d1..3d88f8c12853d 100644 --- a/doc/user/content/license.md +++ b/doc/user/content/license.md @@ -20,13 +20,16 @@ Use of the Materialize Self-Managed Community edition is subject to the License](https://github.com/MaterializeInc/materialize/blob/main/LICENSE) agreement. -To purchase a Materialize Self-Managed Enterprise License, contact us +A license key is required to use Self-Managed Materialize. + +- To request a license key for Materialize Community Edition, visit https://materialize.com/get-started/. +- To purchase a Materialize Self-Managed Enterprise License, contact us [here](https://materialize.com/self-managed). ### Self-Managed Community Edition Privacy Policy By downloading Materialize Self-Managed Community Edition, you are agreeing to -Materialize' [privacy policy](https://materialize.com/privacy-policy/). +Materialize's [privacy policy](https://materialize.com/privacy-policy/). ### Materialize Self-Managed Community Edition and Emulator Privacy FAQ diff --git a/doc/user/content/releases/_index.md b/doc/user/content/releases/_index.md index 44489b40bda40..021523a68da8a 100644 --- a/doc/user/content/releases/_index.md +++ b/doc/user/content/releases/_index.md @@ -9,6 +9,22 @@ menu: --- +## Releases + +### v26.0 + +A license key is required to use Materialize v26.0 in a self-managed +Kubernetes cluster. To request a license key for Materialize Community +Edition, visit https://materialize.com/get-started/. + +The license key should be configured in the Kubernetes Secret resource +created during the installation process. To configure a license key in an +existing installation, run: + +```bash +kubectl -n materialize-environment patch secret materialize-backend -p '{"stringData":{"license_key":""}}' --type=merge +``` + ## Materialize Cloud Upgrade Schedule Materialize Cloud upgrades all regions to the latest release each week according diff --git a/doc/user/layouts/shortcodes/self-managed/materialize-components-list.html b/doc/user/layouts/shortcodes/self-managed/materialize-components-list.html index efbbde2885346..fb8921d7497aa 100644 --- a/doc/user/layouts/shortcodes/self-managed/materialize-components-list.html +++ b/doc/user/layouts/shortcodes/self-managed/materialize-components-list.html @@ -1,3 +1,4 @@ - A Kubernetes (v1.31+) cluster. - PostgreSQL as a metadata database. - Blob storage. +- A license key. To request a license key for Materialize Community Edition, visit https://materialize.com/get-started/. diff --git a/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-cloud.html b/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-cloud.html index 040fa7dcc4119..aa498d7f46737 100644 --- a/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-cloud.html +++ b/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-cloud.html @@ -82,6 +82,7 @@ | `environmentd_version` | New Materialize instance version.| | `request_rollout` or `force_rollout` | A new UUID string. Can be generated with `uuidgen`.
| | `inPlaceRollout` | Set to `false` to perform a rolling upgrade. For rolling upgrades, ensure you have enough resources to support having both the old and new Materialize instances running during the upgrade. | + | `license_key` | Set to the value of your license key. | For example, the following instance specifies: @@ -100,6 +101,7 @@ memory_request = "2Gi" memory_limit = "2Gi" create_database = false + license_key = "[...]" environmentd_version = "{{ $environmentd_version }}" inPlaceRollout: false # When false, performs a rolling upgrade rather than in-place requestRollout: 22222222-2222-2222-2222-222222222222 # Enter a new UUID diff --git a/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-local-kind.html b/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-local-kind.html index 83fc7df9191fb..f0dbb5660209c 100644 --- a/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-local-kind.html +++ b/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-local-kind.html @@ -50,6 +50,13 @@ kubectl -n materialize describe pod -l app.kubernetes.io/name=materialize-operator ``` +1. As of Materialize version 26.0, a license key is required to run in + Kubernetes. To configure a license key in an existing installation, run: + + ```bash + kubectl -n materialize-environment patch secret materialize-backend -p '{"stringData":{"license_key":""}}' --type=merge + ``` + 1. Create a new `upgrade-materialize.yaml` file with the following content: | Field | Description | diff --git a/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-local-minikube.html b/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-local-minikube.html index 72eb8f68e300d..2abd9144d3d42 100644 --- a/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-local-minikube.html +++ b/doc/user/layouts/shortcodes/self-managed/versions/upgrade/upgrade-steps-local-minikube.html @@ -51,6 +51,13 @@ kubectl -n materialize describe pod -l app.kubernetes.io/name=materialize-operator ``` +1. As of Materialize version 26.0, a license key is required to run in + Kubernetes. To configure a license key in an existing installation, run: + + ```bash + kubectl -n materialize-environment patch secret materialize-backend -p '{"stringData":{"license_key":""}}' --type=merge + ``` + 1. Create a new `upgrade-materialize.yaml` file with the following content: | Field | Description | diff --git a/doc/user/shared-content/license-key-required.md b/doc/user/shared-content/license-key-required.md new file mode 100644 index 0000000000000..9e3d16ee16559 --- /dev/null +++ b/doc/user/shared-content/license-key-required.md @@ -0,0 +1,3 @@ +### License key + +To run Materialize in Kubernetes, a license key is required. To request a license key for Materialize Community Edition, visit https://materialize.com/get-started/. diff --git a/misc/helm-charts/testing/materialize.yaml b/misc/helm-charts/testing/materialize.yaml index f8c96d0fa20d9..dc8ce3868a9fd 100644 --- a/misc/helm-charts/testing/materialize.yaml +++ b/misc/helm-charts/testing/materialize.yaml @@ -21,6 +21,7 @@ metadata: stringData: metadata_backend_url: "postgres://materialize_user:materialize_pass@postgres.materialize.svc.cluster.local:5432/materialize_db?sslmode=disable" persist_backend_url: "s3://minio:minio123@bucket/12345678-1234-1234-1234-123456789012?endpoint=http%3A%2F%2Fminio.materialize.svc.cluster.local%3A9000®ion=minio" + license_key: "" --- apiVersion: materialize.cloud/v1alpha1 kind: Materialize