docs: clarify terraform provider configuration modes #33842
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 tasks
kay-kim
reviewed
Oct 14, 2025
| {{</ tab >}} | ||
|
|
||
| **Minimum requirements:** `terraform-provider-materialize` v0.8.1+ | ||
| {{< tab "Self-hosted" >}} |
Comment on lines
+78
to
+88
| **Important limitations for self-hosted mode:** | ||
|
|
||
| # Create an app password for the service user. | ||
| resource "materialize_app_password" "production_dashboard" { | ||
| name = "production_dashboard_app_password" | ||
| type = "service" | ||
| user = materialize_role.production_dashboard.name | ||
| roles = ["Member"] | ||
| } | ||
| Self-hosted configurations do **not** support Frontegg-dependent resources: | ||
| - `materialize_app_password` | ||
| - `materialize_user` | ||
| - `materialize_sso_config` and related SSO resources | ||
| - `materialize_scim_config` and related SCIM resources | ||
|
|
||
| # Allow the service user to use the "production_analytics" database. | ||
| resource "materialize_database_grant" "database_usage" { | ||
| role_name = materialize_role.production_dashboard.name | ||
| privilege = "USAGE" | ||
| database_name = "production_analytics" | ||
| region = "aws/us-east-1" | ||
| } | ||
| Only database resources are available (clusters, sources, sinks, schemas, etc.). | ||
| These organization and identity management resources require Materialize Cloud's | ||
| identity provider and will produce error messages if used in self-hosted mode. |
There was a problem hiding this comment.
Not quite sure this is characterized as a limitation. And we don't mention Frontegg anywhere, which is more of our implementation detail on the cloud side anyways. So, probably combine the lines 86-88 up here, kind of like:
The following resources apply only to Materialize Cloud and are not supported in self-managed configurations:
or
The following resources apply only to Materialize Cloud's identity provider and are not supported in self-managed configurations:
| {{< warning >}} | ||
| **Migration warning:** | ||
|
|
||
| Switching between SaaS and self-hosted modes requires careful state file |
There was a problem hiding this comment.
SaaS -> Cloud?
self-hosted -> self-managed
|
|
||
| Switching between SaaS and self-hosted modes requires careful state file | ||
| management as resource references and regional configurations differ between | ||
| modes. We strongly recommend using a consistent configuration mode from the |
There was a problem hiding this comment.
What does "using a consistent configuration mode" mean?
Does that mean don't migrate?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Adding details for the two different auth modes available in our terraform provider to prevent confusion in users.
Tips for reviewer
Checklist
$T ⇔ Proto$Tmapping (possibly in a backwards-incompatible way), then it is tagged with aT-protolabel.