Skip to content

Add forward compatibility disclaimer to README #50

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

Merged
bobbyiliev merged 1 commit into from
Mar 24, 2025
Merged

Add forward compatibility disclaimer to README #50

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
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,20 @@

Terraform module for deploying Materialize on AWS Cloud Platform with all required infrastructure components.

> **Warning** This is provided on a best-effort basis and Materialize cannot offer support for this module.

The module has been tested with:

- PostgreSQL 15
- Materialize Helm Operator Terraform Module v0.1.8

> [!WARNING]
> This module is provided on a best-effort basis and Materialize cannot offer support for it.
Copy link
Copy Markdown

@pH14 pH14 Mar 24, 2025

Choose a reason for hiding this comment

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

I might nix this, I think we would support people trying to use it to a degree, like if the TF provider clearly had bugs

>
> It is not guaranteed to be forward-compatible and may include breaking changes in future versions.
>
> The module is intended for demonstration and evaluation purposes only, not for production use.
Copy link
Copy Markdown

@pH14 pH14 Mar 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I'd start with this disclaimer, and then segue into the above. I think we're also saying it has two different purposes here (evaluation only) and later (use as starting point for prod infra), and as a reader I'm not quite sure what the actual intent is

maybe something like this?

"This module is intended to be used for demonstrations, simple evaluations, and as a template for building your own production deployment of Materialize on AWS.

This module should not be relied upon for production deployments directly: future releases of those module will contain breaking changes. When used as a starting point for a production deployment, you must either fork this repo and pin to a specific version, or use the code as a reference when developing your own deployment."

Copy link
Copy Markdown

@pH14 pH14 Mar 24, 2025

Choose a reason for hiding this comment

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

cc @kay-kim same feedback for the disclaimer we have in the docs as well. I'm finding our current messaging reads a little confused. Seth had a nice clear take in https://materializeinc.slack.com/archives/C085QFLB072/p1740503361409879?thread_ts=1740502884.282719&cid=C085QFLB072 that I think is a good reference

Copy link
Copy Markdown
Collaborator Author

@bobbyiliev bobbyiliev Mar 24, 2025

Choose a reason for hiding this comment

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

Sounds good! I prepared PRs to update the wording:

MaterializeInc/terraform-google-materialize#31
MaterializeInc/terraform-azurerm-materialize#23
#51

>
> Instead, consider forking this repository as a starting point for building your own production infrastructure.

## Providers Configuration

The module requires the following providers to be configured:
Expand Down
12 changes: 10 additions & 2 deletions docs/header.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,20 @@

Terraform module for deploying Materialize on AWS Cloud Platform with all required infrastructure components.

> **Warning** This is provided on a best-effort basis and Materialize cannot offer support for this module.

The module has been tested with:

- PostgreSQL 15
- Materialize Helm Operator Terraform Module v0.1.8

> [!WARNING]
> This module is provided on a best-effort basis and Materialize cannot offer support for it.
>
> It is not guaranteed to be forward-compatible and may include breaking changes in future versions.
>
> The module is intended for demonstration and evaluation purposes only, not for production use.
>
> Instead, consider forking this repository as a starting point for building your own production infrastructure.

## Providers Configuration

The module requires the following providers to be configured:
Expand Down