Remove outdated feature lifecycle annotations (#679)

* Remove outdated feature lifecycle annotations * Fix failing tests --------- Co-authored-by: Bobby Iliev <[email protected]>
MaterializeInc · Dec 17, 2024 · ec3e04c · ec3e04c
1 parent e0ad9ba
commit ec3e04c
Show file tree

Hide file tree

Showing 29 changed files with 48 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+* Remove outdated feature lifecycle annotations for features that are now Generally Available (GA).
+
 ## 0.8.11 - 2024-11-13
 
 ## Features

diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md
@@ -28,7 +28,7 @@ resource "materialize_cluster" "example_cluster" {
 ### Optional
 
 - `availability_zones` (List of String) The specific availability zones of the cluster.
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `disk` (Boolean, Deprecated) **Deprecated**. This attribute is maintained for backward compatibility with existing configurations. New users should use 'cc' sizes for disk access.
 - `identify_by_name` (Boolean) Use the cluster name as the resource identifier in your state file, rather than the internal cluster ID. This is particularly useful in scenarios like dbt-materialize blue/green deployments, where clusters are swapped but the ID changes. By identifying by name, the resource can be managed consistently even when the underlying cluster ID is updated.
 - `introspection_debugging` (Boolean) Whether to introspect the gathering of the introspection data.

diff --git a/docs/resources/cluster_replica.md b/docs/resources/cluster_replica.md
@@ -33,7 +33,7 @@ resource "materialize_cluster_replica" "example_cluster_replica" {
 ### Optional
 
 - `availability_zone` (String) The specific availability zone of the replica.
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `disk` (Boolean, Deprecated) **Deprecated**. This attribute is maintained for backward compatibility with existing configurations. New users should use 'cc' sizes for disk access.
 - `introspection_debugging` (Boolean) Whether to introspect the gathering of the introspection data.
 - `introspection_interval` (String) The interval at which to collect introspection data.

diff --git a/docs/resources/connection_aws.md b/docs/resources/connection_aws.md
@@ -40,15 +40,15 @@ resource "materialize_connection_aws" "example_connection" {
 - `assume_role_arn` (String) The Amazon Resource Name (ARN) of the IAM role to assume.
 - `assume_role_session_name` (String) The session name to use when assuming the role.
 - `aws_region` (String) The AWS region to connect to.
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the connection database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `endpoint` (String) Override the default AWS endpoint URL.
 - `ownership_role` (String) The owernship role of the object.
 - `region` (String) The region to use for the resource connection. If not set, the default region is used.
 - `schema_name` (String) The identifier for the connection schema in Materialize. Defaults to `public`.
 - `secret_access_key` (Block List, Max: 1) The secret access key corresponding to the specified access key ID. (see [below for nested schema](#nestedblock--secret_access_key))
 - `session_token` (Block List, Max: 1) The session token corresponding to the specified access key ID.. Can be supplied as either free text using `text` or reference to a secret object using `secret`. (see [below for nested schema](#nestedblock--session_token))
-- `validate` (Boolean) **Private Preview** If the connection should wait for validation.
+- `validate` (Boolean) If the connection should wait for validation.
 
 ### Read-Only
 

diff --git a/docs/resources/connection_aws_privatelink.md b/docs/resources/connection_aws_privatelink.md
@@ -40,12 +40,12 @@ resource "materialize_connection_aws_privatelink" "example_privatelink_connectio
 
 ### Optional
 
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the connection database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `ownership_role` (String) The owernship role of the object.
 - `region` (String) The region to use for the resource connection. If not set, the default region is used.
 - `schema_name` (String) The identifier for the connection schema in Materialize. Defaults to `public`.
-- `validate` (Boolean) **Private Preview** If the connection should wait for validation.
+- `validate` (Boolean) If the connection should wait for validation.
 
 ### Read-Only
 

diff --git a/docs/resources/connection_confluent_schema_registry.md b/docs/resources/connection_confluent_schema_registry.md
@@ -45,7 +45,7 @@ resource "materialize_connection_confluent_schema_registry" "example_confluent_s
 ### Optional
 
 - `aws_privatelink` (Block List, Max: 1) The AWS PrivateLink configuration for the Confluent Schema Registry. (see [below for nested schema](#nestedblock--aws_privatelink))
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the connection database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `ownership_role` (String) The owernship role of the object.
 - `password` (Block List, Max: 1) The password for the Confluent Schema Registry. (see [below for nested schema](#nestedblock--password))
@@ -56,7 +56,7 @@ resource "materialize_connection_confluent_schema_registry" "example_confluent_s
 - `ssl_certificate_authority` (Block List, Max: 1) The CA certificate for the Confluent Schema Registry.. Can be supplied as either free text using `text` or reference to a secret object using `secret`. (see [below for nested schema](#nestedblock--ssl_certificate_authority))
 - `ssl_key` (Block List, Max: 1) The client key for the Confluent Schema Registry. (see [below for nested schema](#nestedblock--ssl_key))
 - `username` (Block List, Max: 1) The username for the Confluent Schema Registry.. Can be supplied as either free text using `text` or reference to a secret object using `secret`. (see [below for nested schema](#nestedblock--username))
-- `validate` (Boolean) **Private Preview** If the connection should wait for validation.
+- `validate` (Boolean) If the connection should wait for validation.
 
 ### Read-Only
 

diff --git a/docs/resources/connection_kafka.md b/docs/resources/connection_kafka.md
@@ -82,7 +82,7 @@ resource "materialize_connection_kafka" "example_kafka_connection_multiple_broke
 
 - `aws_connection` (Block List, Max: 1) The AWS connection to use for IAM authentication. (see [below for nested schema](#nestedblock--aws_connection))
 - `aws_privatelink` (Block List, Max: 1) AWS PrivateLink configuration. Conflicts with `kafka_broker`. (see [below for nested schema](#nestedblock--aws_privatelink))
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the connection database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `kafka_broker` (Block List) The Kafka broker's configuration. (see [below for nested schema](#nestedblock--kafka_broker))
 - `ownership_role` (String) The owernship role of the object.
@@ -98,7 +98,7 @@ resource "materialize_connection_kafka" "example_kafka_connection_multiple_broke
 - `ssl_certificate` (Block List, Max: 1) The client certificate for the Kafka broker.. Can be supplied as either free text using `text` or reference to a secret object using `secret`. (see [below for nested schema](#nestedblock--ssl_certificate))
 - `ssl_certificate_authority` (Block List, Max: 1) The CA certificate for the Kafka broker.. Can be supplied as either free text using `text` or reference to a secret object using `secret`. (see [below for nested schema](#nestedblock--ssl_certificate_authority))
 - `ssl_key` (Block List, Max: 1) The client key for the Kafka broker. (see [below for nested schema](#nestedblock--ssl_key))
-- `validate` (Boolean) **Private Preview** If the connection should wait for validation.
+- `validate` (Boolean) If the connection should wait for validation.
 
 ### Read-Only
 

diff --git a/docs/resources/connection_mysql.md b/docs/resources/connection_mysql.md
@@ -80,7 +80,7 @@ resource "materialize_connection_mysql" "example_mysql_connection" {
 ### Optional
 
 - `aws_privatelink` (Block List, Max: 1) The AWS PrivateLink configuration for the MySQL database. (see [below for nested schema](#nestedblock--aws_privatelink))
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the connection database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `ownership_role` (String) The owernship role of the object.
 - `password` (Block List, Max: 1) The MySQL database password. (see [below for nested schema](#nestedblock--password))
@@ -92,7 +92,7 @@ resource "materialize_connection_mysql" "example_mysql_connection" {
 - `ssl_certificate_authority` (Block List, Max: 1) The CA certificate for the MySQL database.. Can be supplied as either free text using `text` or reference to a secret object using `secret`. (see [below for nested schema](#nestedblock--ssl_certificate_authority))
 - `ssl_key` (Block List, Max: 1) The client key for the MySQL database. (see [below for nested schema](#nestedblock--ssl_key))
 - `ssl_mode` (String) The SSL mode for the MySQL database. Allowed values are disabled, required, verify-ca, verify-identity.
-- `validate` (Boolean) **Private Preview** If the connection should wait for validation.
+- `validate` (Boolean) If the connection should wait for validation.
 
 ### Read-Only
 

diff --git a/docs/resources/connection_postgres.md b/docs/resources/connection_postgres.md
@@ -85,7 +85,7 @@ resource "materialize_connection_postgres" "example_postgres_connection" {
 ### Optional
 
 - `aws_privatelink` (Block List, Max: 1) The AWS PrivateLink configuration for the Postgres database. (see [below for nested schema](#nestedblock--aws_privatelink))
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the connection database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `ownership_role` (String) The owernship role of the object.
 - `password` (Block List, Max: 1) The Postgres database password. (see [below for nested schema](#nestedblock--password))
@@ -97,7 +97,7 @@ resource "materialize_connection_postgres" "example_postgres_connection" {
 - `ssl_certificate_authority` (Block List, Max: 1) The CA certificate for the Postgres database.. Can be supplied as either free text using `text` or reference to a secret object using `secret`. (see [below for nested schema](#nestedblock--ssl_certificate_authority))
 - `ssl_key` (Block List, Max: 1) The client key for the Postgres database. (see [below for nested schema](#nestedblock--ssl_key))
 - `ssl_mode` (String) The SSL mode for the Postgres database.
-- `validate` (Boolean) **Private Preview** If the connection should wait for validation.
+- `validate` (Boolean) If the connection should wait for validation.
 
 ### Read-Only
 

diff --git a/docs/resources/connection_ssh_tunnel.md b/docs/resources/connection_ssh_tunnel.md
@@ -41,12 +41,12 @@ resource "materialize_connection_ssh_tunnel" "example_ssh_connection" {
 
 ### Optional
 
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the connection database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `ownership_role` (String) The owernship role of the object.
 - `region` (String) The region to use for the resource connection. If not set, the default region is used.
 - `schema_name` (String) The identifier for the connection schema in Materialize. Defaults to `public`.
-- `validate` (Boolean) **Private Preview** If the connection should wait for validation.
+- `validate` (Boolean) If the connection should wait for validation.
 
 ### Read-Only
 

diff --git a/docs/resources/database.md b/docs/resources/database.md
@@ -48,7 +48,7 @@ resource "materialize_schema_grant" "schema_grant_usage" {
 
 ### Optional
 
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `ownership_role` (String) The owernship role of the object.
 - `region` (String) The region to use for the resource connection. If not set, the default region is used.
 

diff --git a/docs/resources/index.md b/docs/resources/index.md
@@ -42,7 +42,7 @@ resource "materialize_index" "loadgen_index" {
 
 ### Optional
 
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `default` (Boolean) Creates a default index using all inferred columns are used.
 - `method` (String) The name of the index method to use.
 - `name` (String) The identifier for the index.

diff --git a/docs/resources/materialized_view.md b/docs/resources/materialized_view.md
@@ -48,9 +48,9 @@ resource "materialize_materialized_view" "simple_materialized_view" {
 
 ### Optional
 
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the materialized view database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
-- `not_null_assertion` (List of String) **Private Preview** A list of columns for which to create non-null assertions.
+- `not_null_assertion` (List of String) A list of columns for which to create non-null assertions.
 - `ownership_role` (String) The owernship role of the object.
 - `region` (String) The region to use for the resource connection. If not set, the default region is used.
 - `schema_name` (String) The identifier for the materialized view schema in Materialize. Defaults to `public`.

diff --git a/docs/resources/network_policy.md b/docs/resources/network_policy.md
@@ -53,7 +53,7 @@ resource "materialize_system_parameter" "system_parameter" {
 
 ### Optional
 
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `region` (String) The region to use for the resource connection. If not set, the default region is used.
 
 ### Read-Only

diff --git a/docs/resources/role.md b/docs/resources/role.md
@@ -27,7 +27,7 @@ resource "materialize_role" "example_role" {
 
 ### Optional
 
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `region` (String) The region to use for the resource connection. If not set, the default region is used.
 
 ### Read-Only

diff --git a/docs/resources/schema.md b/docs/resources/schema.md
@@ -28,7 +28,7 @@ resource "materialize_schema" "example_schema" {
 
 ### Optional
 
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the schema database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `ownership_role` (String) The owernship role of the object.
 - `region` (String) The region to use for the resource connection. If not set, the default region is used.

diff --git a/docs/resources/secret.md b/docs/resources/secret.md
@@ -29,7 +29,7 @@ resource "materialize_secret" "example_secret" {
 
 ### Optional
 
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the secret database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `ownership_role` (String) The owernship role of the object.
 - `region` (String) The region to use for the resource connection. If not set, the default region is used.

diff --git a/docs/resources/sink_kafka.md b/docs/resources/sink_kafka.md
@@ -65,7 +65,7 @@ resource "materialize_sink_kafka" "example_sink_kafka" {
 ### Optional
 
 - `cluster_name` (String) The cluster to maintain this sink.
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `compression_type` (String) The type of compression to apply to messages before they are sent to Kafka.
 - `database_name` (String) The identifier for the sink database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `envelope` (Block List, Max: 1) How to interpret records (e.g. Debezium, Upsert). (see [below for nested schema](#nestedblock--envelope))
@@ -140,8 +140,8 @@ Required:
 
 Optional:
 
-- `avro_doc_column` (Block List) **Private Preview** Add column level documentation comment to the generated Avro schemas. (see [below for nested schema](#nestedblock--format--avro--avro_doc_column))
-- `avro_doc_type` (Block List, Max: 1) **Private Preview** Add top level documentation comment to the generated Avro schemas. (see [below for nested schema](#nestedblock--format--avro--avro_doc_type))
+- `avro_doc_column` (Block List) Add column level documentation comment to the generated Avro schemas. (see [below for nested schema](#nestedblock--format--avro--avro_doc_column))
+- `avro_doc_type` (Block List, Max: 1) Add top level documentation comment to the generated Avro schemas. (see [below for nested schema](#nestedblock--format--avro--avro_doc_type))
 - `avro_key_fullname` (String) The full name of the Avro key schema.
 - `avro_value_fullname` (String) The full name of the Avro value schema.
 - `key_compatibility_level` (String) If specified, set the Compatibility Level for the generated key schema.

diff --git a/docs/resources/source_kafka.md b/docs/resources/source_kafka.md
@@ -54,7 +54,7 @@ resource "materialize_source_kafka" "example_source_kafka" {
 ### Optional
 
 - `cluster_name` (String) The cluster to maintain this source.
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the source database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `envelope` (Block List, Max: 1) How Materialize should interpret records (e.g. append-only, upsert).. (see [below for nested schema](#nestedblock--envelope))
 - `expose_progress` (Block List, Max: 1) The name of the progress collection for the source. If this is not specified, the collection will be named `<src_name>_progress`. (see [below for nested schema](#nestedblock--expose_progress))

diff --git a/docs/resources/source_load_generator.md b/docs/resources/source_load_generator.md
@@ -42,7 +42,7 @@ resource "materialize_source_load_generator" "example_source_load_generator" {
 
 - `auction_options` (Block List, Max: 1) Auction Options. (see [below for nested schema](#nestedblock--auction_options))
 - `cluster_name` (String) The cluster to maintain this source.
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `counter_options` (Block List, Max: 1) Counter Options. (see [below for nested schema](#nestedblock--counter_options))
 - `database_name` (String) The identifier for the source database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `expose_progress` (Block List, Max: 1) The name of the progress collection for the source. If this is not specified, the collection will be named `<src_name>_progress`. (see [below for nested schema](#nestedblock--expose_progress))

diff --git a/docs/resources/source_mysql.md b/docs/resources/source_mysql.md
@@ -53,7 +53,7 @@ resource "materialize_source_mysql" "test" {
 ### Optional
 
 - `cluster_name` (String) The cluster to maintain this source.
-- `comment` (String) **Public Preview** Comment on an object in the database.
+- `comment` (String) Comment on an object in the database.
 - `database_name` (String) The identifier for the source database in Materialize. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
 - `expose_progress` (Block List, Max: 1) The name of the progress collection for the source. If this is not specified, the collection will be named `<src_name>_progress`. (see [below for nested schema](#nestedblock--expose_progress))
 - `ignore_columns` (List of String) Ignore specific columns when reading data from MySQL. Can only be updated in place when also updating a corresponding `table` attribute.